{"openapi":"3.0.3","info":{"title":"API da Omie","version":"1","description":"As APIs do ERP Omie.\n\n**Formato.** As APIs do ERP (`/api/v1/...`) são um `POST` no endereço do serviço, com corpo `{\"call\": \"<operação>\", \"param\": [{...}]}`: o campo `call` escolhe a operação. As de Autenticação e aplicativos (`/api/portal/...`) são REST, com método e caminho próprios.\n\n**Autenticação.** `Authorization: Bearer <token do aplicativo>`. O token de usuário vem de `/api/portal/users/me/token/`; o do aplicativo, de `/api/portal/apps/{app_hash}/token/`. Detalhes em /docs#autenticacao.\n\n**Barra final obrigatória** no endereço do serviço.\n\nGerado do catálogo."},"servers":[{"url":"https://app.omie.com.br"}],"tags":[{"name":"Autenticação e aplicativos","description":"Antes de chamar as APIs: o token de usuário e o do aplicativo, os aplicativos da pessoa, os usuários, os grupos e os convites."},{"name":"Geral","description":"Cadastros que todos os módulos usam: clientes e fornecedores, produtos, categorias, contas correntes, projetos, vendedores e tabelas auxiliares."},{"name":"Finanças","description":"Contas a pagar e a receber, lançamentos e extrato de conta corrente, boletos, PIX e resumos financeiros."},{"name":"Produtos","description":"Pedidos de venda e de compra, notas fiscais (NF-e, NFC-e, CT-e e cupom), ordens de produção, tabelas de preço e tabelas fiscais."},{"name":"Serviços","description":"Ordens de serviço, contratos, NFS-e e o cadastro de serviços."},{"name":"Estoque","description":"Posição, movimento, ajustes e locais de estoque."},{"name":"CRM","description":"Contas, contatos, oportunidades e tarefas."},{"name":"Painel do Contador","description":"Resumo e XMLs dos documentos fiscais, para o contador."}],"security":[{"tokenDoAplicativo":[]}],"paths":{"/api/v1/contador/configplanocateg/":{"post":{"tags":["Painel do Contador"],"summary":"Configurações de Categorias x Plano Contábeis.","description":"Serviço **ConfigPlanoContabilCategoria**. Operações (campo `call`): ListarConfigPlanoCateg.","operationId":"contador_configplanocateg","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/contador_configplanocateg_ListarConfigPlanoCateg"}],"discriminator":{"propertyName":"call","mapping":{"ListarConfigPlanoCateg":"#/components/schemas/contador_configplanocateg_ListarConfigPlanoCateg"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contador_configplanocateg_ListarConfigPlanoCateg_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/contador/fechamento/":{"post":{"tags":["Painel do Contador"],"summary":"Guias de impostos e bloqueio de período","description":"Serviço **Fechamento**. Operações (campo `call`): GuiaImpArmazenar · GuiaImpListar · PeriodoBloquear · PeriodoDesbloquear.","operationId":"contador_fechamento","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/contador_fechamento_GuiaImpArmazenar"},{"$ref":"#/components/schemas/contador_fechamento_GuiaImpListar"},{"$ref":"#/components/schemas/contador_fechamento_PeriodoBloquear"},{"$ref":"#/components/schemas/contador_fechamento_PeriodoDesbloquear"}],"discriminator":{"propertyName":"call","mapping":{"GuiaImpArmazenar":"#/components/schemas/contador_fechamento_GuiaImpArmazenar","GuiaImpListar":"#/components/schemas/contador_fechamento_GuiaImpListar","PeriodoBloquear":"#/components/schemas/contador_fechamento_PeriodoBloquear","PeriodoDesbloquear":"#/components/schemas/contador_fechamento_PeriodoDesbloquear"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/contador_fechamento_GuiaImpArmazenar_retorno"},{"$ref":"#/components/schemas/contador_fechamento_GuiaImpListar_retorno"},{"$ref":"#/components/schemas/contador_fechamento_PeriodoBloquear_retorno"},{"$ref":"#/components/schemas/contador_fechamento_PeriodoDesbloquear_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/contador/lancamentoscontabeis/":{"post":{"tags":["Painel do Contador"],"summary":"Lançamentos Contábeis","description":"Serviço **LancamentosContabeis**. Operações (campo `call`): Download.","operationId":"contador_lancamentoscontabeis","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/contador_lancamentoscontabeis_Download"}],"discriminator":{"propertyName":"call","mapping":{"Download":"#/components/schemas/contador_lancamentoscontabeis_Download"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contador_lancamentoscontabeis_Download_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/contador/layoutcontabil/":{"post":{"tags":["Painel do Contador"],"summary":"Listagem de Layouts Contábeis.","description":"Serviço **LayoutContabil**. Operações (campo `call`): ListarLayoutContabil.","operationId":"contador_layoutcontabil","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/contador_layoutcontabil_ListarLayoutContabil"}],"discriminator":{"propertyName":"call","mapping":{"ListarLayoutContabil":"#/components/schemas/contador_layoutcontabil_ListarLayoutContabil"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contador_layoutcontabil_ListarLayoutContabil_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/contador/planocontabil/":{"post":{"tags":["Painel do Contador"],"summary":"Plano de Contas Contábeis","description":"Serviço **PlanoContabil**. Operações (campo `call`): UpsertPlanoContas.","operationId":"contador_planocontabil","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/contador_planocontabil_UpsertPlanoContas"}],"discriminator":{"propertyName":"call","mapping":{"UpsertPlanoContas":"#/components/schemas/contador_planocontabil_UpsertPlanoContas"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contador_planocontabil_UpsertPlanoContas_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/contador/planocontas/":{"post":{"tags":["Painel do Contador"],"summary":"Listagem de Plano de Contas.","description":"Serviço **PlanoContas**. Operações (campo `call`): ListarPlanoContas.","operationId":"contador_planocontas","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/contador_planocontas_ListarPlanoContas"}],"discriminator":{"propertyName":"call","mapping":{"ListarPlanoContas":"#/components/schemas/contador_planocontas_ListarPlanoContas"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contador_planocontas_ListarPlanoContas_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/contador/resumo/":{"post":{"tags":["Painel do Contador"],"summary":"Resumo do Painel do contador.","description":"Serviço **ResumoPainelContador**. Operações (campo `call`): ObterResumoContador.","operationId":"contador_resumo","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/contador_resumo_ObterResumoContador"}],"discriminator":{"propertyName":"call","mapping":{"ObterResumoContador":"#/components/schemas/contador_resumo_ObterResumoContador"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contador_resumo_ObterResumoContador_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/contador/xml/":{"post":{"tags":["Painel do Contador"],"summary":"Listagem de XMLs de Documentos Fiscais","description":"Serviço **DocumentosFiscais**. Operações (campo `call`): ListarDocumentos.","operationId":"contador_xml","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/contador_xml_ListarDocumentos"}],"discriminator":{"propertyName":"call","mapping":{"ListarDocumentos":"#/components/schemas/contador_xml_ListarDocumentos"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contador_xml_ListarDocumentos_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/crm/adicionaroportunidade/":{"post":{"tags":["CRM"],"summary":"Inclusão de oportunidade no CRM","description":"Serviço **AdicionarOportunidade**. Operações (campo `call`): AdicionarOp.","operationId":"crm_adicionaroportunidade","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/crm_adicionaroportunidade_AdicionarOp"}],"discriminator":{"propertyName":"call","mapping":{"AdicionarOp":"#/components/schemas/crm_adicionaroportunidade_AdicionarOp"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/crm_adicionaroportunidade_AdicionarOp_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/crm/concorrentes/":{"post":{"tags":["CRM"],"summary":"Concorrentes da oportunidade","description":"Serviço **concorrentes**. Operações (campo `call`): ListarConcorrentes.","operationId":"crm_concorrentes","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/crm_concorrentes_ListarConcorrentes"}],"discriminator":{"propertyName":"call","mapping":{"ListarConcorrentes":"#/components/schemas/crm_concorrentes_ListarConcorrentes"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/crm_concorrentes_ListarConcorrentes_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/crm/contas/":{"post":{"tags":["CRM"],"summary":"Cadastro de Contas do CRM","description":"Serviço **Contas**. Operações (campo `call`): AlterarConta · ConsultarConta · ExcluirConta · IncluirConta · ListarContas · UpsertConta · VerificarConta.","operationId":"crm_contas","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/crm_contas_AlterarConta"},{"$ref":"#/components/schemas/crm_contas_ConsultarConta"},{"$ref":"#/components/schemas/crm_contas_ExcluirConta"},{"$ref":"#/components/schemas/crm_contas_IncluirConta"},{"$ref":"#/components/schemas/crm_contas_ListarContas"},{"$ref":"#/components/schemas/crm_contas_UpsertConta"},{"$ref":"#/components/schemas/crm_contas_VerificarConta"}],"discriminator":{"propertyName":"call","mapping":{"AlterarConta":"#/components/schemas/crm_contas_AlterarConta","ConsultarConta":"#/components/schemas/crm_contas_ConsultarConta","ExcluirConta":"#/components/schemas/crm_contas_ExcluirConta","IncluirConta":"#/components/schemas/crm_contas_IncluirConta","ListarContas":"#/components/schemas/crm_contas_ListarContas","UpsertConta":"#/components/schemas/crm_contas_UpsertConta","VerificarConta":"#/components/schemas/crm_contas_VerificarConta"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/crm_contas_AlterarConta_retorno"},{"$ref":"#/components/schemas/crm_contas_ConsultarConta_retorno"},{"$ref":"#/components/schemas/crm_contas_ExcluirConta_retorno"},{"$ref":"#/components/schemas/crm_contas_IncluirConta_retorno"},{"$ref":"#/components/schemas/crm_contas_ListarContas_retorno"},{"$ref":"#/components/schemas/crm_contas_UpsertConta_retorno"},{"$ref":"#/components/schemas/crm_contas_VerificarConta_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/crm/contascaract/":{"post":{"tags":["CRM"],"summary":"Serviço para Manutenção do Cadastro de Características das Contas do CRM","description":"Serviço **ContasCaracteristicas**. Operações (campo `call`): AlterarCaractConta · ConsultarCaractConta · ExcluirCaractConta · ExcluirTodasCaractConta · IncluirCaractConta.","operationId":"crm_contascaract","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/crm_contascaract_AlterarCaractConta"},{"$ref":"#/components/schemas/crm_contascaract_ConsultarCaractConta"},{"$ref":"#/components/schemas/crm_contascaract_ExcluirCaractConta"},{"$ref":"#/components/schemas/crm_contascaract_ExcluirTodasCaractConta"},{"$ref":"#/components/schemas/crm_contascaract_IncluirCaractConta"}],"discriminator":{"propertyName":"call","mapping":{"AlterarCaractConta":"#/components/schemas/crm_contascaract_AlterarCaractConta","ConsultarCaractConta":"#/components/schemas/crm_contascaract_ConsultarCaractConta","ExcluirCaractConta":"#/components/schemas/crm_contascaract_ExcluirCaractConta","ExcluirTodasCaractConta":"#/components/schemas/crm_contascaract_ExcluirTodasCaractConta","IncluirCaractConta":"#/components/schemas/crm_contascaract_IncluirCaractConta"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/crm_contascaract_AlterarCaractConta_retorno"},{"$ref":"#/components/schemas/crm_contascaract_ConsultarCaractConta_retorno"},{"$ref":"#/components/schemas/crm_contascaract_ExcluirCaractConta_retorno"},{"$ref":"#/components/schemas/crm_contascaract_ExcluirTodasCaractConta_retorno"},{"$ref":"#/components/schemas/crm_contascaract_IncluirCaractConta_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/crm/contatos/":{"post":{"tags":["CRM"],"summary":"Operações relacionadas a CRM - Contatos","description":"Serviço **contatos**. Operações (campo `call`): AlterarContato · ConsultarContato · ExcluirContato · IncluirContato · ListarContatos · UpsertContato · VerificarContato.","operationId":"crm_contatos","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/crm_contatos_AlterarContato"},{"$ref":"#/components/schemas/crm_contatos_ConsultarContato"},{"$ref":"#/components/schemas/crm_contatos_ExcluirContato"},{"$ref":"#/components/schemas/crm_contatos_IncluirContato"},{"$ref":"#/components/schemas/crm_contatos_ListarContatos"},{"$ref":"#/components/schemas/crm_contatos_UpsertContato"},{"$ref":"#/components/schemas/crm_contatos_VerificarContato"}],"discriminator":{"propertyName":"call","mapping":{"AlterarContato":"#/components/schemas/crm_contatos_AlterarContato","ConsultarContato":"#/components/schemas/crm_contatos_ConsultarContato","ExcluirContato":"#/components/schemas/crm_contatos_ExcluirContato","IncluirContato":"#/components/schemas/crm_contatos_IncluirContato","ListarContatos":"#/components/schemas/crm_contatos_ListarContatos","UpsertContato":"#/components/schemas/crm_contatos_UpsertContato","VerificarContato":"#/components/schemas/crm_contatos_VerificarContato"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/crm_contatos_AlterarContato_retorno"},{"$ref":"#/components/schemas/crm_contatos_ConsultarContato_retorno"},{"$ref":"#/components/schemas/crm_contatos_ExcluirContato_retorno"},{"$ref":"#/components/schemas/crm_contatos_IncluirContato_retorno"},{"$ref":"#/components/schemas/crm_contatos_ListarContatos_retorno"},{"$ref":"#/components/schemas/crm_contatos_UpsertContato_retorno"},{"$ref":"#/components/schemas/crm_contatos_VerificarContato_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/crm/fases/":{"post":{"tags":["CRM"],"summary":"Fases da Oportunidade","description":"Serviço **fases**. Operações (campo `call`): ListarFases.","operationId":"crm_fases","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/crm_fases_ListarFases"}],"discriminator":{"propertyName":"call","mapping":{"ListarFases":"#/components/schemas/crm_fases_ListarFases"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/crm_fases_ListarFases_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/crm/finders/":{"post":{"tags":["CRM"],"summary":"Finders da oportunidade.","description":"Serviço **finders**. Operações (campo `call`): ListarFinders.","operationId":"crm_finders","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/crm_finders_ListarFinders"}],"discriminator":{"propertyName":"call","mapping":{"ListarFinders":"#/components/schemas/crm_finders_ListarFinders"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/crm_finders_ListarFinders_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/crm/motivos/":{"post":{"tags":["CRM"],"summary":"Motivos da Oportunidade.","description":"Serviço **motivos**. Operações (campo `call`): ListarMotivos.","operationId":"crm_motivos","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/crm_motivos_ListarMotivos"}],"discriminator":{"propertyName":"call","mapping":{"ListarMotivos":"#/components/schemas/crm_motivos_ListarMotivos"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/crm_motivos_ListarMotivos_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/crm/oportunidades-resumo/":{"post":{"tags":["CRM"],"summary":"Resumo de Oportunidades","description":"Serviço **ResumoOportunidades**. Operações (campo `call`): ObterListaOp · ObterResumoOp.","operationId":"crm_oportunidadesresumo","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/crm_oportunidadesresumo_ObterListaOp"},{"$ref":"#/components/schemas/crm_oportunidadesresumo_ObterResumoOp"}],"discriminator":{"propertyName":"call","mapping":{"ObterListaOp":"#/components/schemas/crm_oportunidadesresumo_ObterListaOp","ObterResumoOp":"#/components/schemas/crm_oportunidadesresumo_ObterResumoOp"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/crm_oportunidadesresumo_ObterListaOp_retorno"},{"$ref":"#/components/schemas/crm_oportunidadesresumo_ObterResumoOp_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/crm/oportunidades/":{"post":{"tags":["CRM"],"summary":"Cadastro de oportunidades","description":"Serviço **oportunidades**. Operações (campo `call`): AlterarOportunidade · ConsultarOportunidade · ExcluirOportunidade · IncluirOportunidade · ListarOportunidades · UpsertOportunidade.","operationId":"crm_oportunidades","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/crm_oportunidades_AlterarOportunidade"},{"$ref":"#/components/schemas/crm_oportunidades_ConsultarOportunidade"},{"$ref":"#/components/schemas/crm_oportunidades_ExcluirOportunidade"},{"$ref":"#/components/schemas/crm_oportunidades_IncluirOportunidade"},{"$ref":"#/components/schemas/crm_oportunidades_ListarOportunidades"},{"$ref":"#/components/schemas/crm_oportunidades_UpsertOportunidade"}],"discriminator":{"propertyName":"call","mapping":{"AlterarOportunidade":"#/components/schemas/crm_oportunidades_AlterarOportunidade","ConsultarOportunidade":"#/components/schemas/crm_oportunidades_ConsultarOportunidade","ExcluirOportunidade":"#/components/schemas/crm_oportunidades_ExcluirOportunidade","IncluirOportunidade":"#/components/schemas/crm_oportunidades_IncluirOportunidade","ListarOportunidades":"#/components/schemas/crm_oportunidades_ListarOportunidades","UpsertOportunidade":"#/components/schemas/crm_oportunidades_UpsertOportunidade"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/crm_oportunidades_AlterarOportunidade_retorno"},{"$ref":"#/components/schemas/crm_oportunidades_ConsultarOportunidade_retorno"},{"$ref":"#/components/schemas/crm_oportunidades_ExcluirOportunidade_retorno"},{"$ref":"#/components/schemas/crm_oportunidades_IncluirOportunidade_retorno"},{"$ref":"#/components/schemas/crm_oportunidades_ListarOportunidades_retorno"},{"$ref":"#/components/schemas/crm_oportunidades_UpsertOportunidade_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/crm/origens/":{"post":{"tags":["CRM"],"summary":"Origens da oportunidade.","description":"Serviço **origens**. Operações (campo `call`): ListarOrigens.","operationId":"crm_origens","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/crm_origens_ListarOrigens"}],"discriminator":{"propertyName":"call","mapping":{"ListarOrigens":"#/components/schemas/crm_origens_ListarOrigens"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/crm_origens_ListarOrigens_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/crm/parceiros/":{"post":{"tags":["CRM"],"summary":"Parceiros e equipes da oportunidade.","description":"Serviço **parceiros**. Operações (campo `call`): ListarParceiros.","operationId":"crm_parceiros","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/crm_parceiros_ListarParceiros"}],"discriminator":{"propertyName":"call","mapping":{"ListarParceiros":"#/components/schemas/crm_parceiros_ListarParceiros"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/crm_parceiros_ListarParceiros_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/crm/solucoes/":{"post":{"tags":["CRM"],"summary":"Soluções da Oportunidade.","description":"Serviço **solucoes**. Operações (campo `call`): ListarSolucoes.","operationId":"crm_solucoes","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/crm_solucoes_ListarSolucoes"}],"discriminator":{"propertyName":"call","mapping":{"ListarSolucoes":"#/components/schemas/crm_solucoes_ListarSolucoes"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/crm_solucoes_ListarSolucoes_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/crm/status/":{"post":{"tags":["CRM"],"summary":"Status da oportunidade.","description":"Serviço **status**. Operações (campo `call`): ListarStatus.","operationId":"crm_status","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/crm_status_ListarStatus"}],"discriminator":{"propertyName":"call","mapping":{"ListarStatus":"#/components/schemas/crm_status_ListarStatus"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/crm_status_ListarStatus_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/crm/tarefas-resumo/":{"post":{"tags":["CRM"],"summary":"Resumos e listas de tarefas do CRM.","description":"Serviço **ResumoTarefas**. Operações (campo `call`): ObterDetalhesTarefa · ObterListaTarefas · ObterResumoTarefas.","operationId":"crm_tarefasresumo","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/crm_tarefasresumo_ObterDetalhesTarefa"},{"$ref":"#/components/schemas/crm_tarefasresumo_ObterListaTarefas"},{"$ref":"#/components/schemas/crm_tarefasresumo_ObterResumoTarefas"}],"discriminator":{"propertyName":"call","mapping":{"ObterDetalhesTarefa":"#/components/schemas/crm_tarefasresumo_ObterDetalhesTarefa","ObterListaTarefas":"#/components/schemas/crm_tarefasresumo_ObterListaTarefas","ObterResumoTarefas":"#/components/schemas/crm_tarefasresumo_ObterResumoTarefas"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/crm_tarefasresumo_ObterDetalhesTarefa_retorno"},{"$ref":"#/components/schemas/crm_tarefasresumo_ObterListaTarefas_retorno"},{"$ref":"#/components/schemas/crm_tarefasresumo_ObterResumoTarefas_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/crm/tarefas/":{"post":{"tags":["CRM"],"summary":"Tarefas da oportunidade.","description":"Serviço **TarefasCrm**. Operações (campo `call`): AlterarTarefa · CalendarioTarefas · ConsultarTarefa · ExcluirTarefa · IncluirTarefa · ListarEmailsTarefas · ListarTarefas · UpsertTarefa.","operationId":"crm_tarefas","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/crm_tarefas_AlterarTarefa"},{"$ref":"#/components/schemas/crm_tarefas_CalendarioTarefas"},{"$ref":"#/components/schemas/crm_tarefas_ConsultarTarefa"},{"$ref":"#/components/schemas/crm_tarefas_ExcluirTarefa"},{"$ref":"#/components/schemas/crm_tarefas_IncluirTarefa"},{"$ref":"#/components/schemas/crm_tarefas_ListarEmailsTarefas"},{"$ref":"#/components/schemas/crm_tarefas_ListarTarefas"},{"$ref":"#/components/schemas/crm_tarefas_UpsertTarefa"}],"discriminator":{"propertyName":"call","mapping":{"AlterarTarefa":"#/components/schemas/crm_tarefas_AlterarTarefa","CalendarioTarefas":"#/components/schemas/crm_tarefas_CalendarioTarefas","ConsultarTarefa":"#/components/schemas/crm_tarefas_ConsultarTarefa","ExcluirTarefa":"#/components/schemas/crm_tarefas_ExcluirTarefa","IncluirTarefa":"#/components/schemas/crm_tarefas_IncluirTarefa","ListarEmailsTarefas":"#/components/schemas/crm_tarefas_ListarEmailsTarefas","ListarTarefas":"#/components/schemas/crm_tarefas_ListarTarefas","UpsertTarefa":"#/components/schemas/crm_tarefas_UpsertTarefa"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/crm_tarefas_AlterarTarefa_retorno"},{"$ref":"#/components/schemas/crm_tarefas_CalendarioTarefas_retorno"},{"$ref":"#/components/schemas/crm_tarefas_ConsultarTarefa_retorno"},{"$ref":"#/components/schemas/crm_tarefas_ExcluirTarefa_retorno"},{"$ref":"#/components/schemas/crm_tarefas_IncluirTarefa_retorno"},{"$ref":"#/components/schemas/crm_tarefas_ListarEmailsTarefas_retorno"},{"$ref":"#/components/schemas/crm_tarefas_ListarTarefas_retorno"},{"$ref":"#/components/schemas/crm_tarefas_UpsertTarefa_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/crm/tipos/":{"post":{"tags":["CRM"],"summary":"Tipos de oportunidades.","description":"Serviço **tipos**. Operações (campo `call`): ListarTipos.","operationId":"crm_tipos","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/crm_tipos_ListarTipos"}],"discriminator":{"propertyName":"call","mapping":{"ListarTipos":"#/components/schemas/crm_tipos_ListarTipos"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/crm_tipos_ListarTipos_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/crm/tipostarefa/":{"post":{"tags":["CRM"],"summary":"Tipos de tarefas","description":"Serviço **TiposTarefaCRM**. Operações (campo `call`): AlterarTipoTarefa · ConsultarTipoTarefa · ExcluirTipoTarefa · IncluirTipoTarefa · ListarTiposTarefa.","operationId":"crm_tipostarefa","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/crm_tipostarefa_AlterarTipoTarefa"},{"$ref":"#/components/schemas/crm_tipostarefa_ConsultarTipoTarefa"},{"$ref":"#/components/schemas/crm_tipostarefa_ExcluirTipoTarefa"},{"$ref":"#/components/schemas/crm_tipostarefa_IncluirTipoTarefa"},{"$ref":"#/components/schemas/crm_tipostarefa_ListarTiposTarefa"}],"discriminator":{"propertyName":"call","mapping":{"AlterarTipoTarefa":"#/components/schemas/crm_tipostarefa_AlterarTipoTarefa","ConsultarTipoTarefa":"#/components/schemas/crm_tipostarefa_ConsultarTipoTarefa","ExcluirTipoTarefa":"#/components/schemas/crm_tipostarefa_ExcluirTipoTarefa","IncluirTipoTarefa":"#/components/schemas/crm_tipostarefa_IncluirTipoTarefa","ListarTiposTarefa":"#/components/schemas/crm_tipostarefa_ListarTiposTarefa"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/crm_tipostarefa_AlterarTipoTarefa_retorno"},{"$ref":"#/components/schemas/crm_tipostarefa_ConsultarTipoTarefa_retorno"},{"$ref":"#/components/schemas/crm_tipostarefa_ExcluirTipoTarefa_retorno"},{"$ref":"#/components/schemas/crm_tipostarefa_IncluirTipoTarefa_retorno"},{"$ref":"#/components/schemas/crm_tipostarefa_ListarTiposTarefa_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/crm/usuarios/":{"post":{"tags":["CRM"],"summary":"Usuários/Vendedores da oportunidade.","description":"Serviço **usuariosCRM**. Operações (campo `call`): ListarUsuarios · ObterUsuarios.","operationId":"crm_usuarios","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/crm_usuarios_ListarUsuarios"},{"$ref":"#/components/schemas/crm_usuarios_ObterUsuarios"}],"discriminator":{"propertyName":"call","mapping":{"ListarUsuarios":"#/components/schemas/crm_usuarios_ListarUsuarios","ObterUsuarios":"#/components/schemas/crm_usuarios_ObterUsuarios"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/crm_usuarios_ListarUsuarios_retorno"},{"$ref":"#/components/schemas/crm_usuarios_ObterUsuarios_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/crm/verticais/":{"post":{"tags":["CRM"],"summary":"Verticais cadastradas no CRM.","description":"Serviço **verticais**. Operações (campo `call`): ListarVerticais.","operationId":"crm_verticais","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/crm_verticais_ListarVerticais"}],"discriminator":{"propertyName":"call","mapping":{"ListarVerticais":"#/components/schemas/crm_verticais_ListarVerticais"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/crm_verticais_ListarVerticais_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/estoque/ajuste/":{"post":{"tags":["Estoque"],"summary":"Serviços de Movimentos de Ajustes de Estoque do Omie","description":"Serviço **AjusteEstoque**. Operações (campo `call`): AlterarEstoqueMinimo · ExcluirAjusteEstoque · IncluirAjusteEstoque · ListarAjusteEstoque.","operationId":"estoque_ajuste","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/estoque_ajuste_AlterarEstoqueMinimo"},{"$ref":"#/components/schemas/estoque_ajuste_ExcluirAjusteEstoque"},{"$ref":"#/components/schemas/estoque_ajuste_IncluirAjusteEstoque"},{"$ref":"#/components/schemas/estoque_ajuste_ListarAjusteEstoque"}],"discriminator":{"propertyName":"call","mapping":{"AlterarEstoqueMinimo":"#/components/schemas/estoque_ajuste_AlterarEstoqueMinimo","ExcluirAjusteEstoque":"#/components/schemas/estoque_ajuste_ExcluirAjusteEstoque","IncluirAjusteEstoque":"#/components/schemas/estoque_ajuste_IncluirAjusteEstoque","ListarAjusteEstoque":"#/components/schemas/estoque_ajuste_ListarAjusteEstoque"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/estoque_ajuste_AlterarEstoqueMinimo_retorno"},{"$ref":"#/components/schemas/estoque_ajuste_ExcluirAjusteEstoque_retorno"},{"$ref":"#/components/schemas/estoque_ajuste_IncluirAjusteEstoque_retorno"},{"$ref":"#/components/schemas/estoque_ajuste_ListarAjusteEstoque_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/estoque/comprador/":{"post":{"tags":["Estoque"],"summary":"Cadastro de Compradores","description":"Serviço **Compradores**. Operações (campo `call`): ListarCompradores.","operationId":"estoque_comprador","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/estoque_comprador_ListarCompradores"}],"discriminator":{"propertyName":"call","mapping":{"ListarCompradores":"#/components/schemas/estoque_comprador_ListarCompradores"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/estoque_comprador_ListarCompradores_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/estoque/consulta/":{"post":{"tags":["Estoque"],"summary":"Serviços de Consulta de Estoque do Omie","description":"Serviço **ConsultaEstoque**. Operações (campo `call`): ListarMovimentoEstoque · ListarPosEstoque · ListarSaldoPendente · MovimentoEstoque · PosicaoEstoque.","operationId":"estoque_consulta","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/estoque_consulta_ListarMovimentoEstoque"},{"$ref":"#/components/schemas/estoque_consulta_ListarPosEstoque"},{"$ref":"#/components/schemas/estoque_consulta_ListarSaldoPendente"},{"$ref":"#/components/schemas/estoque_consulta_MovimentoEstoque"},{"$ref":"#/components/schemas/estoque_consulta_PosicaoEstoque"}],"discriminator":{"propertyName":"call","mapping":{"ListarMovimentoEstoque":"#/components/schemas/estoque_consulta_ListarMovimentoEstoque","ListarPosEstoque":"#/components/schemas/estoque_consulta_ListarPosEstoque","ListarSaldoPendente":"#/components/schemas/estoque_consulta_ListarSaldoPendente","MovimentoEstoque":"#/components/schemas/estoque_consulta_MovimentoEstoque","PosicaoEstoque":"#/components/schemas/estoque_consulta_PosicaoEstoque"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/estoque_consulta_ListarMovimentoEstoque_retorno"},{"$ref":"#/components/schemas/estoque_consulta_ListarPosEstoque_retorno"},{"$ref":"#/components/schemas/estoque_consulta_ListarSaldoPendente_retorno"},{"$ref":"#/components/schemas/estoque_consulta_MovimentoEstoque_retorno"},{"$ref":"#/components/schemas/estoque_consulta_PosicaoEstoque_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/estoque/local/":{"post":{"tags":["Estoque"],"summary":"Cadastro de Locais de Estoque.","description":"Serviço **LocalEstoque**. Operações (campo `call`): AlterarLocalEstoque · IncluirLocalEstoque · ListarLocaisEstoque.","operationId":"estoque_local","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/estoque_local_AlterarLocalEstoque"},{"$ref":"#/components/schemas/estoque_local_IncluirLocalEstoque"},{"$ref":"#/components/schemas/estoque_local_ListarLocaisEstoque"}],"discriminator":{"propertyName":"call","mapping":{"AlterarLocalEstoque":"#/components/schemas/estoque_local_AlterarLocalEstoque","IncluirLocalEstoque":"#/components/schemas/estoque_local_IncluirLocalEstoque","ListarLocaisEstoque":"#/components/schemas/estoque_local_ListarLocaisEstoque"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/estoque_local_AlterarLocalEstoque_retorno"},{"$ref":"#/components/schemas/estoque_local_IncluirLocalEstoque_retorno"},{"$ref":"#/components/schemas/estoque_local_ListarLocaisEstoque_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/estoque/movestoque/":{"post":{"tags":["Estoque"],"summary":"Movimentação do estoque","description":"Serviço **MovimentoEstoque**. Operações (campo `call`): ConsultarPrevisao · ListarMovimentos.","operationId":"estoque_movestoque","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/estoque_movestoque_ConsultarPrevisao"},{"$ref":"#/components/schemas/estoque_movestoque_ListarMovimentos"}],"discriminator":{"propertyName":"call","mapping":{"ConsultarPrevisao":"#/components/schemas/estoque_movestoque_ConsultarPrevisao","ListarMovimentos":"#/components/schemas/estoque_movestoque_ListarMovimentos"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/estoque_movestoque_ConsultarPrevisao_retorno"},{"$ref":"#/components/schemas/estoque_movestoque_ListarMovimentos_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/estoque/produtofornecedor/":{"post":{"tags":["Estoque"],"summary":"Relação de Produtos por fornecedor.","description":"Serviço **ProdutosPorFornecedor**. Operações (campo `call`): ListarProdutoFornecedor.","operationId":"estoque_produtofornecedor","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/estoque_produtofornecedor_ListarProdutoFornecedor"}],"discriminator":{"propertyName":"call","mapping":{"ListarProdutoFornecedor":"#/components/schemas/estoque_produtofornecedor_ListarProdutoFornecedor"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/estoque_produtofornecedor_ListarProdutoFornecedor_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/estoque/reserva/":{"post":{"tags":["Estoque"],"summary":"Serviços de Reserva de Estoque do Omie","description":"Serviço **ReservaEstoque**. Operações (campo `call`): ConsumirReservaEstoque · ExcluirReservaEstoque · IncluirReservaEstoque.","operationId":"estoque_reserva","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/estoque_reserva_ConsumirReservaEstoque"},{"$ref":"#/components/schemas/estoque_reserva_ExcluirReservaEstoque"},{"$ref":"#/components/schemas/estoque_reserva_IncluirReservaEstoque"}],"discriminator":{"propertyName":"call","mapping":{"ConsumirReservaEstoque":"#/components/schemas/estoque_reserva_ConsumirReservaEstoque","ExcluirReservaEstoque":"#/components/schemas/estoque_reserva_ExcluirReservaEstoque","IncluirReservaEstoque":"#/components/schemas/estoque_reserva_IncluirReservaEstoque"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/estoque_reserva_ConsumirReservaEstoque_retorno"},{"$ref":"#/components/schemas/estoque_reserva_ExcluirReservaEstoque_retorno"},{"$ref":"#/components/schemas/estoque_reserva_IncluirReservaEstoque_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/estoque/resumo/":{"post":{"tags":["Estoque"],"summary":"Posição de estoque do produto.","description":"Serviço **ResumoEstoque**. Operações (campo `call`): ObterEstoqueProduto.","operationId":"estoque_resumo","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/estoque_resumo_ObterEstoqueProduto"}],"discriminator":{"propertyName":"call","mapping":{"ObterEstoqueProduto":"#/components/schemas/estoque_resumo_ObterEstoqueProduto"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/estoque_resumo_ObterEstoqueProduto_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/financas/caixa/":{"post":{"tags":["Finanças"],"summary":"Orçamento de Caixa - Previsto x Realizado.","description":"Serviço **OrcamentoCaixa**. Operações (campo `call`): ListarOrcamentos.","operationId":"financas_caixa","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/financas_caixa_ListarOrcamentos"}],"discriminator":{"propertyName":"call","mapping":{"ListarOrcamentos":"#/components/schemas/financas_caixa_ListarOrcamentos"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/financas_caixa_ListarOrcamentos_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/financas/consultaaging/":{"post":{"tags":["Finanças"],"summary":"Operações de consultas de aging (faixas ou carteira)","description":"Serviço **ConsultaAging**. Operações (campo `call`): ListarContasAging.","operationId":"financas_consultaaging","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/financas_consultaaging_ListarContasAging"}],"discriminator":{"propertyName":"call","mapping":{"ListarContasAging":"#/components/schemas/financas_consultaaging_ListarContasAging"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/financas_consultaaging_ListarContasAging_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/financas/contacorrentelancamentos/":{"post":{"tags":["Finanças"],"summary":"Lançamentos de contas correntes","description":"Serviço **ContaCorrenteLancamentos**. Operações (campo `call`): AlterarLancCC · ConsultaLancCC · ExcluirLancCC · IncluirLancCC · ListarLancCC.","operationId":"financas_contacorrentelancamentos","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/financas_contacorrentelancamentos_AlterarLancCC"},{"$ref":"#/components/schemas/financas_contacorrentelancamentos_ConsultaLancCC"},{"$ref":"#/components/schemas/financas_contacorrentelancamentos_ExcluirLancCC"},{"$ref":"#/components/schemas/financas_contacorrentelancamentos_IncluirLancCC"},{"$ref":"#/components/schemas/financas_contacorrentelancamentos_ListarLancCC"}],"discriminator":{"propertyName":"call","mapping":{"AlterarLancCC":"#/components/schemas/financas_contacorrentelancamentos_AlterarLancCC","ConsultaLancCC":"#/components/schemas/financas_contacorrentelancamentos_ConsultaLancCC","ExcluirLancCC":"#/components/schemas/financas_contacorrentelancamentos_ExcluirLancCC","IncluirLancCC":"#/components/schemas/financas_contacorrentelancamentos_IncluirLancCC","ListarLancCC":"#/components/schemas/financas_contacorrentelancamentos_ListarLancCC"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/financas_contacorrentelancamentos_AlterarLancCC_retorno"},{"$ref":"#/components/schemas/financas_contacorrentelancamentos_ConsultaLancCC_retorno"},{"$ref":"#/components/schemas/financas_contacorrentelancamentos_ExcluirLancCC_retorno"},{"$ref":"#/components/schemas/financas_contacorrentelancamentos_IncluirLancCC_retorno"},{"$ref":"#/components/schemas/financas_contacorrentelancamentos_ListarLancCC_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/financas/contapagar-barras/":{"post":{"tags":["Finanças"],"summary":"Lançamento de Contas a Pagar a partir do código de barras do boleto.","description":"Serviço **ContaPagarBarras**. Operações (campo `call`): IncluirContaPagarCodBar.","operationId":"financas_contapagarbarras","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/financas_contapagarbarras_IncluirContaPagarCodBar"}],"discriminator":{"propertyName":"call","mapping":{"IncluirContaPagarCodBar":"#/components/schemas/financas_contapagarbarras_IncluirContaPagarCodBar"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/financas_contapagarbarras_IncluirContaPagarCodBar_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/financas/contapagar/":{"post":{"tags":["Finanças"],"summary":"Lançamento de Contas a Pagar","description":"Serviço **LancamentoContaPagar**. Operações (campo `call`): AlterarContaPagar · CancelarPagamento · ConsultarContaPagar · ExcluirContaPagar · IncluirContaPagar · IncluirContaPagarPorLote · LancarPagamento · ListarContasPagar · UpsertContaPagar · UpsertContaPagarPorLote.","operationId":"financas_contapagar","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/financas_contapagar_AlterarContaPagar"},{"$ref":"#/components/schemas/financas_contapagar_CancelarPagamento"},{"$ref":"#/components/schemas/financas_contapagar_ConsultarContaPagar"},{"$ref":"#/components/schemas/financas_contapagar_ExcluirContaPagar"},{"$ref":"#/components/schemas/financas_contapagar_IncluirContaPagar"},{"$ref":"#/components/schemas/financas_contapagar_IncluirContaPagarPorLote"},{"$ref":"#/components/schemas/financas_contapagar_LancarPagamento"},{"$ref":"#/components/schemas/financas_contapagar_ListarContasPagar"},{"$ref":"#/components/schemas/financas_contapagar_UpsertContaPagar"},{"$ref":"#/components/schemas/financas_contapagar_UpsertContaPagarPorLote"}],"discriminator":{"propertyName":"call","mapping":{"AlterarContaPagar":"#/components/schemas/financas_contapagar_AlterarContaPagar","CancelarPagamento":"#/components/schemas/financas_contapagar_CancelarPagamento","ConsultarContaPagar":"#/components/schemas/financas_contapagar_ConsultarContaPagar","ExcluirContaPagar":"#/components/schemas/financas_contapagar_ExcluirContaPagar","IncluirContaPagar":"#/components/schemas/financas_contapagar_IncluirContaPagar","IncluirContaPagarPorLote":"#/components/schemas/financas_contapagar_IncluirContaPagarPorLote","LancarPagamento":"#/components/schemas/financas_contapagar_LancarPagamento","ListarContasPagar":"#/components/schemas/financas_contapagar_ListarContasPagar","UpsertContaPagar":"#/components/schemas/financas_contapagar_UpsertContaPagar","UpsertContaPagarPorLote":"#/components/schemas/financas_contapagar_UpsertContaPagarPorLote"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/financas_contapagar_AlterarContaPagar_retorno"},{"$ref":"#/components/schemas/financas_contapagar_CancelarPagamento_retorno"},{"$ref":"#/components/schemas/financas_contapagar_ConsultarContaPagar_retorno"},{"$ref":"#/components/schemas/financas_contapagar_ExcluirContaPagar_retorno"},{"$ref":"#/components/schemas/financas_contapagar_IncluirContaPagar_retorno"},{"$ref":"#/components/schemas/financas_contapagar_IncluirContaPagarPorLote_retorno"},{"$ref":"#/components/schemas/financas_contapagar_LancarPagamento_retorno"},{"$ref":"#/components/schemas/financas_contapagar_ListarContasPagar_retorno"},{"$ref":"#/components/schemas/financas_contapagar_UpsertContaPagar_retorno"},{"$ref":"#/components/schemas/financas_contapagar_UpsertContaPagarPorLote_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/financas/contapagaranexos/":{"post":{"tags":["Finanças"],"summary":"Anexos do Contas a Pagar.","description":"Serviço **ContaPagarAnexos**. Operações (campo `call`): lcpConsultarAnexo · lcpExcluirAnexo · lcpIncluirAnexo · lcpListarAnexos · lcpObterAnexo.","operationId":"financas_contapagaranexos","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/financas_contapagaranexos_lcpConsultarAnexo"},{"$ref":"#/components/schemas/financas_contapagaranexos_lcpExcluirAnexo"},{"$ref":"#/components/schemas/financas_contapagaranexos_lcpIncluirAnexo"},{"$ref":"#/components/schemas/financas_contapagaranexos_lcpListarAnexos"},{"$ref":"#/components/schemas/financas_contapagaranexos_lcpObterAnexo"}],"discriminator":{"propertyName":"call","mapping":{"lcpConsultarAnexo":"#/components/schemas/financas_contapagaranexos_lcpConsultarAnexo","lcpExcluirAnexo":"#/components/schemas/financas_contapagaranexos_lcpExcluirAnexo","lcpIncluirAnexo":"#/components/schemas/financas_contapagaranexos_lcpIncluirAnexo","lcpListarAnexos":"#/components/schemas/financas_contapagaranexos_lcpListarAnexos","lcpObterAnexo":"#/components/schemas/financas_contapagaranexos_lcpObterAnexo"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/financas_contapagaranexos_lcpConsultarAnexo_retorno"},{"$ref":"#/components/schemas/financas_contapagaranexos_lcpExcluirAnexo_retorno"},{"$ref":"#/components/schemas/financas_contapagaranexos_lcpIncluirAnexo_retorno"},{"$ref":"#/components/schemas/financas_contapagaranexos_lcpListarAnexos_retorno"},{"$ref":"#/components/schemas/financas_contapagaranexos_lcpObterAnexo_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/financas/contareceber-barras/":{"post":{"tags":["Finanças"],"summary":"Lançamento de contas a receber a partir do código de barras do boleto.","description":"Serviço **ContaReceberBarras**. Operações (campo `call`): IncluirContaReceberCodBar.","operationId":"financas_contareceberbarras","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/financas_contareceberbarras_IncluirContaReceberCodBar"}],"discriminator":{"propertyName":"call","mapping":{"IncluirContaReceberCodBar":"#/components/schemas/financas_contareceberbarras_IncluirContaReceberCodBar"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/financas_contareceberbarras_IncluirContaReceberCodBar_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/financas/contareceber/":{"post":{"tags":["Finanças"],"summary":"Lançamento de Contas a Receber","description":"Serviço **LancamentoContaReceber**. Operações (campo `call`): AlterarContaReceber · CancelarContaReceber · CancelarRecebimento · ConciliarRecebimento · ConsultarContaReceber · DesconciliarRecebimento · ExcluirContaReceber · IncluirContaReceber · IncluirContaReceberPorLote · LancarRecebimento · ListarContasReceber · UpsertContaReceber · UpsertContaReceberPorLote.","operationId":"financas_contareceber","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/financas_contareceber_AlterarContaReceber"},{"$ref":"#/components/schemas/financas_contareceber_CancelarContaReceber"},{"$ref":"#/components/schemas/financas_contareceber_CancelarRecebimento"},{"$ref":"#/components/schemas/financas_contareceber_ConciliarRecebimento"},{"$ref":"#/components/schemas/financas_contareceber_ConsultarContaReceber"},{"$ref":"#/components/schemas/financas_contareceber_DesconciliarRecebimento"},{"$ref":"#/components/schemas/financas_contareceber_ExcluirContaReceber"},{"$ref":"#/components/schemas/financas_contareceber_IncluirContaReceber"},{"$ref":"#/components/schemas/financas_contareceber_IncluirContaReceberPorLote"},{"$ref":"#/components/schemas/financas_contareceber_LancarRecebimento"},{"$ref":"#/components/schemas/financas_contareceber_ListarContasReceber"},{"$ref":"#/components/schemas/financas_contareceber_UpsertContaReceber"},{"$ref":"#/components/schemas/financas_contareceber_UpsertContaReceberPorLote"}],"discriminator":{"propertyName":"call","mapping":{"AlterarContaReceber":"#/components/schemas/financas_contareceber_AlterarContaReceber","CancelarContaReceber":"#/components/schemas/financas_contareceber_CancelarContaReceber","CancelarRecebimento":"#/components/schemas/financas_contareceber_CancelarRecebimento","ConciliarRecebimento":"#/components/schemas/financas_contareceber_ConciliarRecebimento","ConsultarContaReceber":"#/components/schemas/financas_contareceber_ConsultarContaReceber","DesconciliarRecebimento":"#/components/schemas/financas_contareceber_DesconciliarRecebimento","ExcluirContaReceber":"#/components/schemas/financas_contareceber_ExcluirContaReceber","IncluirContaReceber":"#/components/schemas/financas_contareceber_IncluirContaReceber","IncluirContaReceberPorLote":"#/components/schemas/financas_contareceber_IncluirContaReceberPorLote","LancarRecebimento":"#/components/schemas/financas_contareceber_LancarRecebimento","ListarContasReceber":"#/components/schemas/financas_contareceber_ListarContasReceber","UpsertContaReceber":"#/components/schemas/financas_contareceber_UpsertContaReceber","UpsertContaReceberPorLote":"#/components/schemas/financas_contareceber_UpsertContaReceberPorLote"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/financas_contareceber_AlterarContaReceber_retorno"},{"$ref":"#/components/schemas/financas_contareceber_CancelarContaReceber_retorno"},{"$ref":"#/components/schemas/financas_contareceber_CancelarRecebimento_retorno"},{"$ref":"#/components/schemas/financas_contareceber_ConciliarRecebimento_retorno"},{"$ref":"#/components/schemas/financas_contareceber_ConsultarContaReceber_retorno"},{"$ref":"#/components/schemas/financas_contareceber_DesconciliarRecebimento_retorno"},{"$ref":"#/components/schemas/financas_contareceber_ExcluirContaReceber_retorno"},{"$ref":"#/components/schemas/financas_contareceber_IncluirContaReceber_retorno"},{"$ref":"#/components/schemas/financas_contareceber_IncluirContaReceberPorLote_retorno"},{"$ref":"#/components/schemas/financas_contareceber_LancarRecebimento_retorno"},{"$ref":"#/components/schemas/financas_contareceber_ListarContasReceber_retorno"},{"$ref":"#/components/schemas/financas_contareceber_UpsertContaReceber_retorno"},{"$ref":"#/components/schemas/financas_contareceber_UpsertContaReceberPorLote_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/financas/contareceberanexos/":{"post":{"tags":["Finanças"],"summary":"Anexos do Contas a Receber.","description":"Serviço **ContaReceberAnexos**. Operações (campo `call`): lcrConsultarAnexo · lcrExcluirAnexo · lcrIncluirAnexo · lcrListarAnexos · lcrObterAnexo.","operationId":"financas_contareceberanexos","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/financas_contareceberanexos_lcrConsultarAnexo"},{"$ref":"#/components/schemas/financas_contareceberanexos_lcrExcluirAnexo"},{"$ref":"#/components/schemas/financas_contareceberanexos_lcrIncluirAnexo"},{"$ref":"#/components/schemas/financas_contareceberanexos_lcrListarAnexos"},{"$ref":"#/components/schemas/financas_contareceberanexos_lcrObterAnexo"}],"discriminator":{"propertyName":"call","mapping":{"lcrConsultarAnexo":"#/components/schemas/financas_contareceberanexos_lcrConsultarAnexo","lcrExcluirAnexo":"#/components/schemas/financas_contareceberanexos_lcrExcluirAnexo","lcrIncluirAnexo":"#/components/schemas/financas_contareceberanexos_lcrIncluirAnexo","lcrListarAnexos":"#/components/schemas/financas_contareceberanexos_lcrListarAnexos","lcrObterAnexo":"#/components/schemas/financas_contareceberanexos_lcrObterAnexo"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/financas_contareceberanexos_lcrConsultarAnexo_retorno"},{"$ref":"#/components/schemas/financas_contareceberanexos_lcrExcluirAnexo_retorno"},{"$ref":"#/components/schemas/financas_contareceberanexos_lcrIncluirAnexo_retorno"},{"$ref":"#/components/schemas/financas_contareceberanexos_lcrListarAnexos_retorno"},{"$ref":"#/components/schemas/financas_contareceberanexos_lcrObterAnexo_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/financas/contareceberboleto/":{"post":{"tags":["Finanças"],"summary":"API para realizar operações de boletos, como: Gerar Boleto Obter Boleto Prorrogar Boleto Cancelar Boleto","description":"Serviço **ContaReceberBoleto**. Operações (campo `call`): CancelarBoleto · GerarBoleto · ObterBoleto · ProrrogarBoleto.","operationId":"financas_contareceberboleto","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/financas_contareceberboleto_CancelarBoleto"},{"$ref":"#/components/schemas/financas_contareceberboleto_GerarBoleto"},{"$ref":"#/components/schemas/financas_contareceberboleto_ObterBoleto"},{"$ref":"#/components/schemas/financas_contareceberboleto_ProrrogarBoleto"}],"discriminator":{"propertyName":"call","mapping":{"CancelarBoleto":"#/components/schemas/financas_contareceberboleto_CancelarBoleto","GerarBoleto":"#/components/schemas/financas_contareceberboleto_GerarBoleto","ObterBoleto":"#/components/schemas/financas_contareceberboleto_ObterBoleto","ProrrogarBoleto":"#/components/schemas/financas_contareceberboleto_ProrrogarBoleto"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/financas_contareceberboleto_CancelarBoleto_retorno"},{"$ref":"#/components/schemas/financas_contareceberboleto_GerarBoleto_retorno"},{"$ref":"#/components/schemas/financas_contareceberboleto_ObterBoleto_retorno"},{"$ref":"#/components/schemas/financas_contareceberboleto_ProrrogarBoleto_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/financas/extrato/":{"post":{"tags":["Finanças"],"summary":"Listagem do Extrato de Conta Corrente.","description":"Serviço **ExtratoContaCorrente**. Operações (campo `call`): ListarExtrato.","operationId":"financas_extrato","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/financas_extrato_ListarExtrato"}],"discriminator":{"propertyName":"call","mapping":{"ListarExtrato":"#/components/schemas/financas_extrato_ListarExtrato"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/financas_extrato_ListarExtrato_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/financas/mf/":{"post":{"tags":["Finanças"],"summary":"Lista os movimentos financeiros de Contas a Pagar, Contas a Receber e Contas Correntes.","description":"Serviço **MovimentosFinanceiros**. Operações (campo `call`): ListarMovimentos.","operationId":"financas_mf","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/financas_mf_ListarMovimentos"}],"discriminator":{"propertyName":"call","mapping":{"ListarMovimentos":"#/components/schemas/financas_mf_ListarMovimentos"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/financas_mf_ListarMovimentos_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/financas/pesquisartitulos/":{"post":{"tags":["Finanças"],"summary":"Pesquisa titulos de Contas a Pagar e Receber","description":"Serviço **PesquisarTitulos**. Operações (campo `call`): PesquisarLancamentos.","operationId":"financas_pesquisartitulos","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/financas_pesquisartitulos_PesquisarLancamentos"}],"discriminator":{"propertyName":"call","mapping":{"PesquisarLancamentos":"#/components/schemas/financas_pesquisartitulos_PesquisarLancamentos"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/financas_pesquisartitulos_PesquisarLancamentos_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/financas/pix/":{"post":{"tags":["Finanças"],"summary":"Inclusão de um PIX.","description":"Serviço **PIX**. Operações (campo `call`): CancelarPix · GerarPix · GerarQrCodePix · ListarPix · ListarStatusPix · ObterPix · ObterStatusPix.","operationId":"financas_pix","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/financas_pix_CancelarPix"},{"$ref":"#/components/schemas/financas_pix_GerarPix"},{"$ref":"#/components/schemas/financas_pix_GerarQrCodePix"},{"$ref":"#/components/schemas/financas_pix_ListarPix"},{"$ref":"#/components/schemas/financas_pix_ListarStatusPix"},{"$ref":"#/components/schemas/financas_pix_ObterPix"},{"$ref":"#/components/schemas/financas_pix_ObterStatusPix"}],"discriminator":{"propertyName":"call","mapping":{"CancelarPix":"#/components/schemas/financas_pix_CancelarPix","GerarPix":"#/components/schemas/financas_pix_GerarPix","GerarQrCodePix":"#/components/schemas/financas_pix_GerarQrCodePix","ListarPix":"#/components/schemas/financas_pix_ListarPix","ListarStatusPix":"#/components/schemas/financas_pix_ListarStatusPix","ObterPix":"#/components/schemas/financas_pix_ObterPix","ObterStatusPix":"#/components/schemas/financas_pix_ObterStatusPix"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/financas_pix_CancelarPix_retorno"},{"$ref":"#/components/schemas/financas_pix_GerarPix_retorno"},{"$ref":"#/components/schemas/financas_pix_GerarQrCodePix_retorno"},{"$ref":"#/components/schemas/financas_pix_ListarPix_retorno"},{"$ref":"#/components/schemas/financas_pix_ListarStatusPix_retorno"},{"$ref":"#/components/schemas/financas_pix_ObterPix_retorno"},{"$ref":"#/components/schemas/financas_pix_ObterStatusPix_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/financas/resumo/":{"post":{"tags":["Finanças"],"summary":"Resumo das finanças.","description":"Serviço **ResumoFinancas**. Operações (campo `call`): ObterDetalhesLancamento · ObterListaEmAberto · ObterListaFinancas · ObterResumoFinancas.","operationId":"financas_resumo","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/financas_resumo_ObterDetalhesLancamento"},{"$ref":"#/components/schemas/financas_resumo_ObterListaEmAberto"},{"$ref":"#/components/schemas/financas_resumo_ObterListaFinancas"},{"$ref":"#/components/schemas/financas_resumo_ObterResumoFinancas"}],"discriminator":{"propertyName":"call","mapping":{"ObterDetalhesLancamento":"#/components/schemas/financas_resumo_ObterDetalhesLancamento","ObterListaEmAberto":"#/components/schemas/financas_resumo_ObterListaEmAberto","ObterListaFinancas":"#/components/schemas/financas_resumo_ObterListaFinancas","ObterResumoFinancas":"#/components/schemas/financas_resumo_ObterResumoFinancas"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/financas_resumo_ObterDetalhesLancamento_retorno"},{"$ref":"#/components/schemas/financas_resumo_ObterListaEmAberto_retorno"},{"$ref":"#/components/schemas/financas_resumo_ObterListaFinancas_retorno"},{"$ref":"#/components/schemas/financas_resumo_ObterResumoFinancas_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/anexo/":{"post":{"tags":["Geral"],"summary":"API para adicionar anexos as tabelas do sistema. Está disponivel para as seguintes tabelas: cliente produto servico pedi","description":"Serviço **DocumentoAnexo**. Operações (campo `call`): ConsultarAnexo · ExcluirAnexo · IncluirAnexo · ListarAnexo · ObterAnexo.","operationId":"geral_anexo","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_anexo_ConsultarAnexo"},{"$ref":"#/components/schemas/geral_anexo_ExcluirAnexo"},{"$ref":"#/components/schemas/geral_anexo_IncluirAnexo"},{"$ref":"#/components/schemas/geral_anexo_ListarAnexo"},{"$ref":"#/components/schemas/geral_anexo_ObterAnexo"}],"discriminator":{"propertyName":"call","mapping":{"ConsultarAnexo":"#/components/schemas/geral_anexo_ConsultarAnexo","ExcluirAnexo":"#/components/schemas/geral_anexo_ExcluirAnexo","IncluirAnexo":"#/components/schemas/geral_anexo_IncluirAnexo","ListarAnexo":"#/components/schemas/geral_anexo_ListarAnexo","ObterAnexo":"#/components/schemas/geral_anexo_ObterAnexo"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/geral_anexo_ConsultarAnexo_retorno"},{"$ref":"#/components/schemas/geral_anexo_ExcluirAnexo_retorno"},{"$ref":"#/components/schemas/geral_anexo_IncluirAnexo_retorno"},{"$ref":"#/components/schemas/geral_anexo_ListarAnexo_retorno"},{"$ref":"#/components/schemas/geral_anexo_ObterAnexo_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/bancos/":{"post":{"tags":["Geral"],"summary":"API para consulta dos dados bancarios.","description":"Serviço **BancosCadastro**. Operações (campo `call`): ConsultarBanco · ListarBancos.","operationId":"geral_bancos","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_bancos_ConsultarBanco"},{"$ref":"#/components/schemas/geral_bancos_ListarBancos"}],"discriminator":{"propertyName":"call","mapping":{"ConsultarBanco":"#/components/schemas/geral_bancos_ConsultarBanco","ListarBancos":"#/components/schemas/geral_bancos_ListarBancos"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/geral_bancos_ConsultarBanco_retorno"},{"$ref":"#/components/schemas/geral_bancos_ListarBancos_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/bandeiracartao/":{"post":{"tags":["Geral"],"summary":"Listagem das bandeiras de cartões.","description":"Serviço **BandeiraCartao**. Operações (campo `call`): ListarBandeiras.","operationId":"geral_bandeiracartao","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_bandeiracartao_ListarBandeiras"}],"discriminator":{"propertyName":"call","mapping":{"ListarBandeiras":"#/components/schemas/geral_bandeiracartao_ListarBandeiras"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/geral_bandeiracartao_ListarBandeiras_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/caracteristicas/":{"post":{"tags":["Geral"],"summary":"Cadastro de características de produto.","description":"Serviço **CaracteristicasCadastro**. Operações (campo `call`): AlterarCaracteristica · ConsultarCaracteristica · ExcluirCaracteristica · IncluirCaracteristica · ListarCaracteristicas.","operationId":"geral_caracteristicas","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_caracteristicas_AlterarCaracteristica"},{"$ref":"#/components/schemas/geral_caracteristicas_ConsultarCaracteristica"},{"$ref":"#/components/schemas/geral_caracteristicas_ExcluirCaracteristica"},{"$ref":"#/components/schemas/geral_caracteristicas_IncluirCaracteristica"},{"$ref":"#/components/schemas/geral_caracteristicas_ListarCaracteristicas"}],"discriminator":{"propertyName":"call","mapping":{"AlterarCaracteristica":"#/components/schemas/geral_caracteristicas_AlterarCaracteristica","ConsultarCaracteristica":"#/components/schemas/geral_caracteristicas_ConsultarCaracteristica","ExcluirCaracteristica":"#/components/schemas/geral_caracteristicas_ExcluirCaracteristica","IncluirCaracteristica":"#/components/schemas/geral_caracteristicas_IncluirCaracteristica","ListarCaracteristicas":"#/components/schemas/geral_caracteristicas_ListarCaracteristicas"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/geral_caracteristicas_AlterarCaracteristica_retorno"},{"$ref":"#/components/schemas/geral_caracteristicas_ConsultarCaracteristica_retorno"},{"$ref":"#/components/schemas/geral_caracteristicas_ExcluirCaracteristica_retorno"},{"$ref":"#/components/schemas/geral_caracteristicas_IncluirCaracteristica_retorno"},{"$ref":"#/components/schemas/geral_caracteristicas_ListarCaracteristicas_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/categorias/":{"post":{"tags":["Geral"],"summary":"Cadastro de Categorias","description":"Serviço **CategoriasCadastro**. Operações (campo `call`): AlterarCategoria · AlterarGrupoCategoria · ConsultarCategoria · IncluirCategoria · IncluirGrupoCategoria · ListarCategorias.","operationId":"geral_categorias","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_categorias_AlterarCategoria"},{"$ref":"#/components/schemas/geral_categorias_AlterarGrupoCategoria"},{"$ref":"#/components/schemas/geral_categorias_ConsultarCategoria"},{"$ref":"#/components/schemas/geral_categorias_IncluirCategoria"},{"$ref":"#/components/schemas/geral_categorias_IncluirGrupoCategoria"},{"$ref":"#/components/schemas/geral_categorias_ListarCategorias"}],"discriminator":{"propertyName":"call","mapping":{"AlterarCategoria":"#/components/schemas/geral_categorias_AlterarCategoria","AlterarGrupoCategoria":"#/components/schemas/geral_categorias_AlterarGrupoCategoria","ConsultarCategoria":"#/components/schemas/geral_categorias_ConsultarCategoria","IncluirCategoria":"#/components/schemas/geral_categorias_IncluirCategoria","IncluirGrupoCategoria":"#/components/schemas/geral_categorias_IncluirGrupoCategoria","ListarCategorias":"#/components/schemas/geral_categorias_ListarCategorias"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/geral_categorias_AlterarCategoria_retorno"},{"$ref":"#/components/schemas/geral_categorias_AlterarGrupoCategoria_retorno"},{"$ref":"#/components/schemas/geral_categorias_ConsultarCategoria_retorno"},{"$ref":"#/components/schemas/geral_categorias_IncluirCategoria_retorno"},{"$ref":"#/components/schemas/geral_categorias_IncluirGrupoCategoria_retorno"},{"$ref":"#/components/schemas/geral_categorias_ListarCategorias_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/cenarios/":{"post":{"tags":["Geral"],"summary":"Cenários de Impostos.","description":"Serviço **CenariosImpostos**. Operações (campo `call`): ListarCenarios · ListarImpostosCenario.","operationId":"geral_cenarios","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_cenarios_ListarCenarios"},{"$ref":"#/components/schemas/geral_cenarios_ListarImpostosCenario"}],"discriminator":{"propertyName":"call","mapping":{"ListarCenarios":"#/components/schemas/geral_cenarios_ListarCenarios","ListarImpostosCenario":"#/components/schemas/geral_cenarios_ListarImpostosCenario"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/geral_cenarios_ListarCenarios_retorno"},{"$ref":"#/components/schemas/geral_cenarios_ListarImpostosCenario_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/cidades/":{"post":{"tags":["Geral"],"summary":"Cadastro das Cidades do Omie","description":"Serviço **CidadesCadastro**. Operações (campo `call`): PesquisarCidades.","operationId":"geral_cidades","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_cidades_PesquisarCidades"}],"discriminator":{"propertyName":"call","mapping":{"PesquisarCidades":"#/components/schemas/geral_cidades_PesquisarCidades"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/geral_cidades_PesquisarCidades_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/clienterestricao/":{"post":{"tags":["Geral"],"summary":"Serviço para consulta de restrição de crédito de clientes","description":"Serviço **ClienteRestricao**. Operações (campo `call`): ConsultarRestricao · ObterInfoRestricao.","operationId":"geral_clienterestricao","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_clienterestricao_ConsultarRestricao"},{"$ref":"#/components/schemas/geral_clienterestricao_ObterInfoRestricao"}],"discriminator":{"propertyName":"call","mapping":{"ConsultarRestricao":"#/components/schemas/geral_clienterestricao_ConsultarRestricao","ObterInfoRestricao":"#/components/schemas/geral_clienterestricao_ObterInfoRestricao"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/geral_clienterestricao_ConsultarRestricao_retorno"},{"$ref":"#/components/schemas/geral_clienterestricao_ObterInfoRestricao_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/clientes/":{"post":{"tags":["Geral"],"summary":"Cadastro de Clientes e Fornecedores","description":"Serviço **ClientesCadastro**. Operações (campo `call`): AlterarCliente · AlterarSituacaoCliente · AssociarCodIntCliente · ConsultarCliente · ExcluirCliente · IncluirCliente · ListarClientes · ListarClientesResumido · UpsertCliente · UpsertClienteCpfCnpj.","operationId":"geral_clientes","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_clientes_AlterarCliente"},{"$ref":"#/components/schemas/geral_clientes_AlterarSituacaoCliente"},{"$ref":"#/components/schemas/geral_clientes_AssociarCodIntCliente"},{"$ref":"#/components/schemas/geral_clientes_ConsultarCliente"},{"$ref":"#/components/schemas/geral_clientes_ExcluirCliente"},{"$ref":"#/components/schemas/geral_clientes_IncluirCliente"},{"$ref":"#/components/schemas/geral_clientes_ListarClientes"},{"$ref":"#/components/schemas/geral_clientes_ListarClientesResumido"},{"$ref":"#/components/schemas/geral_clientes_UpsertCliente"},{"$ref":"#/components/schemas/geral_clientes_UpsertClienteCpfCnpj"}],"discriminator":{"propertyName":"call","mapping":{"AlterarCliente":"#/components/schemas/geral_clientes_AlterarCliente","AlterarSituacaoCliente":"#/components/schemas/geral_clientes_AlterarSituacaoCliente","AssociarCodIntCliente":"#/components/schemas/geral_clientes_AssociarCodIntCliente","ConsultarCliente":"#/components/schemas/geral_clientes_ConsultarCliente","ExcluirCliente":"#/components/schemas/geral_clientes_ExcluirCliente","IncluirCliente":"#/components/schemas/geral_clientes_IncluirCliente","ListarClientes":"#/components/schemas/geral_clientes_ListarClientes","ListarClientesResumido":"#/components/schemas/geral_clientes_ListarClientesResumido","UpsertCliente":"#/components/schemas/geral_clientes_UpsertCliente","UpsertClienteCpfCnpj":"#/components/schemas/geral_clientes_UpsertClienteCpfCnpj"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/geral_clientes_AlterarCliente_retorno"},{"$ref":"#/components/schemas/geral_clientes_AlterarSituacaoCliente_retorno"},{"$ref":"#/components/schemas/geral_clientes_AssociarCodIntCliente_retorno"},{"$ref":"#/components/schemas/geral_clientes_ConsultarCliente_retorno"},{"$ref":"#/components/schemas/geral_clientes_ExcluirCliente_retorno"},{"$ref":"#/components/schemas/geral_clientes_IncluirCliente_retorno"},{"$ref":"#/components/schemas/geral_clientes_ListarClientes_retorno"},{"$ref":"#/components/schemas/geral_clientes_ListarClientesResumido_retorno"},{"$ref":"#/components/schemas/geral_clientes_UpsertCliente_retorno"},{"$ref":"#/components/schemas/geral_clientes_UpsertClienteCpfCnpj_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/clientescaract/":{"post":{"tags":["Geral"],"summary":"Serviço para Manutenção do Cadastro de Características para Clientes ou Fornecedores.","description":"Serviço **ClientesCaracteristicas**. Operações (campo `call`): AlterarCaractCliente · ConsultarCaractCliente · ExcluirCaractCliente · ExcluirTodasCaractCliente · IncluirCaractCliente.","operationId":"geral_clientescaract","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_clientescaract_AlterarCaractCliente"},{"$ref":"#/components/schemas/geral_clientescaract_ConsultarCaractCliente"},{"$ref":"#/components/schemas/geral_clientescaract_ExcluirCaractCliente"},{"$ref":"#/components/schemas/geral_clientescaract_ExcluirTodasCaractCliente"},{"$ref":"#/components/schemas/geral_clientescaract_IncluirCaractCliente"}],"discriminator":{"propertyName":"call","mapping":{"AlterarCaractCliente":"#/components/schemas/geral_clientescaract_AlterarCaractCliente","ConsultarCaractCliente":"#/components/schemas/geral_clientescaract_ConsultarCaractCliente","ExcluirCaractCliente":"#/components/schemas/geral_clientescaract_ExcluirCaractCliente","ExcluirTodasCaractCliente":"#/components/schemas/geral_clientescaract_ExcluirTodasCaractCliente","IncluirCaractCliente":"#/components/schemas/geral_clientescaract_IncluirCaractCliente"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/geral_clientescaract_AlterarCaractCliente_retorno"},{"$ref":"#/components/schemas/geral_clientescaract_ConsultarCaractCliente_retorno"},{"$ref":"#/components/schemas/geral_clientescaract_ExcluirCaractCliente_retorno"},{"$ref":"#/components/schemas/geral_clientescaract_ExcluirTodasCaractCliente_retorno"},{"$ref":"#/components/schemas/geral_clientescaract_IncluirCaractCliente_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/clientetag/":{"post":{"tags":["Geral"],"summary":"Cadastro de Tags de Clientes","description":"Serviço **ClientesTags**. Operações (campo `call`): ExcluirTags · ExcluirTodas · IncluirTags · ListarTags.","operationId":"geral_clientetag","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_clientetag_ExcluirTags"},{"$ref":"#/components/schemas/geral_clientetag_ExcluirTodas"},{"$ref":"#/components/schemas/geral_clientetag_IncluirTags"},{"$ref":"#/components/schemas/geral_clientetag_ListarTags"}],"discriminator":{"propertyName":"call","mapping":{"ExcluirTags":"#/components/schemas/geral_clientetag_ExcluirTags","ExcluirTodas":"#/components/schemas/geral_clientetag_ExcluirTodas","IncluirTags":"#/components/schemas/geral_clientetag_IncluirTags","ListarTags":"#/components/schemas/geral_clientetag_ListarTags"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/geral_clientetag_ExcluirTags_retorno"},{"$ref":"#/components/schemas/geral_clientetag_ExcluirTodas_retorno"},{"$ref":"#/components/schemas/geral_clientetag_IncluirTags_retorno"},{"$ref":"#/components/schemas/geral_clientetag_ListarTags_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/contacorrente/":{"post":{"tags":["Geral"],"summary":"Cadastro de contas corrrentes","description":"Serviço **ContaCorrenteCadastro**. Operações (campo `call`): AlterarContaCorrente · ConsultarContaCorrente · ExcluirContaCorrente · IncluirContaCorrente · ListarContasCorrentes · ListarResumoContasCorrentes · UpsertContaCorrente · UpsertContaCorrentePorLote.","operationId":"geral_contacorrente","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_contacorrente_AlterarContaCorrente"},{"$ref":"#/components/schemas/geral_contacorrente_ConsultarContaCorrente"},{"$ref":"#/components/schemas/geral_contacorrente_ExcluirContaCorrente"},{"$ref":"#/components/schemas/geral_contacorrente_IncluirContaCorrente"},{"$ref":"#/components/schemas/geral_contacorrente_ListarContasCorrentes"},{"$ref":"#/components/schemas/geral_contacorrente_ListarResumoContasCorrentes"},{"$ref":"#/components/schemas/geral_contacorrente_UpsertContaCorrente"},{"$ref":"#/components/schemas/geral_contacorrente_UpsertContaCorrentePorLote"}],"discriminator":{"propertyName":"call","mapping":{"AlterarContaCorrente":"#/components/schemas/geral_contacorrente_AlterarContaCorrente","ConsultarContaCorrente":"#/components/schemas/geral_contacorrente_ConsultarContaCorrente","ExcluirContaCorrente":"#/components/schemas/geral_contacorrente_ExcluirContaCorrente","IncluirContaCorrente":"#/components/schemas/geral_contacorrente_IncluirContaCorrente","ListarContasCorrentes":"#/components/schemas/geral_contacorrente_ListarContasCorrentes","ListarResumoContasCorrentes":"#/components/schemas/geral_contacorrente_ListarResumoContasCorrentes","UpsertContaCorrente":"#/components/schemas/geral_contacorrente_UpsertContaCorrente","UpsertContaCorrentePorLote":"#/components/schemas/geral_contacorrente_UpsertContaCorrentePorLote"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/geral_contacorrente_AlterarContaCorrente_retorno"},{"$ref":"#/components/schemas/geral_contacorrente_ConsultarContaCorrente_retorno"},{"$ref":"#/components/schemas/geral_contacorrente_ExcluirContaCorrente_retorno"},{"$ref":"#/components/schemas/geral_contacorrente_IncluirContaCorrente_retorno"},{"$ref":"#/components/schemas/geral_contacorrente_ListarContasCorrentes_retorno"},{"$ref":"#/components/schemas/geral_contacorrente_ListarResumoContasCorrentes_retorno"},{"$ref":"#/components/schemas/geral_contacorrente_UpsertContaCorrente_retorno"},{"$ref":"#/components/schemas/geral_contacorrente_UpsertContaCorrentePorLote_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/departamentos/":{"post":{"tags":["Geral"],"summary":"Cadastro de Departamentos","description":"Serviço **DepartamentosCadastro**. Operações (campo `call`): AlterarDepartamento · ConsultarDepartamento · ExcluirDepartamento · IncluirDepartamento · ListarDepartamentos.","operationId":"geral_departamentos","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_departamentos_AlterarDepartamento"},{"$ref":"#/components/schemas/geral_departamentos_ConsultarDepartamento"},{"$ref":"#/components/schemas/geral_departamentos_ExcluirDepartamento"},{"$ref":"#/components/schemas/geral_departamentos_IncluirDepartamento"},{"$ref":"#/components/schemas/geral_departamentos_ListarDepartamentos"}],"discriminator":{"propertyName":"call","mapping":{"AlterarDepartamento":"#/components/schemas/geral_departamentos_AlterarDepartamento","ConsultarDepartamento":"#/components/schemas/geral_departamentos_ConsultarDepartamento","ExcluirDepartamento":"#/components/schemas/geral_departamentos_ExcluirDepartamento","IncluirDepartamento":"#/components/schemas/geral_departamentos_IncluirDepartamento","ListarDepartamentos":"#/components/schemas/geral_departamentos_ListarDepartamentos"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/geral_departamentos_AlterarDepartamento_retorno"},{"$ref":"#/components/schemas/geral_departamentos_ConsultarDepartamento_retorno"},{"$ref":"#/components/schemas/geral_departamentos_ExcluirDepartamento_retorno"},{"$ref":"#/components/schemas/geral_departamentos_IncluirDepartamento_retorno"},{"$ref":"#/components/schemas/geral_departamentos_ListarDepartamentos_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/dre/":{"post":{"tags":["Geral"],"summary":"Cadastro de DRE","description":"Serviço **DreCadastro**. Operações (campo `call`): ListarCadastroDRE.","operationId":"geral_dre","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_dre_ListarCadastroDRE"}],"discriminator":{"propertyName":"call","mapping":{"ListarCadastroDRE":"#/components/schemas/geral_dre_ListarCadastroDRE"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/geral_dre_ListarCadastroDRE_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/empresas/":{"post":{"tags":["Geral"],"summary":"Cadastro de Empresas","description":"Serviço **EmpresasCadastro**. Operações (campo `call`): ConsultarEmpresa · ListarEmpresas.","operationId":"geral_empresas","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_empresas_ConsultarEmpresa"},{"$ref":"#/components/schemas/geral_empresas_ListarEmpresas"}],"discriminator":{"propertyName":"call","mapping":{"ConsultarEmpresa":"#/components/schemas/geral_empresas_ConsultarEmpresa","ListarEmpresas":"#/components/schemas/geral_empresas_ListarEmpresas"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/geral_empresas_ConsultarEmpresa_retorno"},{"$ref":"#/components/schemas/geral_empresas_ListarEmpresas_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/estados/":{"post":{"tags":["Geral"],"summary":"Cadastro de Estados.","description":"Serviço **EstadosCadastro**. Operações (campo `call`): ListarEstados.","operationId":"geral_estados","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_estados_ListarEstados"}],"discriminator":{"propertyName":"call","mapping":{"ListarEstados":"#/components/schemas/geral_estados_ListarEstados"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/geral_estados_ListarEstados_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/familias/":{"post":{"tags":["Geral"],"summary":"Cadastro de Familias de Produtos","description":"Serviço **FamiliasCadastro**. Operações (campo `call`): AlterarFamilia · ConsultarFamilia · ExcluirFamilia · IncluirFamilia · PesquisarFamilias · UpsertFamilia.","operationId":"geral_familias","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_familias_AlterarFamilia"},{"$ref":"#/components/schemas/geral_familias_ConsultarFamilia"},{"$ref":"#/components/schemas/geral_familias_ExcluirFamilia"},{"$ref":"#/components/schemas/geral_familias_IncluirFamilia"},{"$ref":"#/components/schemas/geral_familias_PesquisarFamilias"},{"$ref":"#/components/schemas/geral_familias_UpsertFamilia"}],"discriminator":{"propertyName":"call","mapping":{"AlterarFamilia":"#/components/schemas/geral_familias_AlterarFamilia","ConsultarFamilia":"#/components/schemas/geral_familias_ConsultarFamilia","ExcluirFamilia":"#/components/schemas/geral_familias_ExcluirFamilia","IncluirFamilia":"#/components/schemas/geral_familias_IncluirFamilia","PesquisarFamilias":"#/components/schemas/geral_familias_PesquisarFamilias","UpsertFamilia":"#/components/schemas/geral_familias_UpsertFamilia"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/geral_familias_AlterarFamilia_retorno"},{"$ref":"#/components/schemas/geral_familias_ConsultarFamilia_retorno"},{"$ref":"#/components/schemas/geral_familias_ExcluirFamilia_retorno"},{"$ref":"#/components/schemas/geral_familias_IncluirFamilia_retorno"},{"$ref":"#/components/schemas/geral_familias_PesquisarFamilias_retorno"},{"$ref":"#/components/schemas/geral_familias_UpsertFamilia_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/finaltransf/":{"post":{"tags":["Geral"],"summary":"API para consulta das finalidades de transferência","description":"Serviço **FinalTransfCadastro**. Operações (campo `call`): ConsultarFinalTransf · ListarFinalTransf.","operationId":"geral_finaltransf","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_finaltransf_ConsultarFinalTransf"},{"$ref":"#/components/schemas/geral_finaltransf_ListarFinalTransf"}],"discriminator":{"propertyName":"call","mapping":{"ConsultarFinalTransf":"#/components/schemas/geral_finaltransf_ConsultarFinalTransf","ListarFinalTransf":"#/components/schemas/geral_finaltransf_ListarFinalTransf"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/geral_finaltransf_ConsultarFinalTransf_retorno"},{"$ref":"#/components/schemas/geral_finaltransf_ListarFinalTransf_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/lotevalidade/":{"post":{"tags":["Geral"],"summary":"API das configurações de Lote e Validade.","description":"Serviço **LoteValidade**. Operações (campo `call`): ConsultarLoteValidade.","operationId":"geral_lotevalidade","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_lotevalidade_ConsultarLoteValidade"}],"discriminator":{"propertyName":"call","mapping":{"ConsultarLoteValidade":"#/components/schemas/geral_lotevalidade_ConsultarLoteValidade"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/geral_lotevalidade_ConsultarLoteValidade_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/malha/":{"post":{"tags":["Geral"],"summary":"Estrutura de produtos.","description":"Serviço **ProdutosEstrutura**. Operações (campo `call`): AlterarEstrutura · ConsultarEstrutura · ExcluirEstrutura · IncluirEstrutura · ListarEstruturas.","operationId":"geral_malha","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_malha_AlterarEstrutura"},{"$ref":"#/components/schemas/geral_malha_ConsultarEstrutura"},{"$ref":"#/components/schemas/geral_malha_ExcluirEstrutura"},{"$ref":"#/components/schemas/geral_malha_IncluirEstrutura"},{"$ref":"#/components/schemas/geral_malha_ListarEstruturas"}],"discriminator":{"propertyName":"call","mapping":{"AlterarEstrutura":"#/components/schemas/geral_malha_AlterarEstrutura","ConsultarEstrutura":"#/components/schemas/geral_malha_ConsultarEstrutura","ExcluirEstrutura":"#/components/schemas/geral_malha_ExcluirEstrutura","IncluirEstrutura":"#/components/schemas/geral_malha_IncluirEstrutura","ListarEstruturas":"#/components/schemas/geral_malha_ListarEstruturas"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/geral_malha_AlterarEstrutura_retorno"},{"$ref":"#/components/schemas/geral_malha_ConsultarEstrutura_retorno"},{"$ref":"#/components/schemas/geral_malha_ExcluirEstrutura_retorno"},{"$ref":"#/components/schemas/geral_malha_IncluirEstrutura_retorno"},{"$ref":"#/components/schemas/geral_malha_ListarEstruturas_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/meiospagamento/":{"post":{"tags":["Geral"],"summary":"Cadastro de meios de pagamento","description":"Serviço **MeiosPagamentoCadastro**. Operações (campo `call`): ListarMeiosPagamento.","operationId":"geral_meiospagamento","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_meiospagamento_ListarMeiosPagamento"}],"discriminator":{"propertyName":"call","mapping":{"ListarMeiosPagamento":"#/components/schemas/geral_meiospagamento_ListarMeiosPagamento"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/geral_meiospagamento_ListarMeiosPagamento_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/motivodevolucao/":{"post":{"tags":["Geral"],"summary":"Motivos de devolução de pedidos de venda e compras.","description":"Serviço **MotivoDevolucao**. Operações (campo `call`): ListarMotivosDevol.","operationId":"geral_motivodevolucao","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_motivodevolucao_ListarMotivosDevol"}],"discriminator":{"propertyName":"call","mapping":{"ListarMotivosDevol":"#/components/schemas/geral_motivodevolucao_ListarMotivosDevol"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/geral_motivodevolucao_ListarMotivosDevol_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/negativacaoclientes/":{"post":{"tags":["Geral"],"summary":"A negativação de clientes é uma funcionalidade que permite registrar pendências financeiras em aberto em órgãos de prote","description":"Serviço **NegativacaoClientes**. Operações (campo `call`): NegativacaoClientesContratado · NegativacaoClientesContratar · NegativacaoClientesCriar · NegativacaoClientesCusto · NegativacaoClientesLista · NegativacaoClientesNaturezasDivida · NegativacaoClientesPesquisa · NegativacaoClientesTotalRecuperado.","operationId":"geral_negativacaoclientes","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_negativacaoclientes_NegativacaoClientesContratado"},{"$ref":"#/components/schemas/geral_negativacaoclientes_NegativacaoClientesContratar"},{"$ref":"#/components/schemas/geral_negativacaoclientes_NegativacaoClientesCriar"},{"$ref":"#/components/schemas/geral_negativacaoclientes_NegativacaoClientesCusto"},{"$ref":"#/components/schemas/geral_negativacaoclientes_NegativacaoClientesLista"},{"$ref":"#/components/schemas/geral_negativacaoclientes_NegativacaoClientesNaturezasDivida"},{"$ref":"#/components/schemas/geral_negativacaoclientes_NegativacaoClientesPesquisa"},{"$ref":"#/components/schemas/geral_negativacaoclientes_NegativacaoClientesTotalRecuperado"}],"discriminator":{"propertyName":"call","mapping":{"NegativacaoClientesContratado":"#/components/schemas/geral_negativacaoclientes_NegativacaoClientesContratado","NegativacaoClientesContratar":"#/components/schemas/geral_negativacaoclientes_NegativacaoClientesContratar","NegativacaoClientesCriar":"#/components/schemas/geral_negativacaoclientes_NegativacaoClientesCriar","NegativacaoClientesCusto":"#/components/schemas/geral_negativacaoclientes_NegativacaoClientesCusto","NegativacaoClientesLista":"#/components/schemas/geral_negativacaoclientes_NegativacaoClientesLista","NegativacaoClientesNaturezasDivida":"#/components/schemas/geral_negativacaoclientes_NegativacaoClientesNaturezasDivida","NegativacaoClientesPesquisa":"#/components/schemas/geral_negativacaoclientes_NegativacaoClientesPesquisa","NegativacaoClientesTotalRecuperado":"#/components/schemas/geral_negativacaoclientes_NegativacaoClientesTotalRecuperado"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/geral_negativacaoclientes_NegativacaoClientesContratado_retorno"},{"$ref":"#/components/schemas/geral_negativacaoclientes_NegativacaoClientesContratar_retorno"},{"$ref":"#/components/schemas/geral_negativacaoclientes_NegativacaoClientesCriar_retorno"},{"$ref":"#/components/schemas/geral_negativacaoclientes_NegativacaoClientesCusto_retorno"},{"$ref":"#/components/schemas/geral_negativacaoclientes_NegativacaoClientesLista_retorno"},{"$ref":"#/components/schemas/geral_negativacaoclientes_NegativacaoClientesNaturezasDivida_retorno"},{"$ref":"#/components/schemas/geral_negativacaoclientes_NegativacaoClientesPesquisa_retorno"},{"$ref":"#/components/schemas/geral_negativacaoclientes_NegativacaoClientesTotalRecuperado_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/origemlancamento/":{"post":{"tags":["Geral"],"summary":"Lista origem de lançamento.","description":"Serviço **OrigemLancamento**. Operações (campo `call`): ListarOrigem.","operationId":"geral_origemlancamento","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_origemlancamento_ListarOrigem"}],"discriminator":{"propertyName":"call","mapping":{"ListarOrigem":"#/components/schemas/geral_origemlancamento_ListarOrigem"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/geral_origemlancamento_ListarOrigem_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/origempedido/":{"post":{"tags":["Geral"],"summary":"Lista as origens de pedido.","description":"Serviço **OrigemPedido**. Operações (campo `call`): ListarOrigem.","operationId":"geral_origempedido","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_origempedido_ListarOrigem"}],"discriminator":{"propertyName":"call","mapping":{"ListarOrigem":"#/components/schemas/geral_origempedido_ListarOrigem"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/geral_origempedido_ListarOrigem_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/paises/":{"post":{"tags":["Geral"],"summary":"Cadastro de Países","description":"Serviço **PaisesCadastro**. Operações (campo `call`): ListarPaises.","operationId":"geral_paises","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_paises_ListarPaises"}],"discriminator":{"propertyName":"call","mapping":{"ListarPaises":"#/components/schemas/geral_paises_ListarPaises"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/geral_paises_ListarPaises_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/parcelas/":{"post":{"tags":["Geral"],"summary":"Cadastro de parcelas","description":"Serviço **Parcelas**. Operações (campo `call`): IncluirParcela · ListarParcelas.","operationId":"geral_parcelas","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_parcelas_IncluirParcela"},{"$ref":"#/components/schemas/geral_parcelas_ListarParcelas"}],"discriminator":{"propertyName":"call","mapping":{"IncluirParcela":"#/components/schemas/geral_parcelas_IncluirParcela","ListarParcelas":"#/components/schemas/geral_parcelas_ListarParcelas"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/geral_parcelas_IncluirParcela_retorno"},{"$ref":"#/components/schemas/geral_parcelas_ListarParcelas_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/periodosnotificacao/":{"post":{"tags":["Geral"],"summary":"API para listar os períodos de notificação.","description":"Serviço **PeriodosNotificacao**. Operações (campo `call`): ListarPeriodosNotificacao.","operationId":"geral_periodosnotificacao","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_periodosnotificacao_ListarPeriodosNotificacao"}],"discriminator":{"propertyName":"call","mapping":{"ListarPeriodosNotificacao":"#/components/schemas/geral_periodosnotificacao_ListarPeriodosNotificacao"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/geral_periodosnotificacao_ListarPeriodosNotificacao_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/prodcaract/":{"post":{"tags":["Geral"],"summary":"Características do produto.","description":"Serviço **ProdutosCaracteristicas**. Operações (campo `call`): AlterarCaractProduto · ConsultarCaractProduto · ExcluirCaractProduto · IncluirCaractProduto · ListarCaractProduto.","operationId":"geral_prodcaract","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_prodcaract_AlterarCaractProduto"},{"$ref":"#/components/schemas/geral_prodcaract_ConsultarCaractProduto"},{"$ref":"#/components/schemas/geral_prodcaract_ExcluirCaractProduto"},{"$ref":"#/components/schemas/geral_prodcaract_IncluirCaractProduto"},{"$ref":"#/components/schemas/geral_prodcaract_ListarCaractProduto"}],"discriminator":{"propertyName":"call","mapping":{"AlterarCaractProduto":"#/components/schemas/geral_prodcaract_AlterarCaractProduto","ConsultarCaractProduto":"#/components/schemas/geral_prodcaract_ConsultarCaractProduto","ExcluirCaractProduto":"#/components/schemas/geral_prodcaract_ExcluirCaractProduto","IncluirCaractProduto":"#/components/schemas/geral_prodcaract_IncluirCaractProduto","ListarCaractProduto":"#/components/schemas/geral_prodcaract_ListarCaractProduto"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/geral_prodcaract_AlterarCaractProduto_retorno"},{"$ref":"#/components/schemas/geral_prodcaract_ConsultarCaractProduto_retorno"},{"$ref":"#/components/schemas/geral_prodcaract_ExcluirCaractProduto_retorno"},{"$ref":"#/components/schemas/geral_prodcaract_IncluirCaractProduto_retorno"},{"$ref":"#/components/schemas/geral_prodcaract_ListarCaractProduto_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/prodimp/":{"post":{"tags":["Geral"],"summary":"Impostos dos produtos.","description":"Serviço **ProdutosImpostos**. Operações (campo `call`): AlterarImposto · ExcluirImposto · IncluirImposto · ListarImpostos · UpsertImposto.","operationId":"geral_prodimp","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_prodimp_AlterarImposto"},{"$ref":"#/components/schemas/geral_prodimp_ExcluirImposto"},{"$ref":"#/components/schemas/geral_prodimp_IncluirImposto"},{"$ref":"#/components/schemas/geral_prodimp_ListarImpostos"},{"$ref":"#/components/schemas/geral_prodimp_UpsertImposto"}],"discriminator":{"propertyName":"call","mapping":{"AlterarImposto":"#/components/schemas/geral_prodimp_AlterarImposto","ExcluirImposto":"#/components/schemas/geral_prodimp_ExcluirImposto","IncluirImposto":"#/components/schemas/geral_prodimp_IncluirImposto","ListarImpostos":"#/components/schemas/geral_prodimp_ListarImpostos","UpsertImposto":"#/components/schemas/geral_prodimp_UpsertImposto"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/geral_prodimp_AlterarImposto_retorno"},{"$ref":"#/components/schemas/geral_prodimp_ExcluirImposto_retorno"},{"$ref":"#/components/schemas/geral_prodimp_IncluirImposto_retorno"},{"$ref":"#/components/schemas/geral_prodimp_ListarImpostos_retorno"},{"$ref":"#/components/schemas/geral_prodimp_UpsertImposto_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/produtos/":{"post":{"tags":["Geral"],"summary":"Cadastro de Produtos","description":"Serviço **ProdutosCadastro**. Operações (campo `call`): AlterarProduto · AlterarSituacaoProduto · AssociarCodIntProduto · ConsultarProduto · ExcluirProduto · IncluirProduto · ListarProdutos · ListarProdutosResumido · UpsertProduto.","operationId":"geral_produtos","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_produtos_AlterarProduto"},{"$ref":"#/components/schemas/geral_produtos_AlterarSituacaoProduto"},{"$ref":"#/components/schemas/geral_produtos_AssociarCodIntProduto"},{"$ref":"#/components/schemas/geral_produtos_ConsultarProduto"},{"$ref":"#/components/schemas/geral_produtos_ExcluirProduto"},{"$ref":"#/components/schemas/geral_produtos_IncluirProduto"},{"$ref":"#/components/schemas/geral_produtos_ListarProdutos"},{"$ref":"#/components/schemas/geral_produtos_ListarProdutosResumido"},{"$ref":"#/components/schemas/geral_produtos_UpsertProduto"}],"discriminator":{"propertyName":"call","mapping":{"AlterarProduto":"#/components/schemas/geral_produtos_AlterarProduto","AlterarSituacaoProduto":"#/components/schemas/geral_produtos_AlterarSituacaoProduto","AssociarCodIntProduto":"#/components/schemas/geral_produtos_AssociarCodIntProduto","ConsultarProduto":"#/components/schemas/geral_produtos_ConsultarProduto","ExcluirProduto":"#/components/schemas/geral_produtos_ExcluirProduto","IncluirProduto":"#/components/schemas/geral_produtos_IncluirProduto","ListarProdutos":"#/components/schemas/geral_produtos_ListarProdutos","ListarProdutosResumido":"#/components/schemas/geral_produtos_ListarProdutosResumido","UpsertProduto":"#/components/schemas/geral_produtos_UpsertProduto"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/geral_produtos_AlterarProduto_retorno"},{"$ref":"#/components/schemas/geral_produtos_AlterarSituacaoProduto_retorno"},{"$ref":"#/components/schemas/geral_produtos_AssociarCodIntProduto_retorno"},{"$ref":"#/components/schemas/geral_produtos_ConsultarProduto_retorno"},{"$ref":"#/components/schemas/geral_produtos_ExcluirProduto_retorno"},{"$ref":"#/components/schemas/geral_produtos_IncluirProduto_retorno"},{"$ref":"#/components/schemas/geral_produtos_ListarProdutos_retorno"},{"$ref":"#/components/schemas/geral_produtos_ListarProdutosResumido_retorno"},{"$ref":"#/components/schemas/geral_produtos_UpsertProduto_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/produtoskit/":{"post":{"tags":["Geral"],"summary":"KIT de produtos.","description":"Serviço **ProdutosKit**. Operações (campo `call`): AlterarComponentesKit.","operationId":"geral_produtoskit","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_produtoskit_AlterarComponentesKit"}],"discriminator":{"propertyName":"call","mapping":{"AlterarComponentesKit":"#/components/schemas/geral_produtoskit_AlterarComponentesKit"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/geral_produtoskit_AlterarComponentesKit_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/projetos/":{"post":{"tags":["Geral"],"summary":"Cadastro de Projetos","description":"Serviço **ProjetosCadastro**. Operações (campo `call`): AlterarProjeto · ConsultarProjeto · ExcluirProjeto · IncluirProjeto · ListarProjetos · UpsertProjeto.","operationId":"geral_projetos","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_projetos_AlterarProjeto"},{"$ref":"#/components/schemas/geral_projetos_ConsultarProjeto"},{"$ref":"#/components/schemas/geral_projetos_ExcluirProjeto"},{"$ref":"#/components/schemas/geral_projetos_IncluirProjeto"},{"$ref":"#/components/schemas/geral_projetos_ListarProjetos"},{"$ref":"#/components/schemas/geral_projetos_UpsertProjeto"}],"discriminator":{"propertyName":"call","mapping":{"AlterarProjeto":"#/components/schemas/geral_projetos_AlterarProjeto","ConsultarProjeto":"#/components/schemas/geral_projetos_ConsultarProjeto","ExcluirProjeto":"#/components/schemas/geral_projetos_ExcluirProjeto","IncluirProjeto":"#/components/schemas/geral_projetos_IncluirProjeto","ListarProjetos":"#/components/schemas/geral_projetos_ListarProjetos","UpsertProjeto":"#/components/schemas/geral_projetos_UpsertProjeto"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/geral_projetos_AlterarProjeto_retorno"},{"$ref":"#/components/schemas/geral_projetos_ConsultarProjeto_retorno"},{"$ref":"#/components/schemas/geral_projetos_ExcluirProjeto_retorno"},{"$ref":"#/components/schemas/geral_projetos_IncluirProjeto_retorno"},{"$ref":"#/components/schemas/geral_projetos_ListarProjetos_retorno"},{"$ref":"#/components/schemas/geral_projetos_UpsertProjeto_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/tarefas/":{"post":{"tags":["Geral"],"summary":"API para realizar operações relacionados as tarefas do ERP","description":"Serviço **Tarefas**. Operações (campo `call`): AlterarTarefa · ConsultarTarefa · ExcluirTarefa · IncluirTarefa · ListarTarefas · ObterCalendarioTarefas · ObterResumoTarefas · ObterTotalTarefas.","operationId":"geral_tarefas","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_tarefas_AlterarTarefa"},{"$ref":"#/components/schemas/geral_tarefas_ConsultarTarefa"},{"$ref":"#/components/schemas/geral_tarefas_ExcluirTarefa"},{"$ref":"#/components/schemas/geral_tarefas_IncluirTarefa"},{"$ref":"#/components/schemas/geral_tarefas_ListarTarefas"},{"$ref":"#/components/schemas/geral_tarefas_ObterCalendarioTarefas"},{"$ref":"#/components/schemas/geral_tarefas_ObterResumoTarefas"},{"$ref":"#/components/schemas/geral_tarefas_ObterTotalTarefas"}],"discriminator":{"propertyName":"call","mapping":{"AlterarTarefa":"#/components/schemas/geral_tarefas_AlterarTarefa","ConsultarTarefa":"#/components/schemas/geral_tarefas_ConsultarTarefa","ExcluirTarefa":"#/components/schemas/geral_tarefas_ExcluirTarefa","IncluirTarefa":"#/components/schemas/geral_tarefas_IncluirTarefa","ListarTarefas":"#/components/schemas/geral_tarefas_ListarTarefas","ObterCalendarioTarefas":"#/components/schemas/geral_tarefas_ObterCalendarioTarefas","ObterResumoTarefas":"#/components/schemas/geral_tarefas_ObterResumoTarefas","ObterTotalTarefas":"#/components/schemas/geral_tarefas_ObterTotalTarefas"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/geral_tarefas_AlterarTarefa_retorno"},{"$ref":"#/components/schemas/geral_tarefas_ConsultarTarefa_retorno"},{"$ref":"#/components/schemas/geral_tarefas_ExcluirTarefa_retorno"},{"$ref":"#/components/schemas/geral_tarefas_IncluirTarefa_retorno"},{"$ref":"#/components/schemas/geral_tarefas_ListarTarefas_retorno"},{"$ref":"#/components/schemas/geral_tarefas_ObterCalendarioTarefas_retorno"},{"$ref":"#/components/schemas/geral_tarefas_ObterResumoTarefas_retorno"},{"$ref":"#/components/schemas/geral_tarefas_ObterTotalTarefas_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/tarefasorigem/":{"post":{"tags":["Geral"],"summary":"API para listar as origens de tarefa do ERP.","description":"Serviço **TarefasOrigem**. Operações (campo `call`): ObterTarefasOrigem.","operationId":"geral_tarefasorigem","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_tarefasorigem_ObterTarefasOrigem"}],"discriminator":{"propertyName":"call","mapping":{"ObterTarefasOrigem":"#/components/schemas/geral_tarefasorigem_ObterTarefasOrigem"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/geral_tarefasorigem_ObterTarefasOrigem_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/tipoassinante/":{"post":{"tags":["Geral"],"summary":"Cadastro de Tipo de Assinante (NF modelo 21 e 22)","description":"Serviço **TipoAssinante**. Operações (campo `call`): ListarTipoAssinante.","operationId":"geral_tipoassinante","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_tipoassinante_ListarTipoAssinante"}],"discriminator":{"propertyName":"call","mapping":{"ListarTipoAssinante":"#/components/schemas/geral_tipoassinante_ListarTipoAssinante"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/geral_tipoassinante_ListarTipoAssinante_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/tipocategoria/":{"post":{"tags":["Geral"],"summary":"Tipo de categoria","description":"Serviço **TipoCategoria**. Operações (campo `call`): ListarTipoCategoria.","operationId":"geral_tipocategoria","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_tipocategoria_ListarTipoCategoria"}],"discriminator":{"propertyName":"call","mapping":{"ListarTipoCategoria":"#/components/schemas/geral_tipocategoria_ListarTipoCategoria"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/geral_tipocategoria_ListarTipoCategoria_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/tipocc/":{"post":{"tags":["Geral"],"summary":"Tipos de conta corrente.","description":"Serviço **TipoCCCadastro**. Operações (campo `call`): ListarTiposCC.","operationId":"geral_tipocc","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_tipocc_ListarTiposCC"}],"discriminator":{"propertyName":"call","mapping":{"ListarTiposCC":"#/components/schemas/geral_tipocc_ListarTiposCC"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/geral_tipocc_ListarTiposCC_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/tiposanexo/":{"post":{"tags":["Geral"],"summary":"Cadastro de Tipos de Anexos","description":"Serviço **TiposAnexoCadastro**. Operações (campo `call`): ListarTiposAnexos.","operationId":"geral_tiposanexo","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_tiposanexo_ListarTiposAnexos"}],"discriminator":{"propertyName":"call","mapping":{"ListarTiposAnexos":"#/components/schemas/geral_tiposanexo_ListarTiposAnexos"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/geral_tiposanexo_ListarTiposAnexos_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/tiposdoc/":{"post":{"tags":["Geral"],"summary":"Cadastro de Tipos de Documento","description":"Serviço **TiposDocumentoCadastro**. Operações (campo `call`): ConsultarTipoDocumento · PesquisarTipoDocumento.","operationId":"geral_tiposdoc","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_tiposdoc_ConsultarTipoDocumento"},{"$ref":"#/components/schemas/geral_tiposdoc_PesquisarTipoDocumento"}],"discriminator":{"propertyName":"call","mapping":{"ConsultarTipoDocumento":"#/components/schemas/geral_tiposdoc_ConsultarTipoDocumento","PesquisarTipoDocumento":"#/components/schemas/geral_tiposdoc_PesquisarTipoDocumento"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/geral_tiposdoc_ConsultarTipoDocumento_retorno"},{"$ref":"#/components/schemas/geral_tiposdoc_PesquisarTipoDocumento_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/tiposentrega/":{"post":{"tags":["Geral"],"summary":"Cadastro de Tipos de Entrega","description":"Serviço **TiposEntrega**. Operações (campo `call`): AlterarTipoEntrega · ConsultarTipoEntrega · ExcluirTipoEntrega · IncluirTipoEntrega · ListarTipoEntrega.","operationId":"geral_tiposentrega","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_tiposentrega_AlterarTipoEntrega"},{"$ref":"#/components/schemas/geral_tiposentrega_ConsultarTipoEntrega"},{"$ref":"#/components/schemas/geral_tiposentrega_ExcluirTipoEntrega"},{"$ref":"#/components/schemas/geral_tiposentrega_IncluirTipoEntrega"},{"$ref":"#/components/schemas/geral_tiposentrega_ListarTipoEntrega"}],"discriminator":{"propertyName":"call","mapping":{"AlterarTipoEntrega":"#/components/schemas/geral_tiposentrega_AlterarTipoEntrega","ConsultarTipoEntrega":"#/components/schemas/geral_tiposentrega_ConsultarTipoEntrega","ExcluirTipoEntrega":"#/components/schemas/geral_tiposentrega_ExcluirTipoEntrega","IncluirTipoEntrega":"#/components/schemas/geral_tiposentrega_IncluirTipoEntrega","ListarTipoEntrega":"#/components/schemas/geral_tiposentrega_ListarTipoEntrega"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/geral_tiposentrega_AlterarTipoEntrega_retorno"},{"$ref":"#/components/schemas/geral_tiposentrega_ConsultarTipoEntrega_retorno"},{"$ref":"#/components/schemas/geral_tiposentrega_ExcluirTipoEntrega_retorno"},{"$ref":"#/components/schemas/geral_tiposentrega_IncluirTipoEntrega_retorno"},{"$ref":"#/components/schemas/geral_tiposentrega_ListarTipoEntrega_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/tipostarefa/":{"post":{"tags":["Geral"],"summary":"API para realizar operações relacionados aos tipos de tarefa do ERP","description":"Serviço **TiposTarefa**. Operações (campo `call`): AlterarTiposTarefa · ExcluirTiposTarefa · IncluirTiposTarefa · ObterTiposTarefa.","operationId":"geral_tipostarefa","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_tipostarefa_AlterarTiposTarefa"},{"$ref":"#/components/schemas/geral_tipostarefa_ExcluirTiposTarefa"},{"$ref":"#/components/schemas/geral_tipostarefa_IncluirTiposTarefa"},{"$ref":"#/components/schemas/geral_tipostarefa_ObterTiposTarefa"}],"discriminator":{"propertyName":"call","mapping":{"AlterarTiposTarefa":"#/components/schemas/geral_tipostarefa_AlterarTiposTarefa","ExcluirTiposTarefa":"#/components/schemas/geral_tipostarefa_ExcluirTiposTarefa","IncluirTiposTarefa":"#/components/schemas/geral_tipostarefa_IncluirTiposTarefa","ObterTiposTarefa":"#/components/schemas/geral_tipostarefa_ObterTiposTarefa"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/geral_tipostarefa_AlterarTiposTarefa_retorno"},{"$ref":"#/components/schemas/geral_tipostarefa_ExcluirTiposTarefa_retorno"},{"$ref":"#/components/schemas/geral_tipostarefa_IncluirTiposTarefa_retorno"},{"$ref":"#/components/schemas/geral_tipostarefa_ObterTiposTarefa_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/tpativ/":{"post":{"tags":["Geral"],"summary":"Cadastro de tipos de Atividades.","description":"Serviço **tpAtivCadastro**. Operações (campo `call`): ListarTipoAtiv.","operationId":"geral_tpativ","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_tpativ_ListarTipoAtiv"}],"discriminator":{"propertyName":"call","mapping":{"ListarTipoAtiv":"#/components/schemas/geral_tpativ_ListarTipoAtiv"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/geral_tpativ_ListarTipoAtiv_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/unidade/":{"post":{"tags":["Geral"],"summary":"Cadastro de Unidades de Medidas","description":"Serviço **UnidadesCadastro**. Operações (campo `call`): ListarUnidades.","operationId":"geral_unidade","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_unidade_ListarUnidades"}],"discriminator":{"propertyName":"call","mapping":{"ListarUnidades":"#/components/schemas/geral_unidade_ListarUnidades"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/geral_unidade_ListarUnidades_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/geral/vendedores/":{"post":{"tags":["Geral"],"summary":"Cadastro de Vendedores","description":"Serviço **VendedoresCadastro**. Operações (campo `call`): AlterarVendedor · ConsultarVendedor · ExcluirVendedor · IncluirVendedor · ListarVendedores · UpsertVendedor.","operationId":"geral_vendedores","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/geral_vendedores_AlterarVendedor"},{"$ref":"#/components/schemas/geral_vendedores_ConsultarVendedor"},{"$ref":"#/components/schemas/geral_vendedores_ExcluirVendedor"},{"$ref":"#/components/schemas/geral_vendedores_IncluirVendedor"},{"$ref":"#/components/schemas/geral_vendedores_ListarVendedores"},{"$ref":"#/components/schemas/geral_vendedores_UpsertVendedor"}],"discriminator":{"propertyName":"call","mapping":{"AlterarVendedor":"#/components/schemas/geral_vendedores_AlterarVendedor","ConsultarVendedor":"#/components/schemas/geral_vendedores_ConsultarVendedor","ExcluirVendedor":"#/components/schemas/geral_vendedores_ExcluirVendedor","IncluirVendedor":"#/components/schemas/geral_vendedores_IncluirVendedor","ListarVendedores":"#/components/schemas/geral_vendedores_ListarVendedores","UpsertVendedor":"#/components/schemas/geral_vendedores_UpsertVendedor"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/geral_vendedores_AlterarVendedor_retorno"},{"$ref":"#/components/schemas/geral_vendedores_ConsultarVendedor_retorno"},{"$ref":"#/components/schemas/geral_vendedores_ExcluirVendedor_retorno"},{"$ref":"#/components/schemas/geral_vendedores_IncluirVendedor_retorno"},{"$ref":"#/components/schemas/geral_vendedores_ListarVendedores_retorno"},{"$ref":"#/components/schemas/geral_vendedores_UpsertVendedor_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/blocox/":{"post":{"tags":["Produtos"],"summary":"Dados da exportação do bloco X.","description":"Serviço **ecf_blocoX**. Operações (campo `call`): ListarNFsBlocoX.","operationId":"produtos_blocox","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_blocox_ListarNFsBlocoX"}],"discriminator":{"propertyName":"call","mapping":{"ListarNFsBlocoX":"#/components/schemas/produtos_blocox_ListarNFsBlocoX"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/produtos_blocox_ListarNFsBlocoX_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/cest/":{"post":{"tags":["Produtos"],"summary":"Listagem do CEST","description":"Serviço **CEST**. Operações (campo `call`): ListarCEST.","operationId":"produtos_cest","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_cest_ListarCEST"}],"discriminator":{"propertyName":"call","mapping":{"ListarCEST":"#/components/schemas/produtos_cest_ListarCEST"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/produtos_cest_ListarCEST_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/cfop/":{"post":{"tags":["Produtos"],"summary":"Listagem de CFOPs.","description":"Serviço **CFOP**. Operações (campo `call`): ListarCFOP.","operationId":"produtos_cfop","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_cfop_ListarCFOP"}],"discriminator":{"propertyName":"call","mapping":{"ListarCFOP":"#/components/schemas/produtos_cfop_ListarCFOP"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/produtos_cfop_ListarCFOP_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/classtrib/":{"post":{"tags":["Produtos"],"summary":"API para retornar lista de classificações tributárias do IBS e CBS","description":"Serviço **ClassTrib**. Operações (campo `call`): ListarClassTrib.","operationId":"produtos_classtrib","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_classtrib_ListarClassTrib"}],"discriminator":{"propertyName":"call","mapping":{"ListarClassTrib":"#/components/schemas/produtos_classtrib_ListarClassTrib"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/produtos_classtrib_ListarClassTrib_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/cnae/":{"post":{"tags":["Produtos"],"summary":"Listagem de CNAEs.","description":"Serviço **CNAE**. Operações (campo `call`): ListarCNAE.","operationId":"produtos_cnae","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_cnae_ListarCNAE"}],"discriminator":{"propertyName":"call","mapping":{"ListarCNAE":"#/components/schemas/produtos_cnae_ListarCNAE"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/produtos_cnae_ListarCNAE_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/cofinscst/":{"post":{"tags":["Produtos"],"summary":"Listagem de CST do COFINS.","description":"Serviço **cofinsCST**. Operações (campo `call`): ListarCstCofins.","operationId":"produtos_cofinscst","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_cofinscst_ListarCstCofins"}],"discriminator":{"propertyName":"call","mapping":{"ListarCstCofins":"#/components/schemas/produtos_cofinscst_ListarCstCofins"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/produtos_cofinscst_ListarCstCofins_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/compras-resumo/":{"post":{"tags":["Produtos"],"summary":"Resumo de compras de produtos.","description":"Serviço **ResumoProdutosCompras**. Operações (campo `call`): ObterResumoCompras.","operationId":"produtos_comprasresumo","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_comprasresumo_ObterResumoCompras"}],"discriminator":{"propertyName":"call","mapping":{"ObterResumoCompras":"#/components/schemas/produtos_comprasresumo_ObterResumoCompras"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/produtos_comprasresumo_ObterResumoCompras_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/cte/":{"post":{"tags":["Produtos"],"summary":"Importação de Conhecimento de Transporte Eletrônico.","description":"Serviço **ConhecimentoTransporte**. Operações (campo `call`): AlterarCte · AverbacaoCTe · CancelarCTe · CartaCorrecaoCTe · ExcluirCTe · ExcluirFaturaCTe · FaturarCTe · FaturarLoteCTe · ImportarCTe · ListarNFeTransp · StatusFatura.","operationId":"produtos_cte","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_cte_AlterarCte"},{"$ref":"#/components/schemas/produtos_cte_AverbacaoCTe"},{"$ref":"#/components/schemas/produtos_cte_CancelarCTe"},{"$ref":"#/components/schemas/produtos_cte_CartaCorrecaoCTe"},{"$ref":"#/components/schemas/produtos_cte_ExcluirCTe"},{"$ref":"#/components/schemas/produtos_cte_ExcluirFaturaCTe"},{"$ref":"#/components/schemas/produtos_cte_FaturarCTe"},{"$ref":"#/components/schemas/produtos_cte_FaturarLoteCTe"},{"$ref":"#/components/schemas/produtos_cte_ImportarCTe"},{"$ref":"#/components/schemas/produtos_cte_ListarNFeTransp"},{"$ref":"#/components/schemas/produtos_cte_StatusFatura"}],"discriminator":{"propertyName":"call","mapping":{"AlterarCte":"#/components/schemas/produtos_cte_AlterarCte","AverbacaoCTe":"#/components/schemas/produtos_cte_AverbacaoCTe","CancelarCTe":"#/components/schemas/produtos_cte_CancelarCTe","CartaCorrecaoCTe":"#/components/schemas/produtos_cte_CartaCorrecaoCTe","ExcluirCTe":"#/components/schemas/produtos_cte_ExcluirCTe","ExcluirFaturaCTe":"#/components/schemas/produtos_cte_ExcluirFaturaCTe","FaturarCTe":"#/components/schemas/produtos_cte_FaturarCTe","FaturarLoteCTe":"#/components/schemas/produtos_cte_FaturarLoteCTe","ImportarCTe":"#/components/schemas/produtos_cte_ImportarCTe","ListarNFeTransp":"#/components/schemas/produtos_cte_ListarNFeTransp","StatusFatura":"#/components/schemas/produtos_cte_StatusFatura"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/produtos_cte_AlterarCte_retorno"},{"$ref":"#/components/schemas/produtos_cte_AverbacaoCTe_retorno"},{"$ref":"#/components/schemas/produtos_cte_CancelarCTe_retorno"},{"$ref":"#/components/schemas/produtos_cte_CartaCorrecaoCTe_retorno"},{"$ref":"#/components/schemas/produtos_cte_ExcluirCTe_retorno"},{"$ref":"#/components/schemas/produtos_cte_ExcluirFaturaCTe_retorno"},{"$ref":"#/components/schemas/produtos_cte_FaturarCTe_retorno"},{"$ref":"#/components/schemas/produtos_cte_FaturarLoteCTe_retorno"},{"$ref":"#/components/schemas/produtos_cte_ImportarCTe_retorno"},{"$ref":"#/components/schemas/produtos_cte_ListarNFeTransp_retorno"},{"$ref":"#/components/schemas/produtos_cte_StatusFatura_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/cupomfiscal/":{"post":{"tags":["Produtos"],"summary":"Cadastro de Cupons Fiscais","description":"Serviço **CupomFiscal**. Operações (campo `call`): CancelarCupom · CancelarNFCE · CancelarSAT · DevolverCupom · ExcluirCupom · ExcluirCuponsPorNumero · ExcluirLote · ListarCupons · ObterProximoLote.","operationId":"produtos_cupomfiscal","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_cupomfiscal_CancelarCupom"},{"$ref":"#/components/schemas/produtos_cupomfiscal_CancelarNFCE"},{"$ref":"#/components/schemas/produtos_cupomfiscal_CancelarSAT"},{"$ref":"#/components/schemas/produtos_cupomfiscal_DevolverCupom"},{"$ref":"#/components/schemas/produtos_cupomfiscal_ExcluirCupom"},{"$ref":"#/components/schemas/produtos_cupomfiscal_ExcluirCuponsPorNumero"},{"$ref":"#/components/schemas/produtos_cupomfiscal_ExcluirLote"},{"$ref":"#/components/schemas/produtos_cupomfiscal_ListarCupons"},{"$ref":"#/components/schemas/produtos_cupomfiscal_ObterProximoLote"}],"discriminator":{"propertyName":"call","mapping":{"CancelarCupom":"#/components/schemas/produtos_cupomfiscal_CancelarCupom","CancelarNFCE":"#/components/schemas/produtos_cupomfiscal_CancelarNFCE","CancelarSAT":"#/components/schemas/produtos_cupomfiscal_CancelarSAT","DevolverCupom":"#/components/schemas/produtos_cupomfiscal_DevolverCupom","ExcluirCupom":"#/components/schemas/produtos_cupomfiscal_ExcluirCupom","ExcluirCuponsPorNumero":"#/components/schemas/produtos_cupomfiscal_ExcluirCuponsPorNumero","ExcluirLote":"#/components/schemas/produtos_cupomfiscal_ExcluirLote","ListarCupons":"#/components/schemas/produtos_cupomfiscal_ListarCupons","ObterProximoLote":"#/components/schemas/produtos_cupomfiscal_ObterProximoLote"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/produtos_cupomfiscal_CancelarCupom_retorno"},{"$ref":"#/components/schemas/produtos_cupomfiscal_CancelarNFCE_retorno"},{"$ref":"#/components/schemas/produtos_cupomfiscal_CancelarSAT_retorno"},{"$ref":"#/components/schemas/produtos_cupomfiscal_DevolverCupom_retorno"},{"$ref":"#/components/schemas/produtos_cupomfiscal_ExcluirCupom_retorno"},{"$ref":"#/components/schemas/produtos_cupomfiscal_ExcluirCuponsPorNumero_retorno"},{"$ref":"#/components/schemas/produtos_cupomfiscal_ExcluirLote_retorno"},{"$ref":"#/components/schemas/produtos_cupomfiscal_ListarCupons_retorno"},{"$ref":"#/components/schemas/produtos_cupomfiscal_ObterProximoLote_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/cupomfiscalconsultar/":{"post":{"tags":["Produtos"],"summary":"Consultas de cupom fiscal","description":"Serviço **CupomFiscalConsultar**. Operações (campo `call`): CuponsFiscais · CuponsItens · CuponsPagamentos.","operationId":"produtos_cupomfiscalconsultar","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_cupomfiscalconsultar_CuponsFiscais"},{"$ref":"#/components/schemas/produtos_cupomfiscalconsultar_CuponsItens"},{"$ref":"#/components/schemas/produtos_cupomfiscalconsultar_CuponsPagamentos"}],"discriminator":{"propertyName":"call","mapping":{"CuponsFiscais":"#/components/schemas/produtos_cupomfiscalconsultar_CuponsFiscais","CuponsItens":"#/components/schemas/produtos_cupomfiscalconsultar_CuponsItens","CuponsPagamentos":"#/components/schemas/produtos_cupomfiscalconsultar_CuponsPagamentos"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/produtos_cupomfiscalconsultar_CuponsFiscais_retorno"},{"$ref":"#/components/schemas/produtos_cupomfiscalconsultar_CuponsItens_retorno"},{"$ref":"#/components/schemas/produtos_cupomfiscalconsultar_CuponsPagamentos_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/cupomfiscalincluir/":{"post":{"tags":["Produtos"],"summary":"Adicionar cupons fiscais.","description":"Serviço **CupomFiscalIncluir**. Operações (campo `call`): FecharCaixa · IncluirCfeSat · IncluirCupom · IncluirNfce · IncluirRps · InutilizarNfce.","operationId":"produtos_cupomfiscalincluir","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_cupomfiscalincluir_FecharCaixa"},{"$ref":"#/components/schemas/produtos_cupomfiscalincluir_IncluirCfeSat"},{"$ref":"#/components/schemas/produtos_cupomfiscalincluir_IncluirCupom"},{"$ref":"#/components/schemas/produtos_cupomfiscalincluir_IncluirNfce"},{"$ref":"#/components/schemas/produtos_cupomfiscalincluir_IncluirRps"},{"$ref":"#/components/schemas/produtos_cupomfiscalincluir_InutilizarNfce"}],"discriminator":{"propertyName":"call","mapping":{"FecharCaixa":"#/components/schemas/produtos_cupomfiscalincluir_FecharCaixa","IncluirCfeSat":"#/components/schemas/produtos_cupomfiscalincluir_IncluirCfeSat","IncluirCupom":"#/components/schemas/produtos_cupomfiscalincluir_IncluirCupom","IncluirNfce":"#/components/schemas/produtos_cupomfiscalincluir_IncluirNfce","IncluirRps":"#/components/schemas/produtos_cupomfiscalincluir_IncluirRps","InutilizarNfce":"#/components/schemas/produtos_cupomfiscalincluir_InutilizarNfce"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/produtos_cupomfiscalincluir_FecharCaixa_retorno"},{"$ref":"#/components/schemas/produtos_cupomfiscalincluir_IncluirCfeSat_retorno"},{"$ref":"#/components/schemas/produtos_cupomfiscalincluir_IncluirCupom_retorno"},{"$ref":"#/components/schemas/produtos_cupomfiscalincluir_IncluirNfce_retorno"},{"$ref":"#/components/schemas/produtos_cupomfiscalincluir_IncluirRps_retorno"},{"$ref":"#/components/schemas/produtos_cupomfiscalincluir_InutilizarNfce_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/devolucaovendafaturamento/":{"post":{"tags":["Produtos"],"summary":"Faturamento de Devolução de Venda","description":"Serviço **DevolucaoVendaFaturamento**. Operações (campo `call`): FaturarDevolucaoVenda · StatusDevolucaoVenda.","operationId":"produtos_devolucaovendafaturamento","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_devolucaovendafaturamento_FaturarDevolucaoVenda"},{"$ref":"#/components/schemas/produtos_devolucaovendafaturamento_StatusDevolucaoVenda"}],"discriminator":{"propertyName":"call","mapping":{"FaturarDevolucaoVenda":"#/components/schemas/produtos_devolucaovendafaturamento_FaturarDevolucaoVenda","StatusDevolucaoVenda":"#/components/schemas/produtos_devolucaovendafaturamento_StatusDevolucaoVenda"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/produtos_devolucaovendafaturamento_FaturarDevolucaoVenda_retorno"},{"$ref":"#/components/schemas/produtos_devolucaovendafaturamento_StatusDevolucaoVenda_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/dfedocs/":{"post":{"tags":["Produtos"],"summary":"Retorna informações do faturamento de produtos.","description":"Serviço **DfeDocs**. Operações (campo `call`): ObterCTe · ObterCupom · ObterDanfeSimp · ObterNfe · ObterPedVenda.","operationId":"produtos_dfedocs","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_dfedocs_ObterCTe"},{"$ref":"#/components/schemas/produtos_dfedocs_ObterCupom"},{"$ref":"#/components/schemas/produtos_dfedocs_ObterDanfeSimp"},{"$ref":"#/components/schemas/produtos_dfedocs_ObterNfe"},{"$ref":"#/components/schemas/produtos_dfedocs_ObterPedVenda"}],"discriminator":{"propertyName":"call","mapping":{"ObterCTe":"#/components/schemas/produtos_dfedocs_ObterCTe","ObterCupom":"#/components/schemas/produtos_dfedocs_ObterCupom","ObterDanfeSimp":"#/components/schemas/produtos_dfedocs_ObterDanfeSimp","ObterNfe":"#/components/schemas/produtos_dfedocs_ObterNfe","ObterPedVenda":"#/components/schemas/produtos_dfedocs_ObterPedVenda"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/produtos_dfedocs_ObterCTe_retorno"},{"$ref":"#/components/schemas/produtos_dfedocs_ObterCupom_retorno"},{"$ref":"#/components/schemas/produtos_dfedocs_ObterDanfeSimp_retorno"},{"$ref":"#/components/schemas/produtos_dfedocs_ObterNfe_retorno"},{"$ref":"#/components/schemas/produtos_dfedocs_ObterPedVenda_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/etapafat/":{"post":{"tags":["Produtos"],"summary":"Etapas do faturamento","description":"Serviço **EtapasFaturamento**. Operações (campo `call`): ListarEtapasFaturamento.","operationId":"produtos_etapafat","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_etapafat_ListarEtapasFaturamento"}],"discriminator":{"propertyName":"call","mapping":{"ListarEtapasFaturamento":"#/components/schemas/produtos_etapafat_ListarEtapasFaturamento"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/produtos_etapafat_ListarEtapasFaturamento_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/formaspagcompras/":{"post":{"tags":["Produtos"],"summary":"Formas de Pagamento de Compras","description":"Serviço **FormasPagCompras**. Operações (campo `call`): ListarFormasPagCompras.","operationId":"produtos_formaspagcompras","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_formaspagcompras_ListarFormasPagCompras"}],"discriminator":{"propertyName":"call","mapping":{"ListarFormasPagCompras":"#/components/schemas/produtos_formaspagcompras_ListarFormasPagCompras"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/produtos_formaspagcompras_ListarFormasPagCompras_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/formaspagvendas/":{"post":{"tags":["Produtos"],"summary":"Formas de Pagamento de Vendas","description":"Serviço **FormasPagVendas**. Operações (campo `call`): ListarFormasPagVendas.","operationId":"produtos_formaspagvendas","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_formaspagvendas_ListarFormasPagVendas"}],"discriminator":{"propertyName":"call","mapping":{"ListarFormasPagVendas":"#/components/schemas/produtos_formaspagvendas_ListarFormasPagVendas"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/produtos_formaspagvendas_ListarFormasPagVendas_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/frete-ecommerce/":{"post":{"tags":["Produtos"],"summary":"Vínculo de cotação de frete do e-commerce","description":"Serviço **FreteEcommerce**. Operações (campo `call`): VincularCotacao.","operationId":"produtos_freteecommerce","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_freteecommerce_VincularCotacao"}],"discriminator":{"propertyName":"call","mapping":{"VincularCotacao":"#/components/schemas/produtos_freteecommerce_VincularCotacao"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/produtos_freteecommerce_VincularCotacao_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/frete/":{"post":{"tags":["Produtos"],"summary":"Cotação, contratação e rastreio de frete","description":"Serviço **Frete**. Operações (campo `call`): CancelarCotacao · CotarFrete · GerarEtiqueta · GerarFrete · ListarStatusFrete · ObterRastreio · SelecionarFrete · StatusFrete · VincularFrete.","operationId":"produtos_frete","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_frete_CancelarCotacao"},{"$ref":"#/components/schemas/produtos_frete_CotarFrete"},{"$ref":"#/components/schemas/produtos_frete_GerarEtiqueta"},{"$ref":"#/components/schemas/produtos_frete_GerarFrete"},{"$ref":"#/components/schemas/produtos_frete_ListarStatusFrete"},{"$ref":"#/components/schemas/produtos_frete_ObterRastreio"},{"$ref":"#/components/schemas/produtos_frete_SelecionarFrete"},{"$ref":"#/components/schemas/produtos_frete_StatusFrete"},{"$ref":"#/components/schemas/produtos_frete_VincularFrete"}],"discriminator":{"propertyName":"call","mapping":{"CancelarCotacao":"#/components/schemas/produtos_frete_CancelarCotacao","CotarFrete":"#/components/schemas/produtos_frete_CotarFrete","GerarEtiqueta":"#/components/schemas/produtos_frete_GerarEtiqueta","GerarFrete":"#/components/schemas/produtos_frete_GerarFrete","ListarStatusFrete":"#/components/schemas/produtos_frete_ListarStatusFrete","ObterRastreio":"#/components/schemas/produtos_frete_ObterRastreio","SelecionarFrete":"#/components/schemas/produtos_frete_SelecionarFrete","StatusFrete":"#/components/schemas/produtos_frete_StatusFrete","VincularFrete":"#/components/schemas/produtos_frete_VincularFrete"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/produtos_frete_CancelarCotacao_retorno"},{"$ref":"#/components/schemas/produtos_frete_CotarFrete_retorno"},{"$ref":"#/components/schemas/produtos_frete_GerarEtiqueta_retorno"},{"$ref":"#/components/schemas/produtos_frete_GerarFrete_retorno"},{"$ref":"#/components/schemas/produtos_frete_ListarStatusFrete_retorno"},{"$ref":"#/components/schemas/produtos_frete_ObterRastreio_retorno"},{"$ref":"#/components/schemas/produtos_frete_SelecionarFrete_retorno"},{"$ref":"#/components/schemas/produtos_frete_StatusFrete_retorno"},{"$ref":"#/components/schemas/produtos_frete_VincularFrete_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/icbscst/":{"post":{"tags":["Produtos"],"summary":"API para retornar lista de cst's do IBS e CBS","description":"Serviço **IcbsCst**. Operações (campo `call`): ListarCSTIbsCbs.","operationId":"produtos_icbscst","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_icbscst_ListarCSTIbsCbs"}],"discriminator":{"propertyName":"call","mapping":{"ListarCSTIbsCbs":"#/components/schemas/produtos_icbscst_ListarCSTIbsCbs"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/produtos_icbscst_ListarCSTIbsCbs_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/icmscsosn/":{"post":{"tags":["Produtos"],"summary":"Listagem de CSOSN do ICMS.","description":"Serviço **icmsCSOSN**. Operações (campo `call`): ListarCSOSN.","operationId":"produtos_icmscsosn","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_icmscsosn_ListarCSOSN"}],"discriminator":{"propertyName":"call","mapping":{"ListarCSOSN":"#/components/schemas/produtos_icmscsosn_ListarCSOSN"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/produtos_icmscsosn_ListarCSOSN_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/icmscst/":{"post":{"tags":["Produtos"],"summary":"Listagem de CST do ICMS","description":"Serviço **icmsCST**. Operações (campo `call`): ListarCST.","operationId":"produtos_icmscst","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_icmscst_ListarCST"}],"discriminator":{"propertyName":"call","mapping":{"ListarCST":"#/components/schemas/produtos_icmscst_ListarCST"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/produtos_icmscst_ListarCST_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/icmsorigem/":{"post":{"tags":["Produtos"],"summary":"Listagem de Origem da Mercadoria do ICMS.","description":"Serviço **icmsOrigem**. Operações (campo `call`): ListarOrigMerc.","operationId":"produtos_icmsorigem","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_icmsorigem_ListarOrigMerc"}],"discriminator":{"propertyName":"call","mapping":{"ListarOrigMerc":"#/components/schemas/produtos_icmsorigem_ListarOrigMerc"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/produtos_icmsorigem_ListarOrigMerc_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/ipicst/":{"post":{"tags":["Produtos"],"summary":"Listagem de CST do IPI.","description":"Serviço **ipiCST**. Operações (campo `call`): ListarCstIpi.","operationId":"produtos_ipicst","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_ipicst_ListarCstIpi"}],"discriminator":{"propertyName":"call","mapping":{"ListarCstIpi":"#/components/schemas/produtos_ipicst_ListarCstIpi"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/produtos_ipicst_ListarCstIpi_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/ipienq/":{"post":{"tags":["Produtos"],"summary":"Listagem de Enquadramento do IPI.","description":"Serviço **ipiEnc**. Operações (campo `call`): ListarEnqIpi.","operationId":"produtos_ipienq","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_ipienq_ListarEnqIpi"}],"discriminator":{"propertyName":"call","mapping":{"ListarEnqIpi":"#/components/schemas/produtos_ipienq_ListarEnqIpi"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/produtos_ipienq_ListarEnqIpi_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/ncm/":{"post":{"tags":["Produtos"],"summary":"Listagem de NCM","description":"Serviço **NCM**. Operações (campo `call`): ConsultarNCM · ListarNCM.","operationId":"produtos_ncm","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_ncm_ConsultarNCM"},{"$ref":"#/components/schemas/produtos_ncm_ListarNCM"}],"discriminator":{"propertyName":"call","mapping":{"ConsultarNCM":"#/components/schemas/produtos_ncm_ConsultarNCM","ListarNCM":"#/components/schemas/produtos_ncm_ListarNCM"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/produtos_ncm_ConsultarNCM_retorno"},{"$ref":"#/components/schemas/produtos_ncm_ListarNCM_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/nf/":{"post":{"tags":["Produtos"],"summary":"Serviço para gerenciamento de Notas Fiscais Eletrônicas.","description":"Serviço **NotaFiscal**. Operações (campo `call`): NotaFiscalCancelar · NotaFiscalCartaCorrecao · NotaFiscalInutilizar · NotaFiscalStatus.","operationId":"produtos_nf","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_nf_NotaFiscalCancelar"},{"$ref":"#/components/schemas/produtos_nf_NotaFiscalCartaCorrecao"},{"$ref":"#/components/schemas/produtos_nf_NotaFiscalInutilizar"},{"$ref":"#/components/schemas/produtos_nf_NotaFiscalStatus"}],"discriminator":{"propertyName":"call","mapping":{"NotaFiscalCancelar":"#/components/schemas/produtos_nf_NotaFiscalCancelar","NotaFiscalCartaCorrecao":"#/components/schemas/produtos_nf_NotaFiscalCartaCorrecao","NotaFiscalInutilizar":"#/components/schemas/produtos_nf_NotaFiscalInutilizar","NotaFiscalStatus":"#/components/schemas/produtos_nf_NotaFiscalStatus"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/produtos_nf_NotaFiscalCancelar_retorno"},{"$ref":"#/components/schemas/produtos_nf_NotaFiscalCartaCorrecao_retorno"},{"$ref":"#/components/schemas/produtos_nf_NotaFiscalInutilizar_retorno"},{"$ref":"#/components/schemas/produtos_nf_NotaFiscalStatus_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/nfce/":{"post":{"tags":["Produtos"],"summary":"Rotinas de importação de NFC-e.","description":"Serviço **nfce**. Operações (campo `call`): ImportarNFCe.","operationId":"produtos_nfce","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_nfce_ImportarNFCe"}],"discriminator":{"propertyName":"call","mapping":{"ImportarNFCe":"#/components/schemas/produtos_nfce_ImportarNFCe"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/produtos_nfce_ImportarNFCe_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/nfconsultar/":{"post":{"tags":["Produtos"],"summary":"Realiza as consultas na Nota Fiscal.","description":"Serviço **NFConsultar**. Operações (campo `call`): ConsultarNF · ListarNF.","operationId":"produtos_nfconsultar","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_nfconsultar_ConsultarNF"},{"$ref":"#/components/schemas/produtos_nfconsultar_ListarNF"}],"discriminator":{"propertyName":"call","mapping":{"ConsultarNF":"#/components/schemas/produtos_nfconsultar_ConsultarNF","ListarNF":"#/components/schemas/produtos_nfconsultar_ListarNF"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/produtos_nfconsultar_ConsultarNF_retorno"},{"$ref":"#/components/schemas/produtos_nfconsultar_ListarNF_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/nfe/":{"post":{"tags":["Produtos"],"summary":"Rotinas de Importação de NF-e.","description":"Serviço **nfe**. Operações (campo `call`): ExcluirNFe · ImportarCancNFe · ImportarNFe · ListarNFe.","operationId":"produtos_nfe","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_nfe_ExcluirNFe"},{"$ref":"#/components/schemas/produtos_nfe_ImportarCancNFe"},{"$ref":"#/components/schemas/produtos_nfe_ImportarNFe"},{"$ref":"#/components/schemas/produtos_nfe_ListarNFe"}],"discriminator":{"propertyName":"call","mapping":{"ExcluirNFe":"#/components/schemas/produtos_nfe_ExcluirNFe","ImportarCancNFe":"#/components/schemas/produtos_nfe_ImportarCancNFe","ImportarNFe":"#/components/schemas/produtos_nfe_ImportarNFe","ListarNFe":"#/components/schemas/produtos_nfe_ListarNFe"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/produtos_nfe_ExcluirNFe_retorno"},{"$ref":"#/components/schemas/produtos_nfe_ImportarCancNFe_retorno"},{"$ref":"#/components/schemas/produtos_nfe_ImportarNFe_retorno"},{"$ref":"#/components/schemas/produtos_nfe_ListarNFe_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/notaentrada/":{"post":{"tags":["Produtos"],"summary":"Entrada de produtos","description":"Serviço **NotaEntrada**. Operações (campo `call`): AlterarNotaEnt · ConsultarNotaEnt · ExcluirNotaEnt · IncluirNotaEnt · ListarNotaEnt · StatusNotaEnt.","operationId":"produtos_notaentrada","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_notaentrada_AlterarNotaEnt"},{"$ref":"#/components/schemas/produtos_notaentrada_ConsultarNotaEnt"},{"$ref":"#/components/schemas/produtos_notaentrada_ExcluirNotaEnt"},{"$ref":"#/components/schemas/produtos_notaentrada_IncluirNotaEnt"},{"$ref":"#/components/schemas/produtos_notaentrada_ListarNotaEnt"},{"$ref":"#/components/schemas/produtos_notaentrada_StatusNotaEnt"}],"discriminator":{"propertyName":"call","mapping":{"AlterarNotaEnt":"#/components/schemas/produtos_notaentrada_AlterarNotaEnt","ConsultarNotaEnt":"#/components/schemas/produtos_notaentrada_ConsultarNotaEnt","ExcluirNotaEnt":"#/components/schemas/produtos_notaentrada_ExcluirNotaEnt","IncluirNotaEnt":"#/components/schemas/produtos_notaentrada_IncluirNotaEnt","ListarNotaEnt":"#/components/schemas/produtos_notaentrada_ListarNotaEnt","StatusNotaEnt":"#/components/schemas/produtos_notaentrada_StatusNotaEnt"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/produtos_notaentrada_AlterarNotaEnt_retorno"},{"$ref":"#/components/schemas/produtos_notaentrada_ConsultarNotaEnt_retorno"},{"$ref":"#/components/schemas/produtos_notaentrada_ExcluirNotaEnt_retorno"},{"$ref":"#/components/schemas/produtos_notaentrada_IncluirNotaEnt_retorno"},{"$ref":"#/components/schemas/produtos_notaentrada_ListarNotaEnt_retorno"},{"$ref":"#/components/schemas/produtos_notaentrada_StatusNotaEnt_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/notaentradafat/":{"post":{"tags":["Produtos"],"summary":"Entrada de produtos - Faturamento","description":"Serviço **NotaEntradaFaturamento**. Operações (campo `call`): CancelarNotaEnt · ConcluirNotaEnt · ConferirNotaEnt · DuplicarNotaEnt.","operationId":"produtos_notaentradafat","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_notaentradafat_CancelarNotaEnt"},{"$ref":"#/components/schemas/produtos_notaentradafat_ConcluirNotaEnt"},{"$ref":"#/components/schemas/produtos_notaentradafat_ConferirNotaEnt"},{"$ref":"#/components/schemas/produtos_notaentradafat_DuplicarNotaEnt"}],"discriminator":{"propertyName":"call","mapping":{"CancelarNotaEnt":"#/components/schemas/produtos_notaentradafat_CancelarNotaEnt","ConcluirNotaEnt":"#/components/schemas/produtos_notaentradafat_ConcluirNotaEnt","ConferirNotaEnt":"#/components/schemas/produtos_notaentradafat_ConferirNotaEnt","DuplicarNotaEnt":"#/components/schemas/produtos_notaentradafat_DuplicarNotaEnt"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/produtos_notaentradafat_CancelarNotaEnt_retorno"},{"$ref":"#/components/schemas/produtos_notaentradafat_ConcluirNotaEnt_retorno"},{"$ref":"#/components/schemas/produtos_notaentradafat_ConferirNotaEnt_retorno"},{"$ref":"#/components/schemas/produtos_notaentradafat_DuplicarNotaEnt_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/notafiscalutil/":{"post":{"tags":["Produtos"],"summary":"Utilitários da Nota Fiscal","description":"Serviço **NotaFiscalUtil**. Operações (campo `call`): GetUrlDanfe · GetUrlLogo · GetUrlNotaFiscal.","operationId":"produtos_notafiscalutil","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_notafiscalutil_GetUrlDanfe"},{"$ref":"#/components/schemas/produtos_notafiscalutil_GetUrlLogo"},{"$ref":"#/components/schemas/produtos_notafiscalutil_GetUrlNotaFiscal"}],"discriminator":{"propertyName":"call","mapping":{"GetUrlDanfe":"#/components/schemas/produtos_notafiscalutil_GetUrlDanfe","GetUrlLogo":"#/components/schemas/produtos_notafiscalutil_GetUrlLogo","GetUrlNotaFiscal":"#/components/schemas/produtos_notafiscalutil_GetUrlNotaFiscal"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/produtos_notafiscalutil_GetUrlDanfe_retorno"},{"$ref":"#/components/schemas/produtos_notafiscalutil_GetUrlLogo_retorno"},{"$ref":"#/components/schemas/produtos_notafiscalutil_GetUrlNotaFiscal_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/op/":{"post":{"tags":["Produtos"],"summary":"Ordem de Produção","description":"Serviço **OrdemProducao**. Operações (campo `call`): AlterarOrdemProducao · ConcluirOrdemProducao · ConsultarOrdemProducao · ExcluirOrdemProducao · IncluirOrdemProducao · ListarOrdemProducao · ReverterOrdemProducao · UpsertOrdemProducao.","operationId":"produtos_op","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_op_AlterarOrdemProducao"},{"$ref":"#/components/schemas/produtos_op_ConcluirOrdemProducao"},{"$ref":"#/components/schemas/produtos_op_ConsultarOrdemProducao"},{"$ref":"#/components/schemas/produtos_op_ExcluirOrdemProducao"},{"$ref":"#/components/schemas/produtos_op_IncluirOrdemProducao"},{"$ref":"#/components/schemas/produtos_op_ListarOrdemProducao"},{"$ref":"#/components/schemas/produtos_op_ReverterOrdemProducao"},{"$ref":"#/components/schemas/produtos_op_UpsertOrdemProducao"}],"discriminator":{"propertyName":"call","mapping":{"AlterarOrdemProducao":"#/components/schemas/produtos_op_AlterarOrdemProducao","ConcluirOrdemProducao":"#/components/schemas/produtos_op_ConcluirOrdemProducao","ConsultarOrdemProducao":"#/components/schemas/produtos_op_ConsultarOrdemProducao","ExcluirOrdemProducao":"#/components/schemas/produtos_op_ExcluirOrdemProducao","IncluirOrdemProducao":"#/components/schemas/produtos_op_IncluirOrdemProducao","ListarOrdemProducao":"#/components/schemas/produtos_op_ListarOrdemProducao","ReverterOrdemProducao":"#/components/schemas/produtos_op_ReverterOrdemProducao","UpsertOrdemProducao":"#/components/schemas/produtos_op_UpsertOrdemProducao"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/produtos_op_AlterarOrdemProducao_retorno"},{"$ref":"#/components/schemas/produtos_op_ConcluirOrdemProducao_retorno"},{"$ref":"#/components/schemas/produtos_op_ConsultarOrdemProducao_retorno"},{"$ref":"#/components/schemas/produtos_op_ExcluirOrdemProducao_retorno"},{"$ref":"#/components/schemas/produtos_op_IncluirOrdemProducao_retorno"},{"$ref":"#/components/schemas/produtos_op_ListarOrdemProducao_retorno"},{"$ref":"#/components/schemas/produtos_op_ReverterOrdemProducao_retorno"},{"$ref":"#/components/schemas/produtos_op_UpsertOrdemProducao_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/pdvcadastros/":{"post":{"tags":["Produtos"],"summary":"Cadastros do PDV.","description":"Serviço **PDVCadastros**. Operações (campo `call`): ListarExcluidos · ListarTitulosExcluidos.","operationId":"produtos_pdvcadastros","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_pdvcadastros_ListarExcluidos"},{"$ref":"#/components/schemas/produtos_pdvcadastros_ListarTitulosExcluidos"}],"discriminator":{"propertyName":"call","mapping":{"ListarExcluidos":"#/components/schemas/produtos_pdvcadastros_ListarExcluidos","ListarTitulosExcluidos":"#/components/schemas/produtos_pdvcadastros_ListarTitulosExcluidos"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/produtos_pdvcadastros_ListarExcluidos_retorno"},{"$ref":"#/components/schemas/produtos_pdvcadastros_ListarTitulosExcluidos_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/pedido/":{"post":{"tags":["Produtos"],"summary":"Pedido de Vendas de Produtos","description":"Serviço **PedidoVendaProduto**. Operações (campo `call`): AlterarPedFaturado · AlterarPedidoVenda · ConsultarPedido · DevolverPedido · ExcluirPedido · IncluirPedido · ListarPedidos · SimularImpostos · StatusPedido · TrocarEtapaPedido.","operationId":"produtos_pedido","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_pedido_AlterarPedFaturado"},{"$ref":"#/components/schemas/produtos_pedido_AlterarPedidoVenda"},{"$ref":"#/components/schemas/produtos_pedido_ConsultarPedido"},{"$ref":"#/components/schemas/produtos_pedido_DevolverPedido"},{"$ref":"#/components/schemas/produtos_pedido_ExcluirPedido"},{"$ref":"#/components/schemas/produtos_pedido_IncluirPedido"},{"$ref":"#/components/schemas/produtos_pedido_ListarPedidos"},{"$ref":"#/components/schemas/produtos_pedido_SimularImpostos"},{"$ref":"#/components/schemas/produtos_pedido_StatusPedido"},{"$ref":"#/components/schemas/produtos_pedido_TrocarEtapaPedido"}],"discriminator":{"propertyName":"call","mapping":{"AlterarPedFaturado":"#/components/schemas/produtos_pedido_AlterarPedFaturado","AlterarPedidoVenda":"#/components/schemas/produtos_pedido_AlterarPedidoVenda","ConsultarPedido":"#/components/schemas/produtos_pedido_ConsultarPedido","DevolverPedido":"#/components/schemas/produtos_pedido_DevolverPedido","ExcluirPedido":"#/components/schemas/produtos_pedido_ExcluirPedido","IncluirPedido":"#/components/schemas/produtos_pedido_IncluirPedido","ListarPedidos":"#/components/schemas/produtos_pedido_ListarPedidos","SimularImpostos":"#/components/schemas/produtos_pedido_SimularImpostos","StatusPedido":"#/components/schemas/produtos_pedido_StatusPedido","TrocarEtapaPedido":"#/components/schemas/produtos_pedido_TrocarEtapaPedido"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/produtos_pedido_AlterarPedFaturado_retorno"},{"$ref":"#/components/schemas/produtos_pedido_AlterarPedidoVenda_retorno"},{"$ref":"#/components/schemas/produtos_pedido_ConsultarPedido_retorno"},{"$ref":"#/components/schemas/produtos_pedido_DevolverPedido_retorno"},{"$ref":"#/components/schemas/produtos_pedido_ExcluirPedido_retorno"},{"$ref":"#/components/schemas/produtos_pedido_IncluirPedido_retorno"},{"$ref":"#/components/schemas/produtos_pedido_ListarPedidos_retorno"},{"$ref":"#/components/schemas/produtos_pedido_SimularImpostos_retorno"},{"$ref":"#/components/schemas/produtos_pedido_StatusPedido_retorno"},{"$ref":"#/components/schemas/produtos_pedido_TrocarEtapaPedido_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/pedidocompra/":{"post":{"tags":["Produtos"],"summary":"Pedidos de Compra","description":"Serviço **PedidoCompra**. Operações (campo `call`): AlteraPedCompra · ConsultarPedCompra · EncerraPedCompra · ExcluirPedCompra · IncluirPedCompra · ListarMotivosEncerramento · PesquisarPedCompra · UpsertPedCompra.","operationId":"produtos_pedidocompra","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_pedidocompra_AlteraPedCompra"},{"$ref":"#/components/schemas/produtos_pedidocompra_ConsultarPedCompra"},{"$ref":"#/components/schemas/produtos_pedidocompra_EncerraPedCompra"},{"$ref":"#/components/schemas/produtos_pedidocompra_ExcluirPedCompra"},{"$ref":"#/components/schemas/produtos_pedidocompra_IncluirPedCompra"},{"$ref":"#/components/schemas/produtos_pedidocompra_ListarMotivosEncerramento"},{"$ref":"#/components/schemas/produtos_pedidocompra_PesquisarPedCompra"},{"$ref":"#/components/schemas/produtos_pedidocompra_UpsertPedCompra"}],"discriminator":{"propertyName":"call","mapping":{"AlteraPedCompra":"#/components/schemas/produtos_pedidocompra_AlteraPedCompra","ConsultarPedCompra":"#/components/schemas/produtos_pedidocompra_ConsultarPedCompra","EncerraPedCompra":"#/components/schemas/produtos_pedidocompra_EncerraPedCompra","ExcluirPedCompra":"#/components/schemas/produtos_pedidocompra_ExcluirPedCompra","IncluirPedCompra":"#/components/schemas/produtos_pedidocompra_IncluirPedCompra","ListarMotivosEncerramento":"#/components/schemas/produtos_pedidocompra_ListarMotivosEncerramento","PesquisarPedCompra":"#/components/schemas/produtos_pedidocompra_PesquisarPedCompra","UpsertPedCompra":"#/components/schemas/produtos_pedidocompra_UpsertPedCompra"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/produtos_pedidocompra_AlteraPedCompra_retorno"},{"$ref":"#/components/schemas/produtos_pedidocompra_ConsultarPedCompra_retorno"},{"$ref":"#/components/schemas/produtos_pedidocompra_EncerraPedCompra_retorno"},{"$ref":"#/components/schemas/produtos_pedidocompra_ExcluirPedCompra_retorno"},{"$ref":"#/components/schemas/produtos_pedidocompra_IncluirPedCompra_retorno"},{"$ref":"#/components/schemas/produtos_pedidocompra_ListarMotivosEncerramento_retorno"},{"$ref":"#/components/schemas/produtos_pedidocompra_PesquisarPedCompra_retorno"},{"$ref":"#/components/schemas/produtos_pedidocompra_UpsertPedCompra_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/pedidoetapas/":{"post":{"tags":["Produtos"],"summary":"Etapas do processo de vendas de produtos.","description":"Serviço **PedidoVendaEtapa**. Operações (campo `call`): ListarEtapasPedido.","operationId":"produtos_pedidoetapas","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_pedidoetapas_ListarEtapasPedido"}],"discriminator":{"propertyName":"call","mapping":{"ListarEtapasPedido":"#/components/schemas/produtos_pedidoetapas_ListarEtapasPedido"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/produtos_pedidoetapas_ListarEtapasPedido_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/pedidovenda/":{"post":{"tags":["Produtos"],"summary":"API de pedido de venda — criação de pedidos e gerenciamento de itens.","description":"Serviço **PedidoVenda**. Operações (campo `call`): AdicionarPedido · AlterarItemPedido · ExcluirItemPedido · ExcluirItensPedido · IncluirItemPedido · TotalizarPedido.","operationId":"produtos_pedidovenda","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_pedidovenda_AdicionarPedido"},{"$ref":"#/components/schemas/produtos_pedidovenda_AlterarItemPedido"},{"$ref":"#/components/schemas/produtos_pedidovenda_ExcluirItemPedido"},{"$ref":"#/components/schemas/produtos_pedidovenda_ExcluirItensPedido"},{"$ref":"#/components/schemas/produtos_pedidovenda_IncluirItemPedido"},{"$ref":"#/components/schemas/produtos_pedidovenda_TotalizarPedido"}],"discriminator":{"propertyName":"call","mapping":{"AdicionarPedido":"#/components/schemas/produtos_pedidovenda_AdicionarPedido","AlterarItemPedido":"#/components/schemas/produtos_pedidovenda_AlterarItemPedido","ExcluirItemPedido":"#/components/schemas/produtos_pedidovenda_ExcluirItemPedido","ExcluirItensPedido":"#/components/schemas/produtos_pedidovenda_ExcluirItensPedido","IncluirItemPedido":"#/components/schemas/produtos_pedidovenda_IncluirItemPedido","TotalizarPedido":"#/components/schemas/produtos_pedidovenda_TotalizarPedido"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/produtos_pedidovenda_AdicionarPedido_retorno"},{"$ref":"#/components/schemas/produtos_pedidovenda_AlterarItemPedido_retorno"},{"$ref":"#/components/schemas/produtos_pedidovenda_ExcluirItemPedido_retorno"},{"$ref":"#/components/schemas/produtos_pedidovenda_ExcluirItensPedido_retorno"},{"$ref":"#/components/schemas/produtos_pedidovenda_IncluirItemPedido_retorno"},{"$ref":"#/components/schemas/produtos_pedidovenda_TotalizarPedido_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/pedidovendaanexos/":{"post":{"tags":["Produtos"],"summary":"Anexos do Pedido de Vendas","description":"Serviço **PedidoVendaAnexos**. Operações (campo `call`): pvaConsultarAnexo · pvaExcluirAnexo · pvaIncluirAnexo · pvaListarAnexos · pvaObterAnexo.","operationId":"produtos_pedidovendaanexos","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_pedidovendaanexos_pvaConsultarAnexo"},{"$ref":"#/components/schemas/produtos_pedidovendaanexos_pvaExcluirAnexo"},{"$ref":"#/components/schemas/produtos_pedidovendaanexos_pvaIncluirAnexo"},{"$ref":"#/components/schemas/produtos_pedidovendaanexos_pvaListarAnexos"},{"$ref":"#/components/schemas/produtos_pedidovendaanexos_pvaObterAnexo"}],"discriminator":{"propertyName":"call","mapping":{"pvaConsultarAnexo":"#/components/schemas/produtos_pedidovendaanexos_pvaConsultarAnexo","pvaExcluirAnexo":"#/components/schemas/produtos_pedidovendaanexos_pvaExcluirAnexo","pvaIncluirAnexo":"#/components/schemas/produtos_pedidovendaanexos_pvaIncluirAnexo","pvaListarAnexos":"#/components/schemas/produtos_pedidovendaanexos_pvaListarAnexos","pvaObterAnexo":"#/components/schemas/produtos_pedidovendaanexos_pvaObterAnexo"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/produtos_pedidovendaanexos_pvaConsultarAnexo_retorno"},{"$ref":"#/components/schemas/produtos_pedidovendaanexos_pvaExcluirAnexo_retorno"},{"$ref":"#/components/schemas/produtos_pedidovendaanexos_pvaIncluirAnexo_retorno"},{"$ref":"#/components/schemas/produtos_pedidovendaanexos_pvaListarAnexos_retorno"},{"$ref":"#/components/schemas/produtos_pedidovendaanexos_pvaObterAnexo_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/pedidovendafat/":{"post":{"tags":["Produtos"],"summary":"Opções de faturamento do Pedido de Venda.","description":"Serviço **PedidoVendaFaturamento**. Operações (campo `call`): AssociarCodIntPedidoVenda · CancelarPedidoVenda · DuplicarPedidoVenda · FaturarPedidoVenda · ObterPedidosVenda · ValidarPedidoVenda.","operationId":"produtos_pedidovendafat","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_pedidovendafat_AssociarCodIntPedidoVenda"},{"$ref":"#/components/schemas/produtos_pedidovendafat_CancelarPedidoVenda"},{"$ref":"#/components/schemas/produtos_pedidovendafat_DuplicarPedidoVenda"},{"$ref":"#/components/schemas/produtos_pedidovendafat_FaturarPedidoVenda"},{"$ref":"#/components/schemas/produtos_pedidovendafat_ObterPedidosVenda"},{"$ref":"#/components/schemas/produtos_pedidovendafat_ValidarPedidoVenda"}],"discriminator":{"propertyName":"call","mapping":{"AssociarCodIntPedidoVenda":"#/components/schemas/produtos_pedidovendafat_AssociarCodIntPedidoVenda","CancelarPedidoVenda":"#/components/schemas/produtos_pedidovendafat_CancelarPedidoVenda","DuplicarPedidoVenda":"#/components/schemas/produtos_pedidovendafat_DuplicarPedidoVenda","FaturarPedidoVenda":"#/components/schemas/produtos_pedidovendafat_FaturarPedidoVenda","ObterPedidosVenda":"#/components/schemas/produtos_pedidovendafat_ObterPedidosVenda","ValidarPedidoVenda":"#/components/schemas/produtos_pedidovendafat_ValidarPedidoVenda"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/produtos_pedidovendafat_AssociarCodIntPedidoVenda_retorno"},{"$ref":"#/components/schemas/produtos_pedidovendafat_CancelarPedidoVenda_retorno"},{"$ref":"#/components/schemas/produtos_pedidovendafat_DuplicarPedidoVenda_retorno"},{"$ref":"#/components/schemas/produtos_pedidovendafat_FaturarPedidoVenda_retorno"},{"$ref":"#/components/schemas/produtos_pedidovendafat_ObterPedidosVenda_retorno"},{"$ref":"#/components/schemas/produtos_pedidovendafat_ValidarPedidoVenda_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/piscst/":{"post":{"tags":["Produtos"],"summary":"Listagem de CST do PIS.","description":"Serviço **pisCST**. Operações (campo `call`): ListarCstPis.","operationId":"produtos_piscst","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_piscst_ListarCstPis"}],"discriminator":{"propertyName":"call","mapping":{"ListarCstPis":"#/components/schemas/produtos_piscst_ListarCstPis"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/produtos_piscst_ListarCstPis_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/produtoslote/":{"post":{"tags":["Produtos"],"summary":"Operação relacionada a lotes de produtos.","description":"Serviço **ProdutosLote**. Operações (campo `call`): ConsultarLote · ListarLotes.","operationId":"produtos_produtoslote","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_produtoslote_ConsultarLote"},{"$ref":"#/components/schemas/produtos_produtoslote_ListarLotes"}],"discriminator":{"propertyName":"call","mapping":{"ConsultarLote":"#/components/schemas/produtos_produtoslote_ConsultarLote","ListarLotes":"#/components/schemas/produtos_produtoslote_ListarLotes"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/produtos_produtoslote_ConsultarLote_retorno"},{"$ref":"#/components/schemas/produtos_produtoslote_ListarLotes_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/recebimentonfe/":{"post":{"tags":["Produtos"],"summary":"Gerenciamento dos recebimentos de NF-e de produtos, incluindo conclusão, reversão, alteração de etapas, edição de itens,","description":"Serviço **RecebimentoNFe**. Operações (campo `call`): AlterarEtapaRecebimento · AlterarRecebimento · AlterarRecebimentoConcluido · ConcluirRecebimento · ConsultarRecebimento · ExcluirRecebimento · ListarRecebimentos · ReverterRecebimento.","operationId":"produtos_recebimentonfe","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_recebimentonfe_AlterarEtapaRecebimento"},{"$ref":"#/components/schemas/produtos_recebimentonfe_AlterarRecebimento"},{"$ref":"#/components/schemas/produtos_recebimentonfe_AlterarRecebimentoConcluido"},{"$ref":"#/components/schemas/produtos_recebimentonfe_ConcluirRecebimento"},{"$ref":"#/components/schemas/produtos_recebimentonfe_ConsultarRecebimento"},{"$ref":"#/components/schemas/produtos_recebimentonfe_ExcluirRecebimento"},{"$ref":"#/components/schemas/produtos_recebimentonfe_ListarRecebimentos"},{"$ref":"#/components/schemas/produtos_recebimentonfe_ReverterRecebimento"}],"discriminator":{"propertyName":"call","mapping":{"AlterarEtapaRecebimento":"#/components/schemas/produtos_recebimentonfe_AlterarEtapaRecebimento","AlterarRecebimento":"#/components/schemas/produtos_recebimentonfe_AlterarRecebimento","AlterarRecebimentoConcluido":"#/components/schemas/produtos_recebimentonfe_AlterarRecebimentoConcluido","ConcluirRecebimento":"#/components/schemas/produtos_recebimentonfe_ConcluirRecebimento","ConsultarRecebimento":"#/components/schemas/produtos_recebimentonfe_ConsultarRecebimento","ExcluirRecebimento":"#/components/schemas/produtos_recebimentonfe_ExcluirRecebimento","ListarRecebimentos":"#/components/schemas/produtos_recebimentonfe_ListarRecebimentos","ReverterRecebimento":"#/components/schemas/produtos_recebimentonfe_ReverterRecebimento"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/produtos_recebimentonfe_AlterarEtapaRecebimento_retorno"},{"$ref":"#/components/schemas/produtos_recebimentonfe_AlterarRecebimento_retorno"},{"$ref":"#/components/schemas/produtos_recebimentonfe_AlterarRecebimentoConcluido_retorno"},{"$ref":"#/components/schemas/produtos_recebimentonfe_ConcluirRecebimento_retorno"},{"$ref":"#/components/schemas/produtos_recebimentonfe_ConsultarRecebimento_retorno"},{"$ref":"#/components/schemas/produtos_recebimentonfe_ExcluirRecebimento_retorno"},{"$ref":"#/components/schemas/produtos_recebimentonfe_ListarRecebimentos_retorno"},{"$ref":"#/components/schemas/produtos_recebimentonfe_ReverterRecebimento_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/remessa/":{"post":{"tags":["Produtos"],"summary":"Remessa de Produtos","description":"Serviço **RemessaProduto**. Operações (campo `call`): AlterarRemessa · ConsultarRemessa · DevolverRemessa · IncluirRemessa · ListarRemessas · StatusRemessa.","operationId":"produtos_remessa","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_remessa_AlterarRemessa"},{"$ref":"#/components/schemas/produtos_remessa_ConsultarRemessa"},{"$ref":"#/components/schemas/produtos_remessa_DevolverRemessa"},{"$ref":"#/components/schemas/produtos_remessa_IncluirRemessa"},{"$ref":"#/components/schemas/produtos_remessa_ListarRemessas"},{"$ref":"#/components/schemas/produtos_remessa_StatusRemessa"}],"discriminator":{"propertyName":"call","mapping":{"AlterarRemessa":"#/components/schemas/produtos_remessa_AlterarRemessa","ConsultarRemessa":"#/components/schemas/produtos_remessa_ConsultarRemessa","DevolverRemessa":"#/components/schemas/produtos_remessa_DevolverRemessa","IncluirRemessa":"#/components/schemas/produtos_remessa_IncluirRemessa","ListarRemessas":"#/components/schemas/produtos_remessa_ListarRemessas","StatusRemessa":"#/components/schemas/produtos_remessa_StatusRemessa"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/produtos_remessa_AlterarRemessa_retorno"},{"$ref":"#/components/schemas/produtos_remessa_ConsultarRemessa_retorno"},{"$ref":"#/components/schemas/produtos_remessa_DevolverRemessa_retorno"},{"$ref":"#/components/schemas/produtos_remessa_IncluirRemessa_retorno"},{"$ref":"#/components/schemas/produtos_remessa_ListarRemessas_retorno"},{"$ref":"#/components/schemas/produtos_remessa_StatusRemessa_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/remessafat/":{"post":{"tags":["Produtos"],"summary":"Opções de Faturamento de Remessa de Produtos","description":"Serviço **RemessaProdutoFaturamento**. Operações (campo `call`): CancelarRemessa · ConcluirRemessa · ConferirRemessa · DuplicarRemessa.","operationId":"produtos_remessafat","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_remessafat_CancelarRemessa"},{"$ref":"#/components/schemas/produtos_remessafat_ConcluirRemessa"},{"$ref":"#/components/schemas/produtos_remessafat_ConferirRemessa"},{"$ref":"#/components/schemas/produtos_remessafat_DuplicarRemessa"}],"discriminator":{"propertyName":"call","mapping":{"CancelarRemessa":"#/components/schemas/produtos_remessafat_CancelarRemessa","ConcluirRemessa":"#/components/schemas/produtos_remessafat_ConcluirRemessa","ConferirRemessa":"#/components/schemas/produtos_remessafat_ConferirRemessa","DuplicarRemessa":"#/components/schemas/produtos_remessafat_DuplicarRemessa"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/produtos_remessafat_CancelarRemessa_retorno"},{"$ref":"#/components/schemas/produtos_remessafat_ConcluirRemessa_retorno"},{"$ref":"#/components/schemas/produtos_remessafat_ConferirRemessa_retorno"},{"$ref":"#/components/schemas/produtos_remessafat_DuplicarRemessa_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/requisicaocompra/":{"post":{"tags":["Produtos"],"summary":"Requisição de Compras","description":"Serviço **RequisicaoCompra**. Operações (campo `call`): AlterarReq · ConsultarReq · ExcluirReq · IncluirReq · PesquisarReq · UpsertReq.","operationId":"produtos_requisicaocompra","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_requisicaocompra_AlterarReq"},{"$ref":"#/components/schemas/produtos_requisicaocompra_ConsultarReq"},{"$ref":"#/components/schemas/produtos_requisicaocompra_ExcluirReq"},{"$ref":"#/components/schemas/produtos_requisicaocompra_IncluirReq"},{"$ref":"#/components/schemas/produtos_requisicaocompra_PesquisarReq"},{"$ref":"#/components/schemas/produtos_requisicaocompra_UpsertReq"}],"discriminator":{"propertyName":"call","mapping":{"AlterarReq":"#/components/schemas/produtos_requisicaocompra_AlterarReq","ConsultarReq":"#/components/schemas/produtos_requisicaocompra_ConsultarReq","ExcluirReq":"#/components/schemas/produtos_requisicaocompra_ExcluirReq","IncluirReq":"#/components/schemas/produtos_requisicaocompra_IncluirReq","PesquisarReq":"#/components/schemas/produtos_requisicaocompra_PesquisarReq","UpsertReq":"#/components/schemas/produtos_requisicaocompra_UpsertReq"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/produtos_requisicaocompra_AlterarReq_retorno"},{"$ref":"#/components/schemas/produtos_requisicaocompra_ConsultarReq_retorno"},{"$ref":"#/components/schemas/produtos_requisicaocompra_ExcluirReq_retorno"},{"$ref":"#/components/schemas/produtos_requisicaocompra_IncluirReq_retorno"},{"$ref":"#/components/schemas/produtos_requisicaocompra_PesquisarReq_retorno"},{"$ref":"#/components/schemas/produtos_requisicaocompra_UpsertReq_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/sat/":{"post":{"tags":["Produtos"],"summary":"Rotinas de importação de CF-e SAT.","description":"Serviço **sat**. Operações (campo `call`): ImportarCfeSat.","operationId":"produtos_sat","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_sat_ImportarCfeSat"}],"discriminator":{"propertyName":"call","mapping":{"ImportarCfeSat":"#/components/schemas/produtos_sat_ImportarCfeSat"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/produtos_sat_ImportarCfeSat_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/tabelaprecos/":{"post":{"tags":["Produtos"],"summary":"Tabela de Preços","description":"Serviço **TabelaPrecos**. Operações (campo `call`): AlterarPrecoItem · AlterarTabelaPreco · AtivarTabelaPreco · AtualizarProdutos · ConsultarTabelaPreco · ExcluirTabelaPreco · IncluirTabelaPreco · ListarTabelaItens · ListarTabelasPreco · SuspenderTabelaPreco.","operationId":"produtos_tabelaprecos","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_tabelaprecos_AlterarPrecoItem"},{"$ref":"#/components/schemas/produtos_tabelaprecos_AlterarTabelaPreco"},{"$ref":"#/components/schemas/produtos_tabelaprecos_AtivarTabelaPreco"},{"$ref":"#/components/schemas/produtos_tabelaprecos_AtualizarProdutos"},{"$ref":"#/components/schemas/produtos_tabelaprecos_ConsultarTabelaPreco"},{"$ref":"#/components/schemas/produtos_tabelaprecos_ExcluirTabelaPreco"},{"$ref":"#/components/schemas/produtos_tabelaprecos_IncluirTabelaPreco"},{"$ref":"#/components/schemas/produtos_tabelaprecos_ListarTabelaItens"},{"$ref":"#/components/schemas/produtos_tabelaprecos_ListarTabelasPreco"},{"$ref":"#/components/schemas/produtos_tabelaprecos_SuspenderTabelaPreco"}],"discriminator":{"propertyName":"call","mapping":{"AlterarPrecoItem":"#/components/schemas/produtos_tabelaprecos_AlterarPrecoItem","AlterarTabelaPreco":"#/components/schemas/produtos_tabelaprecos_AlterarTabelaPreco","AtivarTabelaPreco":"#/components/schemas/produtos_tabelaprecos_AtivarTabelaPreco","AtualizarProdutos":"#/components/schemas/produtos_tabelaprecos_AtualizarProdutos","ConsultarTabelaPreco":"#/components/schemas/produtos_tabelaprecos_ConsultarTabelaPreco","ExcluirTabelaPreco":"#/components/schemas/produtos_tabelaprecos_ExcluirTabelaPreco","IncluirTabelaPreco":"#/components/schemas/produtos_tabelaprecos_IncluirTabelaPreco","ListarTabelaItens":"#/components/schemas/produtos_tabelaprecos_ListarTabelaItens","ListarTabelasPreco":"#/components/schemas/produtos_tabelaprecos_ListarTabelasPreco","SuspenderTabelaPreco":"#/components/schemas/produtos_tabelaprecos_SuspenderTabelaPreco"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/produtos_tabelaprecos_AlterarPrecoItem_retorno"},{"$ref":"#/components/schemas/produtos_tabelaprecos_AlterarTabelaPreco_retorno"},{"$ref":"#/components/schemas/produtos_tabelaprecos_AtivarTabelaPreco_retorno"},{"$ref":"#/components/schemas/produtos_tabelaprecos_AtualizarProdutos_retorno"},{"$ref":"#/components/schemas/produtos_tabelaprecos_ConsultarTabelaPreco_retorno"},{"$ref":"#/components/schemas/produtos_tabelaprecos_ExcluirTabelaPreco_retorno"},{"$ref":"#/components/schemas/produtos_tabelaprecos_IncluirTabelaPreco_retorno"},{"$ref":"#/components/schemas/produtos_tabelaprecos_ListarTabelaItens_retorno"},{"$ref":"#/components/schemas/produtos_tabelaprecos_ListarTabelasPreco_retorno"},{"$ref":"#/components/schemas/produtos_tabelaprecos_SuspenderTabelaPreco_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/tpcalc/":{"post":{"tags":["Produtos"],"summary":"Listagem de Tipo de Cálculo.","description":"Serviço **TipoCalculo**. Operações (campo `call`): ListarTpCalc.","operationId":"produtos_tpcalc","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_tpcalc_ListarTpCalc"}],"discriminator":{"propertyName":"call","mapping":{"ListarTpCalc":"#/components/schemas/produtos_tpcalc_ListarTpCalc"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/produtos_tpcalc_ListarTpCalc_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/variacao/":{"post":{"tags":["Produtos"],"summary":"Operação relacionada a variação do produto.","description":"Serviço **ProdutosVariacoes**. Operações (campo `call`): ConsultarVariacoes · IncluirVariacoes · ListarVariacoes.","operationId":"produtos_variacao","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_variacao_ConsultarVariacoes"},{"$ref":"#/components/schemas/produtos_variacao_IncluirVariacoes"},{"$ref":"#/components/schemas/produtos_variacao_ListarVariacoes"}],"discriminator":{"propertyName":"call","mapping":{"ConsultarVariacoes":"#/components/schemas/produtos_variacao_ConsultarVariacoes","IncluirVariacoes":"#/components/schemas/produtos_variacao_IncluirVariacoes","ListarVariacoes":"#/components/schemas/produtos_variacao_ListarVariacoes"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/produtos_variacao_ConsultarVariacoes_retorno"},{"$ref":"#/components/schemas/produtos_variacao_IncluirVariacoes_retorno"},{"$ref":"#/components/schemas/produtos_variacao_ListarVariacoes_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/produtos/vendas-resumo/":{"post":{"tags":["Produtos"],"summary":"Resumo de vendas de produtos.","description":"Serviço **ResumoProdutosVendas**. Operações (campo `call`): ObterResumoProdutos.","operationId":"produtos_vendasresumo","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/produtos_vendasresumo_ObterResumoProdutos"}],"discriminator":{"propertyName":"call","mapping":{"ObterResumoProdutos":"#/components/schemas/produtos_vendasresumo_ObterResumoProdutos"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/produtos_vendasresumo_ObterResumoProdutos_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/servicos/classificacaoservico/":{"post":{"tags":["Serviços"],"summary":"Cadastro de Classificação do Serviço (NF modelo 21 e 22)","description":"Serviço **ClassificacaoServico**. Operações (campo `call`): ListarClassificacaoServico.","operationId":"servicos_classificacaoservico","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/servicos_classificacaoservico_ListarClassificacaoServico"}],"discriminator":{"propertyName":"call","mapping":{"ListarClassificacaoServico":"#/components/schemas/servicos_classificacaoservico_ListarClassificacaoServico"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/servicos_classificacaoservico_ListarClassificacaoServico_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/servicos/contrato/":{"post":{"tags":["Serviços"],"summary":"API de Contrato de Serviço.","description":"Serviço **Contrato**. Operações (campo `call`): AlterarContrato · ConsultarContrato · ExcluirItem · IncluirContrato · ListarContratos · UpsertContrato.","operationId":"servicos_contrato","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/servicos_contrato_AlterarContrato"},{"$ref":"#/components/schemas/servicos_contrato_ConsultarContrato"},{"$ref":"#/components/schemas/servicos_contrato_ExcluirItem"},{"$ref":"#/components/schemas/servicos_contrato_IncluirContrato"},{"$ref":"#/components/schemas/servicos_contrato_ListarContratos"},{"$ref":"#/components/schemas/servicos_contrato_UpsertContrato"}],"discriminator":{"propertyName":"call","mapping":{"AlterarContrato":"#/components/schemas/servicos_contrato_AlterarContrato","ConsultarContrato":"#/components/schemas/servicos_contrato_ConsultarContrato","ExcluirItem":"#/components/schemas/servicos_contrato_ExcluirItem","IncluirContrato":"#/components/schemas/servicos_contrato_IncluirContrato","ListarContratos":"#/components/schemas/servicos_contrato_ListarContratos","UpsertContrato":"#/components/schemas/servicos_contrato_UpsertContrato"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/servicos_contrato_AlterarContrato_retorno"},{"$ref":"#/components/schemas/servicos_contrato_ConsultarContrato_retorno"},{"$ref":"#/components/schemas/servicos_contrato_ExcluirItem_retorno"},{"$ref":"#/components/schemas/servicos_contrato_IncluirContrato_retorno"},{"$ref":"#/components/schemas/servicos_contrato_ListarContratos_retorno"},{"$ref":"#/components/schemas/servicos_contrato_UpsertContrato_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/servicos/contratofat/":{"post":{"tags":["Serviços"],"summary":"Processos do fatutamento de Contratos","description":"Serviço **ContratoFaturamento**. Operações (campo `call`): AtivarContrato · CancelarContrato · FaturarContrato · ObterContratos · ReativarContrato · SuspenderContrato · ValidarContrato.","operationId":"servicos_contratofat","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/servicos_contratofat_AtivarContrato"},{"$ref":"#/components/schemas/servicos_contratofat_CancelarContrato"},{"$ref":"#/components/schemas/servicos_contratofat_FaturarContrato"},{"$ref":"#/components/schemas/servicos_contratofat_ObterContratos"},{"$ref":"#/components/schemas/servicos_contratofat_ReativarContrato"},{"$ref":"#/components/schemas/servicos_contratofat_SuspenderContrato"},{"$ref":"#/components/schemas/servicos_contratofat_ValidarContrato"}],"discriminator":{"propertyName":"call","mapping":{"AtivarContrato":"#/components/schemas/servicos_contratofat_AtivarContrato","CancelarContrato":"#/components/schemas/servicos_contratofat_CancelarContrato","FaturarContrato":"#/components/schemas/servicos_contratofat_FaturarContrato","ObterContratos":"#/components/schemas/servicos_contratofat_ObterContratos","ReativarContrato":"#/components/schemas/servicos_contratofat_ReativarContrato","SuspenderContrato":"#/components/schemas/servicos_contratofat_SuspenderContrato","ValidarContrato":"#/components/schemas/servicos_contratofat_ValidarContrato"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/servicos_contratofat_AtivarContrato_retorno"},{"$ref":"#/components/schemas/servicos_contratofat_CancelarContrato_retorno"},{"$ref":"#/components/schemas/servicos_contratofat_FaturarContrato_retorno"},{"$ref":"#/components/schemas/servicos_contratofat_ObterContratos_retorno"},{"$ref":"#/components/schemas/servicos_contratofat_ReativarContrato_retorno"},{"$ref":"#/components/schemas/servicos_contratofat_SuspenderContrato_retorno"},{"$ref":"#/components/schemas/servicos_contratofat_ValidarContrato_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/servicos/contratolote/":{"post":{"tags":["Serviços"],"summary":"Faturamento para Contratos em Lote","description":"Serviço **ContratoLote**. Operações (campo `call`): FaturarLoteContrato · ListarLotesContrato · StatusLoteContrato.","operationId":"servicos_contratolote","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/servicos_contratolote_FaturarLoteContrato"},{"$ref":"#/components/schemas/servicos_contratolote_ListarLotesContrato"},{"$ref":"#/components/schemas/servicos_contratolote_StatusLoteContrato"}],"discriminator":{"propertyName":"call","mapping":{"FaturarLoteContrato":"#/components/schemas/servicos_contratolote_FaturarLoteContrato","ListarLotesContrato":"#/components/schemas/servicos_contratolote_ListarLotesContrato","StatusLoteContrato":"#/components/schemas/servicos_contratolote_StatusLoteContrato"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/servicos_contratolote_FaturarLoteContrato_retorno"},{"$ref":"#/components/schemas/servicos_contratolote_ListarLotesContrato_retorno"},{"$ref":"#/components/schemas/servicos_contratolote_StatusLoteContrato_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/servicos/contratotpfat/":{"post":{"tags":["Serviços"],"summary":"Cadastro de Tipo de Faturamento de Contrato.","description":"Serviço **ContratoTipoFaturamento**. Operações (campo `call`): ListarTipoFatContrato.","operationId":"servicos_contratotpfat","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/servicos_contratotpfat_ListarTipoFatContrato"}],"discriminator":{"propertyName":"call","mapping":{"ListarTipoFatContrato":"#/components/schemas/servicos_contratotpfat_ListarTipoFatContrato"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/servicos_contratotpfat_ListarTipoFatContrato_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/servicos/ibpt/":{"post":{"tags":["Serviços"],"summary":"Tabela IBPT.","description":"Serviço **TabelaIBPT**. Operações (campo `call`): ListarProdutosIBPT · ListarServicosIBPT.","operationId":"servicos_ibpt","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/servicos_ibpt_ListarProdutosIBPT"},{"$ref":"#/components/schemas/servicos_ibpt_ListarServicosIBPT"}],"discriminator":{"propertyName":"call","mapping":{"ListarProdutosIBPT":"#/components/schemas/servicos_ibpt_ListarProdutosIBPT","ListarServicosIBPT":"#/components/schemas/servicos_ibpt_ListarServicosIBPT"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/servicos_ibpt_ListarProdutosIBPT_retorno"},{"$ref":"#/components/schemas/servicos_ibpt_ListarServicosIBPT_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/servicos/indoper/":{"post":{"tags":["Serviços"],"summary":"API para realizar operações relacionadas ao Indicador de Operação","description":"Serviço **IndicadorOperacao**. Operações (campo `call`): ListarIndOper.","operationId":"servicos_indoper","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/servicos_indoper_ListarIndOper"}],"discriminator":{"propertyName":"call","mapping":{"ListarIndOper":"#/components/schemas/servicos_indoper_ListarIndOper"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/servicos_indoper_ListarIndOper_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/servicos/lc116/":{"post":{"tags":["Serviços"],"summary":"Lista de serviços anexa à Lei Complementar nº 116, de 31 de julho de 2003","description":"Serviço **LC116**. Operações (campo `call`): ListarLC116.","operationId":"servicos_lc116","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/servicos_lc116_ListarLC116"}],"discriminator":{"propertyName":"call","mapping":{"ListarLC116":"#/components/schemas/servicos_lc116_ListarLC116"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/servicos_lc116_ListarLC116_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/servicos/listaservico/":{"post":{"tags":["Serviços"],"summary":"Lista de Serviços no Município","description":"Serviço **ListaServicoMunicipio**. Operações (campo `call`): ListarServMunic.","operationId":"servicos_listaservico","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/servicos_listaservico_ListarServMunic"}],"discriminator":{"propertyName":"call","mapping":{"ListarServMunic":"#/components/schemas/servicos_listaservico_ListarServMunic"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/servicos_listaservico_ListarServMunic_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/servicos/nbs/":{"post":{"tags":["Serviços"],"summary":"Listagem de NBS (Nomenclatura Brasileira de Serviços).","description":"Serviço **NBS**. Operações (campo `call`): ListarNBS.","operationId":"servicos_nbs","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/servicos_nbs_ListarNBS"}],"discriminator":{"propertyName":"call","mapping":{"ListarNBS":"#/components/schemas/servicos_nbs_ListarNBS"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/servicos_nbs_ListarNBS_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/servicos/nfse/":{"post":{"tags":["Serviços"],"summary":"Nota Fiscal de Serviços","description":"Serviço **NFSe**. Operações (campo `call`): ListarNFSEs.","operationId":"servicos_nfse","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/servicos_nfse_ListarNFSEs"}],"discriminator":{"propertyName":"call","mapping":{"ListarNFSEs":"#/components/schemas/servicos_nfse_ListarNFSEs"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/servicos_nfse_ListarNFSEs_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/servicos/ordemservico/":{"post":{"tags":["Serviços"],"summary":"API Resumida de Ordem de serviço.","description":"Serviço **OrdemServicoResumo**. Operações (campo `call`): AdicionarItemOs · AdicionarOs.","operationId":"servicos_ordemservico","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/servicos_ordemservico_AdicionarItemOs"},{"$ref":"#/components/schemas/servicos_ordemservico_AdicionarOs"}],"discriminator":{"propertyName":"call","mapping":{"AdicionarItemOs":"#/components/schemas/servicos_ordemservico_AdicionarItemOs","AdicionarOs":"#/components/schemas/servicos_ordemservico_AdicionarOs"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/servicos_ordemservico_AdicionarItemOs_retorno"},{"$ref":"#/components/schemas/servicos_ordemservico_AdicionarOs_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/servicos/os/":{"post":{"tags":["Serviços"],"summary":"API para geração de Ordem de Serviço","description":"Serviço **OrdemServico**. Operações (campo `call`): AlterarOS · ConsultarOS · ExcluirOS · IncluirOS · ListarOS · StatusOS · TrocarEtapaOS.","operationId":"servicos_os","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/servicos_os_AlterarOS"},{"$ref":"#/components/schemas/servicos_os_ConsultarOS"},{"$ref":"#/components/schemas/servicos_os_ExcluirOS"},{"$ref":"#/components/schemas/servicos_os_IncluirOS"},{"$ref":"#/components/schemas/servicos_os_ListarOS"},{"$ref":"#/components/schemas/servicos_os_StatusOS"},{"$ref":"#/components/schemas/servicos_os_TrocarEtapaOS"}],"discriminator":{"propertyName":"call","mapping":{"AlterarOS":"#/components/schemas/servicos_os_AlterarOS","ConsultarOS":"#/components/schemas/servicos_os_ConsultarOS","ExcluirOS":"#/components/schemas/servicos_os_ExcluirOS","IncluirOS":"#/components/schemas/servicos_os_IncluirOS","ListarOS":"#/components/schemas/servicos_os_ListarOS","StatusOS":"#/components/schemas/servicos_os_StatusOS","TrocarEtapaOS":"#/components/schemas/servicos_os_TrocarEtapaOS"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/servicos_os_AlterarOS_retorno"},{"$ref":"#/components/schemas/servicos_os_ConsultarOS_retorno"},{"$ref":"#/components/schemas/servicos_os_ExcluirOS_retorno"},{"$ref":"#/components/schemas/servicos_os_IncluirOS_retorno"},{"$ref":"#/components/schemas/servicos_os_ListarOS_retorno"},{"$ref":"#/components/schemas/servicos_os_StatusOS_retorno"},{"$ref":"#/components/schemas/servicos_os_TrocarEtapaOS_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/servicos/osdocs/":{"post":{"tags":["Serviços"],"summary":"Retorna informações do faturamento de serviços.","description":"Serviço **OsDocs**. Operações (campo `call`): ObterDemonst · ObterNFSe · ObterOS · ObterRPS · ObterRecibo · ObterViaUnica.","operationId":"servicos_osdocs","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/servicos_osdocs_ObterDemonst"},{"$ref":"#/components/schemas/servicos_osdocs_ObterNFSe"},{"$ref":"#/components/schemas/servicos_osdocs_ObterOS"},{"$ref":"#/components/schemas/servicos_osdocs_ObterRPS"},{"$ref":"#/components/schemas/servicos_osdocs_ObterRecibo"},{"$ref":"#/components/schemas/servicos_osdocs_ObterViaUnica"}],"discriminator":{"propertyName":"call","mapping":{"ObterDemonst":"#/components/schemas/servicos_osdocs_ObterDemonst","ObterNFSe":"#/components/schemas/servicos_osdocs_ObterNFSe","ObterOS":"#/components/schemas/servicos_osdocs_ObterOS","ObterRPS":"#/components/schemas/servicos_osdocs_ObterRPS","ObterRecibo":"#/components/schemas/servicos_osdocs_ObterRecibo","ObterViaUnica":"#/components/schemas/servicos_osdocs_ObterViaUnica"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/servicos_osdocs_ObterDemonst_retorno"},{"$ref":"#/components/schemas/servicos_osdocs_ObterNFSe_retorno"},{"$ref":"#/components/schemas/servicos_osdocs_ObterOS_retorno"},{"$ref":"#/components/schemas/servicos_osdocs_ObterRPS_retorno"},{"$ref":"#/components/schemas/servicos_osdocs_ObterRecibo_retorno"},{"$ref":"#/components/schemas/servicos_osdocs_ObterViaUnica_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/servicos/oslote/":{"post":{"tags":["Serviços"],"summary":"Faturamento para Ordens de Serviços em Lote","description":"Serviço **OrdemServicoLote**. Operações (campo `call`): FaturarLoteOS · ListarLoteNfse · ListarLotesOS · StatusLoteOS.","operationId":"servicos_oslote","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/servicos_oslote_FaturarLoteOS"},{"$ref":"#/components/schemas/servicos_oslote_ListarLoteNfse"},{"$ref":"#/components/schemas/servicos_oslote_ListarLotesOS"},{"$ref":"#/components/schemas/servicos_oslote_StatusLoteOS"}],"discriminator":{"propertyName":"call","mapping":{"FaturarLoteOS":"#/components/schemas/servicos_oslote_FaturarLoteOS","ListarLoteNfse":"#/components/schemas/servicos_oslote_ListarLoteNfse","ListarLotesOS":"#/components/schemas/servicos_oslote_ListarLotesOS","StatusLoteOS":"#/components/schemas/servicos_oslote_StatusLoteOS"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/servicos_oslote_FaturarLoteOS_retorno"},{"$ref":"#/components/schemas/servicos_oslote_ListarLoteNfse_retorno"},{"$ref":"#/components/schemas/servicos_oslote_ListarLotesOS_retorno"},{"$ref":"#/components/schemas/servicos_oslote_StatusLoteOS_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/servicos/osp/":{"post":{"tags":["Serviços"],"summary":"Processos da Ordem de Serviço","description":"Serviço **OrdemServicoFaturamento**. Operações (campo `call`): AssociarCodIntOS · CancelarOS · DuplicarOS · FaturarOS · ObterOS · ReenviarOS · ValidarOS.","operationId":"servicos_osp","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/servicos_osp_AssociarCodIntOS"},{"$ref":"#/components/schemas/servicos_osp_CancelarOS"},{"$ref":"#/components/schemas/servicos_osp_DuplicarOS"},{"$ref":"#/components/schemas/servicos_osp_FaturarOS"},{"$ref":"#/components/schemas/servicos_osp_ObterOS"},{"$ref":"#/components/schemas/servicos_osp_ReenviarOS"},{"$ref":"#/components/schemas/servicos_osp_ValidarOS"}],"discriminator":{"propertyName":"call","mapping":{"AssociarCodIntOS":"#/components/schemas/servicos_osp_AssociarCodIntOS","CancelarOS":"#/components/schemas/servicos_osp_CancelarOS","DuplicarOS":"#/components/schemas/servicos_osp_DuplicarOS","FaturarOS":"#/components/schemas/servicos_osp_FaturarOS","ObterOS":"#/components/schemas/servicos_osp_ObterOS","ReenviarOS":"#/components/schemas/servicos_osp_ReenviarOS","ValidarOS":"#/components/schemas/servicos_osp_ValidarOS"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/servicos_osp_AssociarCodIntOS_retorno"},{"$ref":"#/components/schemas/servicos_osp_CancelarOS_retorno"},{"$ref":"#/components/schemas/servicos_osp_DuplicarOS_retorno"},{"$ref":"#/components/schemas/servicos_osp_FaturarOS_retorno"},{"$ref":"#/components/schemas/servicos_osp_ObterOS_retorno"},{"$ref":"#/components/schemas/servicos_osp_ReenviarOS_retorno"},{"$ref":"#/components/schemas/servicos_osp_ValidarOS_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/servicos/resumo/":{"post":{"tags":["Serviços"],"summary":"Resumos dos serviços.","description":"Serviço **ResumoServicos**. Operações (campo `call`): ObterResumoServicos.","operationId":"servicos_resumo","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/servicos_resumo_ObterResumoServicos"}],"discriminator":{"propertyName":"call","mapping":{"ObterResumoServicos":"#/components/schemas/servicos_resumo_ObterResumoServicos"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/servicos_resumo_ObterResumoServicos_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/servicos/servico/":{"post":{"tags":["Serviços"],"summary":"Cadastro de Serviços","description":"Serviço **Servicos**. Operações (campo `call`): AlterarCadastroServico · AssociarCodIntServico · ConsultarCadastroServico · ExcluirCadastroServico · IncluirCadastroServico · ListarCadastroServico · UpsertCadastroServico.","operationId":"servicos_servico","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/servicos_servico_AlterarCadastroServico"},{"$ref":"#/components/schemas/servicos_servico_AssociarCodIntServico"},{"$ref":"#/components/schemas/servicos_servico_ConsultarCadastroServico"},{"$ref":"#/components/schemas/servicos_servico_ExcluirCadastroServico"},{"$ref":"#/components/schemas/servicos_servico_IncluirCadastroServico"},{"$ref":"#/components/schemas/servicos_servico_ListarCadastroServico"},{"$ref":"#/components/schemas/servicos_servico_UpsertCadastroServico"}],"discriminator":{"propertyName":"call","mapping":{"AlterarCadastroServico":"#/components/schemas/servicos_servico_AlterarCadastroServico","AssociarCodIntServico":"#/components/schemas/servicos_servico_AssociarCodIntServico","ConsultarCadastroServico":"#/components/schemas/servicos_servico_ConsultarCadastroServico","ExcluirCadastroServico":"#/components/schemas/servicos_servico_ExcluirCadastroServico","IncluirCadastroServico":"#/components/schemas/servicos_servico_IncluirCadastroServico","ListarCadastroServico":"#/components/schemas/servicos_servico_ListarCadastroServico","UpsertCadastroServico":"#/components/schemas/servicos_servico_UpsertCadastroServico"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/servicos_servico_AlterarCadastroServico_retorno"},{"$ref":"#/components/schemas/servicos_servico_AssociarCodIntServico_retorno"},{"$ref":"#/components/schemas/servicos_servico_ConsultarCadastroServico_retorno"},{"$ref":"#/components/schemas/servicos_servico_ExcluirCadastroServico_retorno"},{"$ref":"#/components/schemas/servicos_servico_IncluirCadastroServico_retorno"},{"$ref":"#/components/schemas/servicos_servico_ListarCadastroServico_retorno"},{"$ref":"#/components/schemas/servicos_servico_UpsertCadastroServico_retorno"}]}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/servicos/tipotrib/":{"post":{"tags":["Serviços"],"summary":"Tipo de Tributação do Serviço","description":"Serviço **TipoTributacao**. Operações (campo `call`): ListarTiposTrib.","operationId":"servicos_tipotrib","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/servicos_tipotrib_ListarTiposTrib"}],"discriminator":{"propertyName":"call","mapping":{"ListarTiposTrib":"#/components/schemas/servicos_tipotrib_ListarTiposTrib"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/servicos_tipotrib_ListarTiposTrib_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/v1/servicos/tipoutilizacao/":{"post":{"tags":["Serviços"],"summary":"Cadastro de Tipos de Utilização do Serviço (NF modelo 21 e 22)","description":"Serviço **ServicoTipoUtilizacao**. Operações (campo `call`): ListarTipoUtilizacao.","operationId":"servicos_tipoutilizacao","requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/servicos_tipoutilizacao_ListarTipoUtilizacao"}],"discriminator":{"propertyName":"call","mapping":{"ListarTipoUtilizacao":"#/components/schemas/servicos_tipoutilizacao_ListarTipoUtilizacao"}}}}}},"responses":{"200":{"description":"Sucesso. O formato depende da operação chamada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/servicos_tipoutilizacao_ListarTipoUtilizacao_retorno"}}}},"403":{"description":"Sem permissão para a operação, ou aplicativo sem o pacote de APIs."},"406":{"description":"Acesso do aplicativo bloqueado (IP, horário ou MFA)."},"425":{"description":"A mesma chamada repetida demais em pouco tempo."},"429":{"description":"Limite de chamadas simultâneas atingido."},"500":{"description":"Erro de negócio ou de validação de parâmetro. A mensagem diz qual."},"503":{"description":"Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa."}}}},"/api/portal/apps/":{"get":{"tags":["Autenticação e aplicativos"],"summary":"Lista de aplicativos do usuário","description":"Lista os aplicativos (empresas) a que o usuário tem acesso, com o app_hash de cada um, a situação e o api_access (o que o aplicativo precisa para consumir a API).","operationId":"portal_ListarAplicativos","security":[{"tokenDeUsuario":[]}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"app_hash":{"type":"string","description":"Hash de identificação do aplicativo","example":"wonka-07djm8"},"app_type":{"type":"string","description":"Tipo do aplicativo","enum":["OMIE","ONEFLOW"],"example":"OMIE"},"api_access":{"type":"string","nullable":true,"description":"O que o aplicativo precisa para consumir a API, a mesma classificação do gate de API: TRIAL (demonstração, cota por dia), FREE (plano gratuito, cota por dia), SANDBOX, ALLOWED (addon que libera a API), BLOCKED (precisa de addon na Omie Store) ou null (fora do controle por addon).","enum":["TRIAL","FREE","SANDBOX","ALLOWED","BLOCKED",null]},"company_nicename":{"type":"string","example":"Wonka - A Fantástica Fábrica"},"company_logo":{"type":"string","description":"URL do logotipo do aplicativo","example":"https://static.omie.com.br/exemplo/logo.png"},"company_icon":{"type":"string","description":"URL do icone do aplicativo","example":"https://static.omie.com.br/exemplo/icone.png"},"service_status":{"type":"string","description":"Identifica o status do aplicativo","enum":["ACTIVE","PENDING","ARCHIVED","CANCELLED"]},"is_demo":{"type":"boolean","description":"Identifica se é um aplicativo de demonstração","example":true},"purchase_date":{"type":"string","description":"Data que o aplicativo foi assinado","example":"2015-02-06T10:44:37-0300"},"purchase_url":{"type":"string","description":"Se é um aplicativo de demonstração, teremos a URL do carrinho de compras"},"evaluation_date":{"type":"string","description":"Data de expiração do aplicativo trial","example":"2015-02-06T10:44:37-0300"},"admin_role":{"type":"boolean","description":"Identifica se o usuário atual é administrador do aplicativo","example":true},"online_training_enabled":{"type":"boolean","description":"Identifica se o aplicativo possui consultoria habilitada","example":true},"is_pinned":{"type":"boolean","description":"Identifica se o aplicativo está favoritado","example":true},"active":{"type":"boolean","description":"Identifica se o aplicativo está ativo","example":true},"contract":{"type":"object","properties":{"contract_id":{"type":"integer","description":"ID do tipo de contrato","example":13},"contract_name":{"type":"string","description":"Nome do contrato","example":"V6"},"contract_label":{"type":"string","description":"Nome amigável do contrato","example":"Omie.Fit"},"contract_identifier":{"type":"string","description":"Código do contrato","example":"V6.003"}}}}}}}}}},"parameters":[{"name":"q","in":"query","required":false,"description":"Texto para filtrar aplicativos","schema":{"type":"string","example":"laranja"}},{"name":"doc","in":"query","required":false,"description":"Documento (CNPJ ou CPF) do aplicativo","schema":{"type":"string","example":"00.000.000/0001-00"}}]}},"/api/portal/apps/{appHash}/":{"get":{"tags":["Autenticação e aplicativos"],"summary":"Detalhes de um aplicativo","description":"Os dados de um aplicativo a que o usuário tem acesso: situação, contrato, papel do usuário e api_access.","operationId":"portal_ConsultarAplicativo","security":[{"tokenDeUsuario":[]}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"app_hash":{"type":"string","description":"Hash de identificação do aplicativo","example":"wonka-07djm8"},"app_type":{"type":"string","description":"Tipo do aplicativo","enum":["OMIE","ONEFLOW"],"example":"OMIE"},"api_access":{"type":"string","nullable":true,"description":"O que o aplicativo precisa para consumir a API, a mesma classificação do gate de API: TRIAL (demonstração, cota por dia), FREE (plano gratuito, cota por dia), SANDBOX, ALLOWED (addon que libera a API), BLOCKED (precisa de addon na Omie Store) ou null (fora do controle por addon).","enum":["TRIAL","FREE","SANDBOX","ALLOWED","BLOCKED",null]},"company_nicename":{"type":"string","example":"Wonka - A Fantástica Fábrica"},"company_logo":{"type":"string","description":"URL do logotipo do aplicativo","example":"https://static.omie.com.br/exemplo/logo.png"},"company_icon":{"type":"string","description":"URL do icone do aplicativo","example":"https://static.omie.com.br/exemplo/icone.png"},"service_status":{"type":"string","description":"Identifica o status do aplicativo","enum":["ACTIVE","PENDING","ARCHIVED","CANCELLED"]},"is_demo":{"type":"boolean","description":"Identifica se é um aplicativo de demonstração","example":true},"purchase_date":{"type":"string","description":"Data que o aplicativo foi assinado","example":"2015-02-06T10:44:37-0300"},"purchase_url":{"type":"string","description":"Se é um aplicativo de demonstração, teremos a URL do carrinho de compras"},"evaluation_date":{"type":"string","description":"Data de expiração do aplicativo trial","example":"2015-02-06T10:44:37-0300"},"admin_role":{"type":"boolean","description":"Identifica se o usuário atual é administrador do aplicativo","example":true},"online_training_enabled":{"type":"boolean","description":"Identifica se o aplicativo possui consultoria habilitada","example":true},"is_pinned":{"type":"boolean","description":"Identifica se o aplicativo está favoritado","example":true},"active":{"type":"boolean","description":"Identifica se o aplicativo está ativo","example":true},"contract":{"type":"object","properties":{"contract_id":{"type":"integer","description":"ID do tipo de contrato","example":13},"contract_name":{"type":"string","description":"Nome do contrato","example":"V6"},"contract_label":{"type":"string","description":"Nome amigável do contrato","example":"Omie.Fit"},"contract_identifier":{"type":"string","description":"Código do contrato","example":"V6.003"}}}}}}}}},"parameters":[{"name":"appHash","in":"path","required":true,"description":"Hash do aplicativo","schema":{"type":"string"}}]}},"/api/portal/apps/{appHash}/groups/":{"get":{"tags":["Autenticação e aplicativos"],"summary":"Grupos de permissão","description":"Os grupos de permissão do aplicativo, com os usuários e as permissões de cada um. O auth_group_id daqui é o group_id do convite. Só para quem administra o aplicativo.","operationId":"portal_ListarGruposDoAplicativo","security":[{"tokenDeUsuario":[]}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object"}}}}},"parameters":[{"name":"appHash","in":"path","required":true,"description":"Hash do aplicativo","schema":{"type":"string"}}]}},"/api/portal/apps/{appHash}/invite/":{"post":{"tags":["Autenticação e aplicativos"],"summary":"Convida uma pessoa para o aplicativo","description":"Convida um e-mail para o aplicativo, num grupo de permissão, e manda o e-mail de convite em nome de quem está autenticado. Só para quem administra o aplicativo, com o aplicativo ativo ou suspenso. Aplicativo com login por SSO só aceita e-mail do domínio da empresa. A resposta de erro vem com status ERROR e o motivo em description.","operationId":"portal_ConvidarUsuario","security":[{"tokenDeUsuario":[]}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["OK"]},"invite_id":{"type":"string"}}}}}}},"parameters":[{"name":"appHash","in":"path","required":true,"description":"Hash do aplicativo","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string","enum":["create_invite"]},"email":{"type":"string","description":"E-mail da pessoa convidada","example":"pessoa@empresa.com.br"},"group_id":{"type":"string","description":"auth_group_id do grupo, de ListarGruposDoAplicativo"},"notify":{"type":"boolean","description":"Manda o e-mail de convite (padrão false; para a pessoa saber, use true)"}},"required":["action","email","group_id"]}}}}}},"/api/portal/apps/{appHash}/refresh-token/":{"post":{"tags":["Autenticação e aplicativos"],"summary":"Renova o token do aplicativo","description":"Troca o par de token e refresh_token do aplicativo por um novo, sem o token de usuário. O token pode estar vencido. Responde 403 se o par não confere ou se o usuário perdeu o acesso ao aplicativo.","operationId":"portal_RenovarTokenDoAplicativo","security":[],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","description":"Token (JWT)"},"refresh_token":{"type":"string","description":"Token para renovar o token"}}}}}}},"parameters":[{"name":"appHash","in":"path","required":true,"description":"Hash do aplicativo","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","description":"Token (JWT)"},"refresh_token":{"type":"string","description":"Token para renovar o token"}}}}}}}},"/api/portal/apps/{appHash}/token/":{"get":{"tags":["Autenticação e aplicativos"],"summary":"Token do aplicativo","description":"Devolve o token do aplicativo, com o token de usuário como Bearer. É o token que vai nas chamadas da API (/api/v1) e vale 24 horas. Junto vem um refresh_token para renová-lo sem o token de usuário.","operationId":"portal_ObterTokenDoAplicativo","security":[{"tokenDeUsuario":[]}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","description":"Token (JWT)"},"refresh_token":{"type":"string","description":"Token para renovar o token"}}}}}}},"parameters":[{"name":"appHash","in":"path","required":true,"description":"Hash do aplicativo","schema":{"type":"string"}}]}},"/api/portal/apps/{appHash}/users/":{"get":{"tags":["Autenticação e aplicativos"],"summary":"Lista de usuários de um aplicativo","description":"Os usuários e os convites do aplicativo, com o grupo, a situação e quem convidou. Só para quem administra o aplicativo, e só com o aplicativo ativo ou suspenso.","operationId":"portal_ListarUsuariosDoAplicativo","security":[{"tokenDeUsuario":[]}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"invite_id":{"type":"string"},"user":{"type":"object","properties":{"user_id":{"type":"string"},"user_email":{"type":"string"},"user_name":{"type":"string"}}},"invited_by":{"type":"object","description":"Quem convidou","properties":{"user_id":{"type":"string"},"user_name":{"type":"string"},"user_email":{"type":"string"}}},"group_id":{"type":"string","description":"Grupo de permissão (aplicativos que usam grupos)"},"is_api":{"type":"boolean"},"invite_date":{"type":"string"},"invite_last_action":{"type":"string"},"disass_date":{"type":"string"},"disass_reason":{"type":"string"},"status":{"type":"string","description":"Situação do convite (Pending, Accepted, Canceled)"}}}}}}}}}},"parameters":[{"name":"appHash","in":"path","required":true,"description":"Hash do aplicativo","schema":{"type":"string"}}]}},"/api/portal/users/me/token/":{"get":{"tags":["Autenticação e aplicativos"],"summary":"Token do usuário","description":"Devolve um par novo de token e refresh_token do usuário. Aceita a sessão do Omie aberta no navegador ou o token de usuário ainda válido como Bearer. Se a conta exige MFA e ele não foi configurado, responde 403 com status MFA_REQUIRED.","operationId":"portal_ObterTokenDeUsuario","security":[{"tokenDeUsuario":[]}],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","description":"Token do usuário"},"refresh_token":{"type":"string","description":"Token utilizado para renovar o token do usuário"}}}}}}}}},"/api/portal/users/refresh-token/":{"post":{"tags":["Autenticação e aplicativos"],"summary":"Renova o token do usuário","description":"Troca o par de token e refresh_token do usuário por um novo, sem cabeçalho Authorization. Aceita o token já vencido. Use o par novo e descarte o antigo; trocar a senha da pessoa invalida o refresh_token.","operationId":"portal_RenovarTokenDeUsuario","security":[],"responses":{"200":{"description":"Sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","description":"Token do usuário"},"refresh_token":{"type":"string","description":"Token utilizado para renovar o token do usuário"}}}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","description":"Token do usuário"},"refresh_token":{"type":"string","description":"Token utilizado para renovar o token do usuário"}}}}}}}}},"components":{"securitySchemes":{"tokenDoAplicativo":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token do aplicativo (/api/portal/apps/{app_hash}/token/)"},"tokenDeUsuario":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Token de usuário (/api/portal/users/me/token/)"}},"schemas":{"contador_configplanocateg_ListarConfigPlanoCateg":{"type":"object","title":"ListarConfigPlanoCateg","description":"Realiza a listagem de configuração entre Categorias x Plano Contábil.\n\nRepresenta o passo E da tela Integração Contábil localizada no módulo Painel do Contador.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarConfigPlanoCateg"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página a retornar. Padrão 1."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Número de registros por página. Padrão 1000."}}}}},"example":{"call":"ListarConfigPlanoCateg","param":[{"nPagina":1,"nRegPorPagina":50}]}},"contador_configplanocateg_ListarConfigPlanoCateg_retorno":{"type":"object","properties":{"nPagina":{"type":"integer","description":"Número da página retornada."},"nTotPaginas":{"type":"integer","description":"Número total de páginas."},"nRegistros":{"type":"integer","description":"Número de registros retornados nesta página."},"nTotRegistros":{"type":"integer","description":"Total de registros encontrados."},"listaConfigPlanoCateg":{"type":"array","items":{"type":"object","properties":{"cDescGrpCateg":{"type":"string","description":"Grupo da categoria. \"RECEITAS\" ou \"DESPESAS\"."},"cDescSubGrpCateg":{"type":"string","description":"Descrição do grupo (totalizador) da categoria no plano de categorias."},"cDescCateg":{"type":"string","description":"Descrição da categoria."},"cCodCateg":{"type":"string","description":"Código da categoria (ex. 2.01.01)."},"cDescConta":{"type":"string","description":"Descrição da conta do plano contábil ligada à categoria."},"nIdConta":{"type":"integer","description":"Id da conta do plano contábil ligada à categoria (o nIdConta de ListarPlanoContas)."},"nIdContaCp":{"type":"integer","description":"Id da conta contábil de contrapartida. Pode vir 0."},"cCodConfig":{"type":"string","description":"Tipo de contabilização da categoria. \"1\" - Gera os lançamentos de provisão e de baixa. \"2\" - Gera só a baixa (sem provisão), conta da categoria x banco. \"3\" - Gera só a baixa (sem provisão), cliente ou fornecedor x banco. \"4\" - Não gera lançamento contábil."}}},"description":"Lista das categorias com a conta contábil configurada."}},"title":"ListarConfigPlanoCateg (retorno)"},"contador_fechamento_GuiaImpArmazenar":{"type":"object","title":"GuiaImpArmazenar","description":"Armazena as Guias para Pagamento dos Impostos","required":["call","param"],"properties":{"call":{"type":"string","enum":["GuiaImpArmazenar"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"layout":{"type":"string","description":"Código do layout contábil (ver ListarLayoutContabil), ex. \"SCI1\". Aceita também o código sem o número final (SCI vira SCI1). Obrigatório."},"modulo":{"type":"string","description":"Texto livre que identifica o módulo do sistema contábil de origem (ex. \"Fiscal\"). Usado depois como filtro em GuiaImpListar."},"guias":{"type":"array","items":{"type":"object","properties":{"codigo_integracao":{"type":"string","maxLength":60,"description":"Código de integração da guia (chave da guia no seu sistema). Obrigatório."},"tipo_guia":{"type":"string","maxLength":20,"description":"Tipo da guia. Obrigatório.\n\nEx.: \"DAS\", \"ICMS\", \"ICMS_ST\", \"IPI\", \"PIS\", \"COFINS\", \"CSLL\", \"PCC\", \"IRPJ\", \"IRRF\", \"ISS\", \"CPRB\",\n\"GARE_SP\" (e demais guias estaduais), \"BOL\" (boleto) ou \"FAT\" (fatura)."},"codigo_receita":{"type":"string","maxLength":70,"description":"Código de Receita da Guia de Recolhimento"},"data_emissao":{"type":"string","maxLength":10,"description":"Data de emissão da guia, no formato AAAAMMDD. Obrigatória. Um único valor, não uma lista."},"data_entrada":{"type":"string","maxLength":10,"description":"Data de entrada (registro) da guia, no formato AAAAMMDD. Obrigatória. Define o mês do lote contábil em que a guia é anexada."},"codigo_cliente_fornecedor":{"type":"integer","maxLength":15,"description":"Código do fornecedor (cliente/fornecedor) no Omie. Informe este ou o CNPJ/CPF."},"cnpj_cpf_cliente_fornecedor":{"type":"string","maxLength":20,"description":"CNPJ/CPF do fornecedor, usado quando o código não é informado. Precisa já estar cadastrado."},"data_vencimento":{"type":"string","maxLength":10,"description":"Data de vencimento da guia, no formato AAAAMMDD. Obrigatória."},"data_previsao":{"type":"string","maxLength":10,"description":"Data de previsão de pagamento, no formato AAAAMMDD. Sem preenchimento, é o vencimento levado para o próximo dia útil."},"valor_documento":{"type":"number","maxLength":18,"description":"Valor líquido para pagamento da guia. Obrigatório e maior que zero."},"numero_documento":{"type":"string","maxLength":20,"description":"Número do Documento da Conta a Pagar"},"numero_documento_fiscal":{"type":"string","maxLength":20,"description":"Número do Documento Fiscal relacionado"},"chave_nfe":{"type":"string","maxLength":44,"description":"Chave de Acesso da Nota Fiscal Eletrônica relacionada"},"observacao":{"type":"string","description":"Observações da Conta a Pagar"},"file_name":{"type":"string","description":"Nome do arquivo com a guia de pagamento, com extensão (ex. das-202501.pdf). Obrigatório."},"file_base64":{"type":"string","description":"Arquivo com a guia codificado em base64 (PDF ou imagem). Obrigatório."}},"required":["codigo_integracao","data_entrada","data_vencimento","file_base64","file_name","tipo_guia","valor_documento"]},"description":"Guia de Imposto"}},"required":["layout"]}}},"example":{"call":"GuiaImpArmazenar","param":[{"layout":"SCI1","modulo":"Fiscal","guias":[{"tipo_guia":"DAS","codigo_receita":"","codigo_integracao":"DAS-202501","data_emissao":"20250210","data_entrada":"20250131","codigo_cliente_fornecedor":0,"cnpj_cpf_cliente_fornecedor":"00.394.460/0058-87","data_vencimento":"20250220","data_previsao":"","valor_documento":1532.47,"numero_documento":"DAS 01/2025","numero_documento_fiscal":"","chave_nfe":"","observacao":"Simples Nacional competência 01/2025","file_name":"das-202501.pdf","file_base64":"JVBERi0xLjQKJcfsj6IKNSAwIG9iago8PC9MZW5ndGggNiAwIFI+PgpzdHJlYW0K"}]}]}},"contador_fechamento_GuiaImpArmazenar_retorno":{"type":"object","properties":{"layout":{"type":"string","description":"Código do layout contábil usado."},"modulo":{"type":"string","description":"Módulo do sistema informado na requisição."},"result":{"type":"array","items":{"type":"object","properties":{"codigo_integracao":{"type":"string","description":"Código de Integração da Guia"},"tipo_guia":{"type":"string","description":"Tipo da Guia na Tabela de Impostos"},"codigo_receita":{"type":"string","description":"Código de Receita da Guia de Recolhimento"},"data_emissao":{"type":"string","description":"Data de Emissão da Guia (AAAAMMDD)"},"data_entrada":{"type":"string","description":"Data de Entrada da Guia (AAAAMMDD)"},"codigo_cliente_fornecedor":{"type":"integer","description":"Código do Cliente ou Fornecedor no Omie"},"cnpj_cpf_cliente_fornecedor":{"type":"string","description":"CNPJ/CPF do Cliente ou Fornecedor"},"data_vencimento":{"type":"string","description":"Data de Vencimento da Guia (AAAAMMDD)"},"data_previsao":{"type":"string","description":"Data de Previsão de Pagamento da Guia (AAAAMMDD)"},"valor_documento":{"type":"decimal","description":"Valor Líquido para Pagamento da Guia"},"numero_documento":{"type":"string","description":"Número do Documento da Conta a Pagar"},"numero_documento_fiscal":{"type":"string","description":"Número do Documento Fiscal relacionado"},"chave_nfe":{"type":"string","description":"Chave de Acesso da Nota Fiscal Eletrônica relacionada"},"observacao":{"type":"string","description":"Observações da Conta a Pagar"},"file_name":{"type":"string","description":"Nome do arquivo com a guia de pagamento"},"status":{"type":"string","description":"Situação do processamento da guia. \"OK\" - Guia processada. \"ERROR\" - Guia recusada; o motivo está em cDesStatus."},"cCodStatus":{"type":"string","description":"Código do status. \"0\" guia criada, \"1\" guia atualizada; outro valor é o código do erro."},"cDesStatus":{"type":"string","description":"Descrição do Status"}}},"description":"Resultado de cada guia recebida, com os dados enviados e o status."},"timeElapsed":{"type":"string","description":"Tempo de processamento da requisição."}},"title":"GuiaImpArmazenar (retorno)"},"contador_fechamento_GuiaImpListar":{"type":"object","title":"GuiaImpListar","description":"Listar Guias.","required":["call","param"],"properties":{"call":{"type":"string","enum":["GuiaImpListar"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"layout":{"type":"string","description":"Código do layout contábil em que as guias foram enviadas (ex. \"SCI1\"). Obrigatório."},"modulo":{"type":"string","description":"Filtra pelo módulo informado no envio da guia. Sem preenchimento, traz todos."},"nPagina":{"type":"integer","maxLength":15,"description":"Número da página a retornar. Padrão 1."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Número de registros por página. Padrão 100, máximo 100."},"cOrdenarPor":{"type":"string","maxLength":100,"description":"Ordenar por: \"CODIGO_INTEGRACAO\", \"DATA_EMISSAO\", \"DATA_VENCIMENTO\" ou \"DATA_PAGAMENTO\".\nObrigatório na prática: sem ele a chamada é recusada."},"cOrdemDecrescente":{"type":"string","maxLength":1,"description":"Ordem decrescente - \"S\" ou \"N\". Padrão \"N\"."},"dDtEmisDe":{"type":"string","maxLength":10,"description":"Data de emissão inicial (dd/mm/aaaa). Um único valor, não uma lista."},"dDtEmisAte":{"type":"string","maxLength":10,"description":"Data de emissão final (dd/mm/aaaa)."},"dDtVencDe":{"type":"string","maxLength":10,"description":"Data de vencimento inicial (dd/mm/aaaa)."},"dDtVencAte":{"type":"string","maxLength":10,"description":"Data de vencimento final (dd/mm/aaaa)."},"dDtPagtoDe":{"type":"string","maxLength":10,"description":"Data de pagamento inicial (dd/mm/aaaa)."},"dDtPagtoAte":{"type":"string","maxLength":10,"description":"Data de pagamento final (dd/mm/aaaa)."},"dDtPrevDe":{"type":"string","maxLength":10,"description":"Data de previsão de pagamento inicial (dd/mm/aaaa)."},"dDtPrevAte":{"type":"string","maxLength":10,"description":"Data de previsão de pagamento final (dd/mm/aaaa)."},"dDtRegDe":{"type":"string","maxLength":10,"description":"Data de registro (entrada) inicial (dd/mm/aaaa)."},"dDtRegAte":{"type":"string","maxLength":10,"description":"Data de registro (entrada) final (dd/mm/aaaa)."},"cStatus":{"type":"string","maxLength":100,"description":"Situação da conta a pagar da guia: \"LIQUIDADO\", \"VENCEHOJE\", \"AVENCER\" ou \"ATRASADO\".\nVence hoje, a vencer e atrasado comparam a data de previsão com hoje."}},"required":["layout"]}}},"example":{"call":"GuiaImpListar","param":[{"nPagina":1,"nRegPorPagina":20,"layout":"SCI1","cOrdenarPor":"DATA_EMISSAO"}]}},"contador_fechamento_GuiaImpListar_retorno":{"type":"object","properties":{"nPagina":{"type":"integer","description":"Número da página retornada."},"nTotPaginas":{"type":"integer","description":"Número total de páginas."},"nRegistros":{"type":"integer","description":"Número de registros retornados nesta página."},"nTotRegistros":{"type":"integer","description":"Total de registros encontrados."},"guias":{"type":"array","items":{"type":"object","properties":{"tipo_guia":{"type":"string","description":"Tipo da guia (ex. DAS, ICMS, IRRF)."},"codigo_receita":{"type":"string","description":"Código de receita da guia de recolhimento."},"codigo_integracao":{"type":"string","description":"Código de integração da guia."},"data_emissao":{"type":"string","description":"Data de emissão da guia (AAAAMMDD). Um único valor, não uma lista."},"data_entrada":{"type":"string","description":"Data de entrada (registro) da guia (AAAAMMDD)."},"codigo_cliente_fornecedor":{"type":"integer","description":"Código do fornecedor no Omie."},"cnpj_cpf_cliente_fornecedor":{"type":"string","description":"CNPJ/CPF do fornecedor."},"data_vencimento":{"type":"string","description":"Data de vencimento (AAAAMMDD)."},"data_previsao":{"type":"string","description":"Data de previsão de pagamento (AAAAMMDD)."},"valor_documento":{"type":"decimal","description":"Valor da guia."},"numero_documento":{"type":"string","description":"Número do documento da conta a pagar."},"numero_documento_fiscal":{"type":"string","description":"Número do documento fiscal relacionado."},"chave_nfe":{"type":"string","description":"Chave de acesso da NF-e relacionada."},"data_pagamento":{"type":"string","description":"Data do pagamento (AAAAMMDD). Vazio se não foi paga."},"liquidado":{"type":"string","description":"Indica se a conta a pagar da guia está liquidada - \"S\" ou \"N\"."},"valor_pago":{"type":"decimal","description":"Valor pago."},"juros":{"type":"decimal","description":"Juros pagos."},"multa":{"type":"decimal","description":"Multa paga."},"desconto":{"type":"decimal","description":"Desconto obtido."},"conta_contabil":{"type":"object","properties":{"classificacao":{"type":"string","description":"Classificação da conta contábil."},"cod_reduzido":{"type":"string","description":"Código reduzido da conta contábil."},"descricao":{"type":"string","description":"Descrição da conta contábil."}},"description":"Conta do plano contábil configurada para a categoria da conta a pagar. Vem vazia sem configuração."}}},"description":"Guias de impostos encontradas, com a situação da conta a pagar."},"timeElapsed":{"type":"string","description":"Tempo de processamento da requisição."}},"title":"GuiaImpListar (retorno)"},"contador_fechamento_PeriodoBloquear":{"type":"object","title":"PeriodoBloquear","description":"Bloqueia um período do fechamento contábil.","required":["call","param"],"properties":{"call":{"type":"string","enum":["PeriodoBloquear"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nAno":{"type":"integer","description":"Ano do período (4 dígitos). Obrigatório."},"nMes":{"type":"integer","description":"Mês do período (1 a 12). Obrigatório."},"nSemana":{"type":"integer","description":"Semana do mês (1 a 5). Obrigatória quando o período contábil do aplicativo é semanal; ignorada nos demais."},"nQuinzena":{"type":"integer","description":"Quinzena do mês (1 ou 2). Obrigatória quando o período contábil do aplicativo é quinzenal; ignorada nos demais."}},"required":["nAno","nMes"]}}},"example":{"call":"PeriodoBloquear","param":[{"nAno":2025,"nMes":1,"nSemana":0,"nQuinzena":0}]}},"contador_fechamento_PeriodoBloquear_retorno":{"type":"object","properties":{"cCodStatus":{"type":"string","description":"Código do status. \"0\" indica sucesso."},"cDescStatus":{"type":"string","description":"Descrição do status."}},"title":"PeriodoBloquear (retorno)"},"contador_fechamento_PeriodoDesbloquear":{"type":"object","title":"PeriodoDesbloquear","description":"Desbloqueia um período do fechamento contábil.","required":["call","param"],"properties":{"call":{"type":"string","enum":["PeriodoDesbloquear"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nAno":{"type":"integer","description":"Ano do período (4 dígitos). Obrigatório."},"nMes":{"type":"integer","description":"Mês do período (1 a 12). Obrigatório."},"nSemana":{"type":"integer","description":"Semana do mês (1 a 5). Obrigatória quando o período contábil do aplicativo é semanal; ignorada nos demais."},"nQuinzena":{"type":"integer","description":"Quinzena do mês (1 ou 2). Obrigatória quando o período contábil do aplicativo é quinzenal; ignorada nos demais."}},"required":["nAno","nMes"]}}},"example":{"call":"PeriodoDesbloquear","param":[{"nAno":2025,"nMes":1,"nSemana":0,"nQuinzena":0}]}},"contador_fechamento_PeriodoDesbloquear_retorno":{"type":"object","properties":{"cCodStatus":{"type":"string","description":"Código do status. \"0\" indica sucesso."},"cDescStatus":{"type":"string","description":"Descrição do status."}},"title":"PeriodoDesbloquear (retorno)"},"contador_lancamentoscontabeis_Download":{"type":"object","title":"Download","description":"Download dos Lançamentos Contábeis","required":["call","param"],"properties":{"call":{"type":"string","enum":["Download"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"mes":{"type":"integer","description":"Mês do período (1 a 12). Padrão o mês anterior ao atual."},"ano":{"type":"integer","description":"Ano do período (4 dígitos). Padrão o ano do mês anterior ao atual."},"periodo":{"type":"string","maxLength":1,"description":"Período de fechamento.\nIndica o periodo de fechamento contábil utilizado.\n\nPode ser:\n\"M\" - Mensal\n\"Q\" - Quinzenal\n\"S\" - Semanal\n\nDefault \"M\""},"semana":{"type":"string","maxLength":2,"description":"Indica qual a semana do mês será utilizada para gerar os arquivos.\n\nPode ser:\n\n\"S1\" - Primeira semana do mês\n\"S2\" - Segunda semana do mês\n\"S3\" - Terceira semana do mês\n\"S4\" - Quarta semana do mês\n\"S5\" - Quinta semana do mês\n\"S6\" - Sexta semana do mês\n\nObrigatório quando periodo for \"S\"; não pode ser preenchido nos demais."},"quinzena":{"type":"string","maxLength":2,"description":"Indica qual quinzena do mês será utilizada para gerar os arquivos.\n\nPode ser:\n\n\"Q1\" - Primeira quinzena do mês\n\"Q2\" - Segunda quinzena do mês\n\nObrigatório quando periodo for \"Q\"; não pode ser preenchido nos demais."},"layout":{"type":"string","maxLength":20,"description":"Código do layout contábil (ver ListarLayoutContabil), ex. \"SCI2\".\nAceita só SCI1, SCI2, TRON1, FORTES1, JBSOFTWARE1, CONTMATIC1 e CONTMATIC2.\nSem preenchimento, usa o layout configurado no painel do contador."},"exportarLancContabeis":{"type":"string","maxLength":1,"description":"Exportar os lançamentos contábeis - \"S\" ou \"N\". Padrão \"S\"."},"exportarLancFiscais":{"type":"string","maxLength":1,"description":"Exportar os lançamentos fiscais - \"S\" ou \"N\". Padrão \"S\"."},"exportarNfeEmitidas":{"type":"string","maxLength":1,"description":"Exportar os XMLs das NF-e emitidas - \"S\" ou \"N\". Padrão \"N\"."},"exportarNfeRecebidas":{"type":"string","maxLength":1,"description":"Exportar os XMLs das NF-e recebidas - \"S\" ou \"N\". Padrão \"N\"."},"exportarCteRecebidos":{"type":"string","maxLength":1,"description":"Exportar os XMLs dos CT-e recebidos - \"S\" ou \"N\". Padrão \"N\"."},"exportarNfceSatEmitidas":{"type":"string","maxLength":1,"description":"Exportar os XMLs das NFC-e e SAT emitidos - \"S\" ou \"N\". Padrão \"N\"."},"exportarSpedEfd":{"type":"string","maxLength":1,"description":"Gerar o SPED EFD ICMS/IPI - \"S\" ou \"N\". Padrão \"S\"."},"exportarSpedContrib":{"type":"string","maxLength":1,"description":"Gerar o SPED Contribuições - \"S\" ou \"N\". Padrão \"N\"."},"exportarSintegra":{"type":"string","maxLength":1,"description":"Gerar o arquivo do Sintegra - \"S\" ou \"N\". Padrão \"N\"."},"exportarNfts":{"type":"string","maxLength":1,"description":"Exportar as NFTS (notas fiscais de tomador de serviço) - \"S\" ou \"N\". Padrão \"N\"."},"assincrono":{"type":"string","maxLength":1,"description":"Indica se deve exportar os arquivos de forma assíncrona - preencher com \"S\" ou \"N\" (por padrão \"N\")"},"blocoHSpedEFD":{"type":"string","maxLength":1,"description":"Indica se deve gerar ou não o Bloco H para o SPED EFD (ICMS IPI).\n\nPreencher com S/N"}}}}},"example":{"call":"Download","param":[{"mes":1,"ano":2025,"periodo":"M","semana":"","quinzena":"","layout":"SCI2","exportarLancContabeis":"S","exportarLancFiscais":"S","exportarSpedEfd":"N","assincrono":"S"}]}},"contador_lancamentoscontabeis_Download_retorno":{"type":"object","properties":{"linkArqExport":{"type":"string","description":"Link para download do arquivo com os lançamentos contábeis e fiscais no layout do sistema contábil. Expira em 1 dia."},"linkNFeEmitida":{"type":"string","description":"Link para download dos XMLs das NF-e emitidas. Expira em 1 dia."},"linkNFeRecebida":{"type":"string","description":"Link para download dos XMLs das NF-e recebidas. Expira em 1 dia."},"linkCTeRecebido":{"type":"string","description":"Link para download dos XMLs dos CT-e recebidos. Expira em 1 dia."},"linkNFCeSatEmitida":{"type":"string","description":"Link para download dos XMLs das NFC-e e SAT emitidos. Expira em 1 dia."},"linkSpedEfd":{"type":"string","description":"Link para download do SPED EFD ICMS/IPI. Expira em 1 dia."},"linkSpedContrib":{"type":"string","description":"Link para download do SPED Contribuições. Expira em 1 dia."},"linkSintegra":{"type":"string","description":"Link para download do arquivo do Sintegra. Expira em 1 dia."},"idLayout":{"type":"string","description":"Código do layout contábil usado na geração."},"linkNFTS":{"type":"string","description":"Link para download das NFTS. Expira em 1 dia."},"mes":{"type":"integer","description":"Mês do período gerado."},"ano":{"type":"integer","description":"Ano do período gerado."},"timeElapsed":{"type":"string","description":"Tempo de processamento da geração. Vazio enquanto a geração assíncrona não terminou."},"statusArqExport":{"type":"string","description":"Status do Arquivo com os Lançamentos Contábeis. Pode ser: \"working\" - Indica que o arquivo está em processamento. \"done\" - Indica que o arquivo está disponível para download. \"noinfo\" - Indica que não há movimento no período para este arquivo. \"error > motivo\" - Indica que ocorreu um erro no processamento, seguido do motivo. Vazio quando o arquivo não foi pedido."},"statusNFeEmitida":{"type":"string","description":"Status do Arquivo com os XML das NF-e Emitidas. Pode ser: \"working\" - Indica que o arquivo está em processamento. \"done\" - Indica que o arquivo está disponível para download. \"noinfo\" - Indica que não há movimento no período para este arquivo. \"error > motivo\" - Indica que ocorreu um erro no processamento, seguido do motivo. Vazio quando o arquivo não foi pedido."},"statusNFeRecebida":{"type":"string","description":"Status do Arquivo com os XML das NF-e Recebidas. Pode ser: \"working\" - Indica que o arquivo está em processamento. \"done\" - Indica que o arquivo está disponível para download. \"noinfo\" - Indica que não há movimento no período para este arquivo. \"error > motivo\" - Indica que ocorreu um erro no processamento, seguido do motivo. Vazio quando o arquivo não foi pedido."},"statusCTeRecebido":{"type":"string","description":"Status do Arquivo com os XML dos CT-e Recebidos Pode ser: \"working\" - Indica que o arquivo está em processamento. \"done\" - Indica que o arquivo está disponível para download. \"noinfo\" - Indica que não há movimento no período para este arquivo. \"error > motivo\" - Indica que ocorreu um erro no processamento, seguido do motivo. Vazio quando o arquivo não foi pedido."},"statusNFCeSatEmitida":{"type":"string","description":"Status do Arquivo com os XML das NFC-e e SAT Emitidas. Pode ser: \"working\" - Indica que o arquivo está em processamento. \"done\" - Indica que o arquivo está disponível para download. \"noinfo\" - Indica que não há movimento no período para este arquivo. \"error > motivo\" - Indica que ocorreu um erro no processamento, seguido do motivo. Vazio quando o arquivo não foi pedido."},"statusSpedEfd":{"type":"string","description":"Status do Arquivo com os blocos do SPED EFD. Pode ser: \"working\" - Indica que o arquivo está em processamento. \"done\" - Indica que o arquivo está disponível para download. \"noinfo\" - Indica que não há movimento no período para este arquivo. \"error > motivo\" - Indica que ocorreu um erro no processamento, seguido do motivo. Vazio quando o arquivo não foi pedido."},"statusSpedContrib":{"type":"string","description":"Status do Arquivo com os blocos do SPED Contribuições. Pode ser: \"working\" - Indica que o arquivo está em processamento. \"done\" - Indica que o arquivo está disponível para download. \"noinfo\" - Indica que não há movimento no período para este arquivo. \"error > motivo\" - Indica que ocorreu um erro no processamento, seguido do motivo. Vazio quando o arquivo não foi pedido."},"statusSintegra":{"type":"string","description":"Status do Arquivo com os blocos do SINTEGRA. Pode ser: \"working\" - Indica que o arquivo está em processamento. \"done\" - Indica que o arquivo está disponível para download. \"noinfo\" - Indica que não há movimento no período para este arquivo. \"error > motivo\" - Indica que ocorreu um erro no processamento, seguido do motivo. Vazio quando o arquivo não foi pedido."},"statusNFTS":{"type":"string","description":"Status do Arquivo com os registros das NFTS. Pode ser: \"working\" - Indica que o arquivo está em processamento. \"done\" - Indica que o arquivo está disponível para download. \"noinfo\" - Indica que não há movimento no período para este arquivo. \"error > motivo\" - Indica que ocorreu um erro no processamento, seguido do motivo. Vazio quando o arquivo não foi pedido."},"cMsgStatus":{"type":"string","description":"Retorno do status do processamento dos arquivos."}},"title":"Download (retorno)"},"contador_layoutcontabil_ListarLayoutContabil":{"type":"object","title":"ListarLayoutContabil","description":"Realiza a listagem dos Layouts Contábeis.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarLayoutContabil"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página a retornar. Padrão 1."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Número de registros por página. Padrão 100, máximo 100."}}}}},"example":{"call":"ListarLayoutContabil","param":[{"nPagina":1,"nRegPorPagina":50}]}},"contador_layoutcontabil_ListarLayoutContabil_retorno":{"type":"object","properties":{"nPagina":{"type":"integer","description":"Número da página retornada."},"nTotPaginas":{"type":"integer","description":"Número total de páginas."},"nRegistros":{"type":"integer","description":"Número de registros retornados nesta página."},"nTotRegistros":{"type":"integer","description":"Total de registros encontrados."},"ListaLayout":{"type":"array","items":{"type":"object","properties":{"cCodLayout":{"type":"string","description":"Código do Layout Contábil (ex. SCI1). É o valor do campo layout nas APIs de exportação e de guias."},"cDescricao":{"type":"string","description":"Descrição do Layout Contábil."},"cInativo":{"type":"string","description":"Indica se o Layout Contábil está inativo. Pode ser \"S\" ou \"N\"."}}},"description":"Lista de Layouts Contábeis."}},"title":"ListarLayoutContabil (retorno)"},"contador_planocontabil_UpsertPlanoContas":{"type":"object","title":"UpsertPlanoContas","description":"Inclui, atualiza ou substitui as contas do plano de contas contábil.","required":["call","param"],"properties":{"call":{"type":"string","enum":["UpsertPlanoContas"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"acao":{"type":"string","maxLength":15,"description":"Ação sobre o plano de contas.\n\n\"UPSERT\" - Inclui as contas novas e atualiza as existentes (padrão).\n\"REPLACE\" - Substitui o plano: exclui as contas que não vierem. Recusado se houver configuração contábil.\n\"FORCE_REPLACE\" - Substitui o plano e exclui as configurações contábeis ligadas. Irreversível."},"conta":{"type":"array","items":{"type":"object","properties":{"cod_int":{"type":"string","maxLength":30,"description":"Código de integração da conta (chave para localizar a conta existente). Obrigatório."},"classificacao":{"type":"string","maxLength":60,"description":"Classificação da conta (ex. 1.1.01.001). Obrigatória."},"cod_reduzido":{"type":"string","maxLength":20,"description":"Código reduzido da conta. Obrigatório."},"descricao":{"type":"string","maxLength":60,"description":"Descrição da conta contábil. Obrigatória."},"tipo":{"type":"string","maxLength":1,"description":"Tipo da conta. Obrigatório.\n\n\"T\" ou \"S\" - Totalizadora (sintética).\n\"A\" - Analítica (recebe lançamentos)."},"d_c":{"type":"string","maxLength":1,"description":"Natureza da Conta (Credora ou Devedora) - preencher com D ou C."},"natureza_sped":{"type":"string","maxLength":2,"description":"Código da Natureza (SPED) - preencher com 01, 02, 03, 04, 05 ou 09."},"cnpj_cpf":{"type":"string","maxLength":20,"description":"CNPJ/CPF do Cliente ou Fornecedor (se for específico para um cliente ou fornecedor)"},"enviar_cnpj_cpf":{"type":"string","maxLength":1,"description":"Indica se a conta envia o CNPJ/CPF do cliente ou fornecedor na exportação - preencher com S ou N."},"centro_custo":{"type":"string","maxLength":1,"description":"Indica se a conta deve integrar os lançamentos de Centros de Custos - preencher com S ou N"}},"required":["classificacao","cod_int","cod_reduzido","descricao","tipo"]},"description":"Lista de contas contábeis a incluir ou atualizar. Obrigatória."}}}}},"example":{"call":"UpsertPlanoContas","param":[{"acao":"UPSERT","conta":[{"cod_int":"1","classificacao":"1","cod_reduzido":"1","descricao":"ATIVO","tipo":"T","d_c":"D","natureza_sped":"01","cnpj_cpf":"","enviar_cnpj_cpf":"N","centro_custo":"N"},{"cod_int":"5","classificacao":"1.1.01.001","cod_reduzido":"5","descricao":"Banco do Brasil 1234 12345-2","tipo":"A","d_c":"D","natureza_sped":"01","cnpj_cpf":"","enviar_cnpj_cpf":"N","centro_custo":"N"}]}]}},"contador_planocontabil_UpsertPlanoContas_retorno":{"type":"object","properties":{"cCodStatus":{"type":"string","description":"Código do status. \"0\" indica sucesso."},"cDesStatus":{"type":"string","description":"Descrição do status."},"timeElapsed":{"type":"string","description":"Tempo de processamento da requisição."}},"title":"UpsertPlanoContas (retorno)"},"contador_planocontas_ListarPlanoContas":{"type":"object","title":"ListarPlanoContas","description":"Realiza a listagem dos Planos de Contas.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarPlanoContas"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página a retornar. Padrão 1."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Número de registros por página. Padrão 100, máximo 100."}}}}},"example":{"call":"ListarPlanoContas","param":[{"nPagina":1,"nRegPorPagina":50}]}},"contador_planocontas_ListarPlanoContas_retorno":{"type":"object","properties":{"nPagina":{"type":"integer","description":"Número da página retornada."},"nTotPaginas":{"type":"integer","description":"Número total de páginas."},"nRegistros":{"type":"integer","description":"Número de registros retornados nesta página."},"nTotRegistros":{"type":"integer","description":"Total de registros encontrados."},"listaPlanoContas":{"type":"array","items":{"type":"object","properties":{"nIdConta":{"type":"integer","description":"Id interno da conta contábil (é o nIdConta usado na configuração de categorias)."},"cClassif":{"type":"string","description":"Classificação do Plano de Conta."},"cCodRed":{"type":"string","description":"Código reduzido do Plano de Conta."},"cDescricao":{"type":"string","description":"Descrição do Plano de Conta."},"cCodNaturezaSped":{"type":"string","description":"Código da Natureza do Plano de Conta no SPED."},"cDescNaturezaSped":{"type":"string","description":"Descrição da Natureza do Plano de Conta no SPED."},"cIntegrarCentroCusto":{"type":"string","description":"Indica se o Plano de Conta integra centro de custo. Pode ser \"S\" ou \"N\"."},"cEnviarDocCliente":{"type":"string","description":"Indica se o Plano de Conta envia CNPJ ou CPF do cliente. Pode ser \"S\" ou \"N\"."},"cNaturezaOp":{"type":"string","description":"Natureza da Operação do Plano de Conta. \"C\" indica Credora. \"D\" indica Devedora."},"cTipoConta":{"type":"string","description":"Tipo do Plano de Conta. \"T\" indica Totalizadora (Sintética). \"A\" indica Analítica."}}},"description":"Lista de Plano de Contas"}},"title":"ListarPlanoContas (retorno)"},"contador_resumo_ObterResumoContador":{"type":"object","title":"ObterResumoContador","description":"Obtem o resumo do painel do contador.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterResumoContador"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"dDataInicio":{"type":"string","maxLength":10,"description":"Data Inicial de Consulta."},"dDataFim":{"type":"string","maxLength":10,"description":"Data final de Consulta."}}}}},"example":{"call":"ObterResumoContador","param":[{"dDataInicio":"","dDataFim":""}]}},"contador_resumo_ObterResumoContador_retorno":{"type":"object","properties":{"dDataInicio":{"type":"string","description":"Data Inicial de Consulta."},"dDataFim":{"type":"string","description":"Data final de Consulta."},"listaFechamentoContabil":{"type":"array","items":{"type":"object","properties":{"dDataInicio":{"type":"string","description":"Data Inicial de Consulta."},"dDataFim":{"type":"string","description":"Data final de Consulta."},"cSituacao":{"type":"string","description":"Indica a situção do fechamento contábil."},"cAno":{"type":"string","description":"Ano do fechamento contábil."},"cMes":{"type":"string","description":"Mês do fechamento contábil."},"cLayout":{"type":"string","description":"Layout do sistema contábil."},"dEmail":{"type":"string","description":"Data do envio de e-mail do fechamento contábil."},"dBloqueado":{"type":"string","description":"Data de bloqueio do fechamento contábil."},"uBloqueado":{"type":"string","description":"Indica o usuário que realizou o bloqueio do fechameto contábil."},"cPeriodo":{"type":"string","description":"Período de Fechamento contábil. Pode ser: Semanal Mensal Quinzenal"}}}}},"title":"ObterResumoContador (retorno)"},"contador_xml_ListarDocumentos":{"type":"object","title":"ListarDocumentos","description":"Lista de XMLs de Documentos Fiscais.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarDocumentos"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15},"nRegPorPagina":{"type":"integer","maxLength":15},"cModelo":{"type":"string","maxLength":2,"description":"Modelo do Documento Fiscal:\n\nPode ser:\n\n00 - ECF\n65 - NFC-e\n59 - CF-e SAT\n55 - NF-e\n57 - CT-e\n67 - CT-e OS\n99 - NFS-e"},"cOperacao":{"type":"string","maxLength":1,"description":"Tipo de Operação do Documento Fiscal.\n\nPode ser:\n\n0 - Entrada.\n1 - Saída (Default)."},"cAmbiente":{"type":"string","maxLength":1,"description":"Ambiente do Documento Fiscal.\n\nPode ser:\n\nH - Homologação.\nP - Produção (Default)."},"dEmiInicial":{"type":"string","maxLength":10,"description":"Data de emissão inicial do Documento Fiscal."},"dEmiFinal":{"type":"string","maxLength":10,"description":"Data de emissão final do Documento Fiscal."},"hEmiInicial":{"type":"string","maxLength":8,"description":"Hora de emissão inicial  do Documento Fiscal."},"hEmiFinal":{"type":"string","maxLength":8,"description":"Hora de emissão final do Documento Fiscal."},"dDtIncInicial":{"type":"string","maxLength":10,"description":"Data de Inclusão inicial do Documento Fiscal."},"dDtIncFinal":{"type":"string","maxLength":10,"description":"Data de Inclusão final do Documento Fiscal."},"cHrIncInicial":{"type":"string","maxLength":8,"description":"Hora de Inclusão inicial do Documento Fiscal."},"cHrIncFinal":{"type":"string","maxLength":8,"description":"Hora de Inclusão final do Documento Fiscal."},"nDocInicial":{"type":"integer","maxLength":15,"description":"Número do Documento Inicial do Documento Fiscal."},"nDocFinal":{"type":"integer","maxLength":15,"description":"Número do Documento Final do Documento Fiscal."},"cSerie":{"type":"string","maxLength":5,"description":"Série do Documento Fiscal."},"nChave":{"type":"string","maxLength":44,"description":"Chave da Documento Fiscal."},"nIdCupom":{"type":"integer","maxLength":15,"description":"ID do Cupom Fiscal (Para NFC-e / CF-e SAT e ECF)."},"nIdNF":{"type":"integer","maxLength":15,"description":"ID da Nota Fiscal (para NF-e / NFS-e)."},"nIdCT":{"type":"integer","maxLength":15,"description":"ID do Conhecimento de Transporte (Para  CT-e / CT-e OS)."},"nIdPedido":{"type":"integer","maxLength":15,"description":"ID do Pedido de Compra/Venda."},"nIdOS":{"type":"integer","maxLength":15,"description":"ID da Ordem de Serviço."},"nIdReceb":{"type":"integer","maxLength":15,"description":"Id do Recebimento da Nota."}},"required":["cModelo"]}}},"example":{"call":"ListarDocumentos","param":[{"nPagina":1,"nRegPorPagina":20,"cModelo":"55","dEmiInicial":"","dEmiFinal":""}]}},"contador_xml_ListarDocumentos_retorno":{"type":"object","properties":{"nIdProduto":{"type":"integer"},"nPagina":{"type":"integer"},"nRegPorPagina":{"type":"integer"},"nRegistros":{"type":"integer"},"nTotRegistros":{"type":"integer"},"documentosEncontrados":{"type":"array","items":{"type":"object","properties":{"nNumero":{"type":"string","description":"Número do Documento Fiscal."},"cSerie":{"type":"string","description":"Série do Documento Fiscal."},"nChave":{"type":"string","description":"Chave da Documento Fiscal."},"dEmissao":{"type":"string","description":"Data de emissão do Documento Fiscal."},"hEmissao":{"type":"string","description":"Hora de emissão do Documento Fiscal."},"nValor":{"type":"decimal","description":"Valor do Documento Fiscal."},"cXml":{"type":"string","description":"XML do Documento Fiscal."},"nIdCupom":{"type":"integer","description":"ID do Cupom Fiscal (Para NFC-e / CF-e SAT e ECF)."},"nIdNF":{"type":"integer","description":"ID da Nota Fiscal (para NF-e / NFS-e)."},"nIdCT":{"type":"integer","description":"ID do Conhecimento de Transporte (Para CT-e / CT-e OS)."},"nIdPedido":{"type":"integer","description":"ID do Pedido de Compra/Venda."},"nIdOS":{"type":"integer","description":"ID da Ordem de Serviço."},"nIdReceb":{"type":"integer","description":"Id do Recebimento da Nota."},"cStatus":{"type":"string","description":"Status do Documento Fiscal. Pode ser: 00 - Autorizado 10 - Cancelado 20 - Denegado 30 - Devolvido 40 - Pendente (Documento em processo de faturamento)"}}},"description":"Lista de XMLs dos documentos encontrados."}},"title":"ListarDocumentos (retorno)"},"crm_adicionaroportunidade_AdicionarOp":{"type":"object","title":"AdicionarOp","description":"Inclusão de uma Oportunidade.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AdicionarOp"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cCodIntOp":{"type":"string","description":"Código de integração da oportunidade. Obrigatório e único no aplicativo.\nTambém é usado como código de integração da conta e do contato quando eles não trazem o seu.\n(Utilizado em cadastros incluídos via API, não é visualizado na tela)"},"cDadosOp":{"type":"string","description":"Texto com um JSON (começando com \"{\" e terminando com \"}\") com a estrutura da Oportunidade, da conta e do contato do CRM. Obrigatório.\n\nBlocos:\nidentificacao - cDesOp (nome), nCodContato, nCodConta, nCodVendedor, nCodSolucao (obrigatório) e nCodOrigem (obrigatório).\nobservacoes - cObs.\nfasesStatus - nCodFase, nCodStatus e dNovoLead (dd/mm/aaaa).\noutrasInf - nCodTipo e cOrigem.\nconta - identificacao (cCodInt, cNome obrigatório, cObs, nCodVendedor, cDoc), endereco (cEndereco, cCidade, cUF, cPais) e telefone_email (cDDDTel, cNumTel, cEmail, cWebsite).\ncontato - identificacao (cCodInt, cNome obrigatório, cSobrenome, nCodVendedor, nCodConta), endereco e telefone_email.\nvendedor - cEmail (localiza o vendedor pelo e-mail).\n\nCaso a Conta e Contato informados nas tags [conta] e [contato] não estejam cadastrados, seu cadastro será efetuado automaticamente; se o cadastro já existir para o Código de integração, E-mail ou Nome, a Conta e o Contato existentes são usados na Oportunidade."}},"required":["cDadosOp"]}}},"example":{"call":"AdicionarOp","param":[{"cCodIntOp":"OP-2025-0001","cDadosOp":"{\"identificacao\": {\"cDesOp\": \"Implantação ERP - Padaria Pão Dourado\", \"nCodContato\": 0, \"nCodConta\": 0, \"nCodVendedor\": 4562342071, \"nCodSolucao\": 4561522783, \"nCodOrigem\": 4561265881}, \"observacoes\": {\"cObs\": \"Oportunidade incluída via API\"}, \"fasesStatus\": {\"nCodFase\": 4564827911}, \"outrasInf\": {\"nCodTipo\": 4564138281, \"cOrigem\": \"\"}, \"conta\": {\"identificacao\": {\"cCodInt\": \"CTA-1001\", \"cNome\": \"Padaria Pão Dourado Ltda\", \"cObs\": \"Conta incluída via API\", \"nCodVendedor\": 4562342071}, \"endereco\": {\"cEndereco\": \"Rua das Flores, 100\", \"cCidade\": \"São Paulo\", \"cUF\": \"SP\", \"cPais\": \"Brasil\"}, \"telefone_email\": {\"cDDDTel\": \"11\", \"cNumTel\": \"99999-9999\", \"cEmail\": \"contato@paodourado.com.br\", \"cWebsite\": \"\"}}, \"contato\": {\"identificacao\": {\"cCodInt\": \"CTT-1001\", \"cNome\": \"Maria\", \"cSobrenome\": \"Souza\", \"nCodVendedor\": 4562342071, \"nCodConta\": 0}, \"endereco\": {\"cEndereco\": \"Rua das Flores, 100\", \"cCidade\": \"São Paulo\", \"cUF\": \"SP\", \"cPais\": \"Brasil\"}, \"telefone_email\": {\"cDDDTel\": \"11\", \"cNumTel\": \"98888-7777\", \"cEmail\": \"maria@paodourado.com.br\", \"cWebsite\": \"\"}}}"}]}},"crm_adicionaroportunidade_AdicionarOp_retorno":{"type":"object","properties":{"nCodOp":{"type":"integer","description":"Código da oportunidade incluída."},"cCodIntOp":{"type":"string","description":"Código de integração da oportunidade incluída."},"cCodStatus":{"type":"string","description":"Código do status. \"0\" indica sucesso."},"cDesStatus":{"type":"string","description":"Descrição do status."}},"title":"AdicionarOp (retorno)"},"crm_concorrentes_ListarConcorrentes":{"type":"object","title":"ListarConcorrentes","description":"Concorrentes da oportunidade.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarConcorrentes"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"apenas_importado_api":{"type":"string","maxLength":1,"description":"Exibir apenas os registros gerados pela API."},"ordenar_por":{"type":"string","maxLength":100,"example":"CODIGO","description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"example":"S","description":"Se a lista será apresentada em ordem decrescente."}}}}},"example":{"call":"ListarConcorrentes","param":[{"pagina":1,"registros_por_pagina":20}]}},"crm_concorrentes_ListarConcorrentes_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada."},"total_de_paginas":{"type":"integer","description":"Número total de páginas."},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"Total de registros encontrados."},"cadastros":{"type":"array","items":{"type":"object","properties":{"nCodigo":{"type":"integer","description":"Código do concorrente de oportunidade."},"cDescricao":{"type":"string","description":"Descrição do concorrente de oportunidade."},"cObservacao":{"type":"string","description":"Observação do concorrente de oportunidade."}}},"description":"Lista os cadastros encontrados."}},"title":"ListarConcorrentes (retorno)"},"crm_contas_AlterarConta":{"type":"object","title":"AlterarConta","description":"Altera uma conta do CRM.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarConta"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"identificacao":{"type":"object","properties":{"nCod":{"type":"integer","maxLength":15,"description":"Código da Conta"},"cCodInt":{"type":"string","description":"Código de Integração"},"cNome":{"type":"string","maxLength":100,"description":"Nome da Conta"},"cNomeFantasia":{"type":"string","maxLength":100,"description":"Nome fantasia da conta"},"cDoc":{"type":"string","maxLength":30,"description":"Número do Documento: CNPJ ou CPF."},"nCodVend":{"type":"integer","maxLength":15,"description":"Código do Vendedor"},"nCodVert":{"type":"integer","maxLength":15,"description":"Código da Vertical"},"nCodTelemkt":{"type":"integer","maxLength":15,"description":"Código do Telemarketing"},"dDtReg":{"type":"string","maxLength":10,"description":"Data de Registro"},"dDtValid":{"type":"string","maxLength":10,"description":"Data de Validade da Reserva"},"cObs":{"type":"string","description":"Observação"}},"description":"Identificação da conta"},"endereco":{"type":"object","properties":{"cEndereco":{"type":"string","maxLength":200,"description":"Endereço"},"cCompl":{"type":"string","maxLength":200,"description":"Complemento do Endereço"},"cCEP":{"type":"string","maxLength":10,"description":"CEP"},"cBairro":{"type":"string","maxLength":60,"description":"Bairro"},"cCidade":{"type":"string","maxLength":50,"description":"Cidade"},"cUF":{"type":"string","maxLength":50,"description":"Estado"},"cPais":{"type":"string","maxLength":50,"description":"País"}},"description":"Endereço da conta"},"telefone_email":{"type":"object","properties":{"cDDDTel":{"type":"string","maxLength":5,"description":"DDD do Telefone"},"cNumTel":{"type":"string","maxLength":15,"description":"Número do Telefone"},"cDDDFax":{"type":"string","maxLength":5,"description":"DDD do Fax"},"cNumFax":{"type":"string","maxLength":15,"description":"Número do Fax"},"cEmail":{"type":"string","maxLength":200,"description":"E-Mail"},"cWebsite":{"type":"string","maxLength":100,"description":"Website"}},"description":"Informações de contato com a conta"},"informacoesAdicionais":{"type":"object","properties":{"nNumFunc":{"type":"integer","maxLength":6,"description":"Número de Funcionários"},"nFaixaFat":{"type":"string","maxLength":100,"description":"Faixa de Faturamento"},"cCnae":{"type":"string"},"cRegTrib":{"type":"string"}},"description":"Informações adicionais da conta"},"tags":{"type":"array","items":{"type":"object","properties":{"tag":{"type":"string","maxLength":50,"description":"Tag da conta"}}},"description":"Tags da conta"},"caracteristicas":{"type":"array","items":{"type":"object","properties":{"campo":{"type":"string","maxLength":30,"description":"Nome da característica.\n\nCaso não encontre a característica um novo cadastro será adicionado."},"conteudo":{"type":"string","maxLength":60,"description":"Conteúdo da característica.\n\n\nCaso o valor desse campo não seja informado a característica\nserá excluída da conta."}}},"description":"Características da conta"},"contatos":{"type":"array","items":{"type":"object","properties":{"alt_data":{"type":"string","maxLength":10,"description":"Data da Alteração"},"alt_hora":{"type":"string","maxLength":8,"description":"Hora da Alteração"},"alt_user":{"type":"string","maxLength":10,"description":"Usuário da Alteração"},"inc_data":{"type":"string","maxLength":10,"description":"Data de Inclusão"},"inc_hora":{"type":"string","maxLength":8,"description":"Hora de Inclusão"},"inc_user":{"type":"string","maxLength":10,"description":"Usuário da Inclusão"},"cod_int":{"type":"string","description":"Código de Integração com sistemas legados."},"bairro":{"type":"string","maxLength":60,"description":"Bairro"},"cargo":{"type":"string","maxLength":60,"description":"Cargo"},"ws_api":{"type":"string","maxLength":1,"example":"S","description":"Gerado da API (S/N)"},"celular1":{"type":"string","maxLength":15,"description":"Celular 1"},"celular2":{"type":"string","maxLength":15,"description":"Celular 2"},"cep":{"type":"string","maxLength":10,"description":"CEP"},"cidade":{"type":"string","maxLength":50,"description":"Cidade"},"data":{"type":"string","maxLength":10,"description":"Data Nascimento"},"ddd_cel1":{"type":"string","maxLength":5,"description":"DDD Celular 1"},"ddd_cel2":{"type":"string","maxLength":5,"description":"DDD Celular 2"},"ddd_fax":{"type":"string","maxLength":5,"description":"DDD Fax"},"ddd_tel":{"type":"string","maxLength":5,"description":"DDD Telefone"},"email":{"type":"string","maxLength":200,"description":"Email"},"endereco":{"type":"string","maxLength":200,"description":"Endereço"},"endereco_c":{"type":"string","maxLength":200,"description":"Endereço Complemento"},"fax":{"type":"string","maxLength":15,"description":"Fax"},"id":{"type":"integer","maxLength":15,"description":"ID do Contato"},"id_conta":{"type":"integer","maxLength":15,"description":"Conta"},"id_img":{"type":"integer","maxLength":15,"description":"ID da Imagem"},"id_telemkt":{"type":"integer","maxLength":15,"description":"Telemarketing"},"id_vend":{"type":"integer","maxLength":15,"description":"Pertence a"},"img_padr":{"type":"string","maxLength":1,"description":"Indica se é uma Imagem Default"},"latlng":{"type":"string","maxLength":50,"description":"Latitude / Longitude do Endereço"},"mapaurl":{"type":"string","description":"Endereço URL do mapa"},"nome":{"type":"string","maxLength":60,"description":"Nome"},"nome_compl":{"type":"string","maxLength":120,"description":"Nome Completo do Usuário"},"observacao":{"type":"string","description":"Observação"},"pais":{"type":"string","maxLength":50,"description":"País"},"sobrenome":{"type":"string","maxLength":60,"description":"Sobrenome"},"telefone":{"type":"string","maxLength":15,"description":"Telefone"},"trial":{"type":"string","maxLength":1,"example":"S","description":"Provisionamento Trial [S/N]"},"uf":{"type":"string","maxLength":50,"description":"Estado/Província"},"website":{"type":"string","maxLength":100,"description":"WebSite"}}},"description":"Contatos da Conta"}}}}},"example":{"call":"AlterarConta","param":[{"identificacao":{"cCodInt":"27022","cNome":"Omiexperience S/A","cObs":"Conta adicionada via API","dDtReg":"30/09/2026","dDtValid":"08/03/2027"},"endereco":{"cEndereco":"Av. Dr. Chucri Zaidan, 1550","cCEP":"04583-110","cCidade":"SAO PAULO","cUF":"SP","cPais":"Brasil"},"telefone_email":{"cDDDTel":"11","cNumTel":"5171-8888","cEmail":"ajuda@omie.com.br","cWebsite":"http://www.omie.com.br/"}}]}},"crm_contas_AlterarConta_retorno":{"type":"object","properties":{"nCod":{"type":"integer","description":"Código da Conta"},"cCodInt":{"type":"string","description":"Código de Integração"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDesStatus":{"type":"string","description":"Descrição do Status"}},"title":"AlterarConta (retorno)"},"crm_contas_ConsultarConta":{"type":"object","title":"ConsultarConta","description":"Consulta uma conta do CRM.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarConta"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCod":{"type":"integer","maxLength":15,"description":"Código da Conta"},"cCodInt":{"type":"string","description":"Código de Integração"}}}}},"example":{"call":"ConsultarConta","param":[{"cCodInt":"0004"}]}},"crm_contas_ConsultarConta_retorno":{"type":"object","properties":{"identificacao":{"type":"object","properties":{"nCod":{"type":"integer","description":"Código da Conta"},"cCodInt":{"type":"string","description":"Código de Integração"},"cNome":{"type":"string","description":"Nome da Conta"},"cNomeFantasia":{"type":"string","description":"Nome fantasia da conta"},"cDoc":{"type":"string","description":"Número do Documento: CNPJ ou CPF."},"nCodVend":{"type":"integer","description":"Código do Vendedor"},"nCodVert":{"type":"integer","description":"Código da Vertical"},"nCodTelemkt":{"type":"integer","description":"Código do Telemarketing"},"dDtReg":{"type":"string","description":"Data de Registro"},"dDtValid":{"type":"string","description":"Data de Validade da Reserva"},"cObs":{"type":"string","description":"Observação"}},"description":"Identificação da conta"},"endereco":{"type":"object","properties":{"cEndereco":{"type":"string","description":"Endereço"},"cCompl":{"type":"string","description":"Complemento do Endereço"},"cCEP":{"type":"string","description":"CEP"},"cBairro":{"type":"string","description":"Bairro"},"cCidade":{"type":"string","description":"Cidade"},"cUF":{"type":"string","description":"Estado"},"cPais":{"type":"string","description":"País"}},"description":"Endereço da conta"},"telefone_email":{"type":"object","properties":{"cDDDTel":{"type":"string","description":"DDD do Telefone"},"cNumTel":{"type":"string","description":"Número do Telefone"},"cDDDFax":{"type":"string","description":"DDD do Fax"},"cNumFax":{"type":"string","description":"Número do Fax"},"cEmail":{"type":"string","description":"E-Mail"},"cWebsite":{"type":"string","description":"Website"}},"description":"Informações de contato com a conta"},"informacoesAdicionais":{"type":"object","properties":{"nNumFunc":{"type":"integer","description":"Número de Funcionários"},"nFaixaFat":{"type":"string","description":"Faixa de Faturamento"},"cCnae":{"type":"string"},"cRegTrib":{"type":"string"}},"description":"Informações adicionais da conta"},"tags":{"type":"array","items":{"type":"object","properties":{"tag":{"type":"string","description":"Tag da conta"}}},"description":"Tags da conta"},"caracteristicas":{"type":"array","items":{"type":"object","properties":{"campo":{"type":"string","description":"Nome da característica. Caso não encontre a característica um novo cadastro será adicionado."},"conteudo":{"type":"string","description":"Conteúdo da característica. Caso o valor desse campo não seja informado a característica será excluída da conta."}}},"description":"Características da conta"},"contatos":{"type":"array","items":{"type":"object","properties":{"alt_data":{"type":"string","description":"Data da Alteração"},"alt_hora":{"type":"string","description":"Hora da Alteração"},"alt_user":{"type":"string","description":"Usuário da Alteração"},"inc_data":{"type":"string","description":"Data de Inclusão"},"inc_hora":{"type":"string","description":"Hora de Inclusão"},"inc_user":{"type":"string","description":"Usuário da Inclusão"},"cod_int":{"type":"string","description":"Código de Integração com sistemas legados."},"bairro":{"type":"string","description":"Bairro"},"cargo":{"type":"string","description":"Cargo"},"ws_api":{"type":"string","description":"Gerado da API (S/N)"},"celular1":{"type":"string","description":"Celular 1"},"celular2":{"type":"string","description":"Celular 2"},"cep":{"type":"string","description":"CEP"},"cidade":{"type":"string","description":"Cidade"},"data":{"type":"string","description":"Data Nascimento"},"ddd_cel1":{"type":"string","description":"DDD Celular 1"},"ddd_cel2":{"type":"string","description":"DDD Celular 2"},"ddd_fax":{"type":"string","description":"DDD Fax"},"ddd_tel":{"type":"string","description":"DDD Telefone"},"email":{"type":"string","description":"Email"},"endereco":{"type":"string","description":"Endereço"},"endereco_c":{"type":"string","description":"Endereço Complemento"},"fax":{"type":"string","description":"Fax"},"id":{"type":"integer","description":"ID do Contato"},"id_conta":{"type":"integer","description":"Conta"},"id_img":{"type":"integer","description":"ID da Imagem"},"id_telemkt":{"type":"integer","description":"Telemarketing"},"id_vend":{"type":"integer","description":"Pertence a"},"img_padr":{"type":"string","description":"Indica se é uma Imagem Default"},"latlng":{"type":"string","description":"Latitude / Longitude do Endereço"},"mapaurl":{"type":"string","description":"Endereço URL do mapa"},"nome":{"type":"string","description":"Nome"},"nome_compl":{"type":"string","description":"Nome Completo do Usuário"},"observacao":{"type":"string","description":"Observação"},"pais":{"type":"string","description":"País"},"sobrenome":{"type":"string","description":"Sobrenome"},"telefone":{"type":"string","description":"Telefone"},"trial":{"type":"string","description":"Provisionamento Trial [S/N]"},"uf":{"type":"string","description":"Estado/Província"},"website":{"type":"string","description":"WebSite"}}},"description":"Contatos da Conta"}},"title":"ConsultarConta (retorno)"},"crm_contas_ExcluirConta":{"type":"object","title":"ExcluirConta","description":"Exclui uma conta do CRM.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirConta"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCod":{"type":"integer","maxLength":15,"description":"Código da Conta"},"cCodInt":{"type":"string","description":"Código de Integração"}}}}},"example":{"call":"ExcluirConta","param":[{"nCod":0,"cCodInt":""}]}},"crm_contas_ExcluirConta_retorno":{"type":"object","properties":{"nCod":{"type":"integer","description":"Código da Conta"},"cCodInt":{"type":"string","description":"Código de Integração"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDesStatus":{"type":"string","description":"Descrição do Status"}},"title":"ExcluirConta (retorno)"},"crm_contas_IncluirConta":{"type":"object","title":"IncluirConta","description":"Inclui uma conta no CRM.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirConta"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"identificacao":{"type":"object","properties":{"nCod":{"type":"integer","maxLength":15,"description":"Código da Conta"},"cCodInt":{"type":"string","description":"Código de Integração"},"cNome":{"type":"string","maxLength":100,"description":"Nome da Conta"},"cNomeFantasia":{"type":"string","maxLength":100,"description":"Nome fantasia da conta"},"cDoc":{"type":"string","maxLength":30,"description":"Número do Documento: CNPJ ou CPF."},"nCodVend":{"type":"integer","maxLength":15,"description":"Código do Vendedor"},"nCodVert":{"type":"integer","maxLength":15,"description":"Código da Vertical"},"nCodTelemkt":{"type":"integer","maxLength":15,"description":"Código do Telemarketing"},"dDtReg":{"type":"string","maxLength":10,"description":"Data de Registro"},"dDtValid":{"type":"string","maxLength":10,"description":"Data de Validade da Reserva"},"cObs":{"type":"string","description":"Observação"}},"description":"Identificação da conta"},"endereco":{"type":"object","properties":{"cEndereco":{"type":"string","maxLength":200,"description":"Endereço"},"cCompl":{"type":"string","maxLength":200,"description":"Complemento do Endereço"},"cCEP":{"type":"string","maxLength":10,"description":"CEP"},"cBairro":{"type":"string","maxLength":60,"description":"Bairro"},"cCidade":{"type":"string","maxLength":50,"description":"Cidade"},"cUF":{"type":"string","maxLength":50,"description":"Estado"},"cPais":{"type":"string","maxLength":50,"description":"País"}},"description":"Endereço da conta"},"telefone_email":{"type":"object","properties":{"cDDDTel":{"type":"string","maxLength":5,"description":"DDD do Telefone"},"cNumTel":{"type":"string","maxLength":15,"description":"Número do Telefone"},"cDDDFax":{"type":"string","maxLength":5,"description":"DDD do Fax"},"cNumFax":{"type":"string","maxLength":15,"description":"Número do Fax"},"cEmail":{"type":"string","maxLength":200,"description":"E-Mail"},"cWebsite":{"type":"string","maxLength":100,"description":"Website"}},"description":"Informações de contato com a conta"},"informacoesAdicionais":{"type":"object","properties":{"nNumFunc":{"type":"integer","maxLength":6,"description":"Número de Funcionários"},"nFaixaFat":{"type":"string","maxLength":100,"description":"Faixa de Faturamento"},"cCnae":{"type":"string"},"cRegTrib":{"type":"string"}},"description":"Informações adicionais da conta"},"tags":{"type":"array","items":{"type":"object","properties":{"tag":{"type":"string","maxLength":50,"description":"Tag da conta"}}},"description":"Tags da conta"},"caracteristicas":{"type":"array","items":{"type":"object","properties":{"campo":{"type":"string","maxLength":30,"description":"Nome da característica.\n\nCaso não encontre a característica um novo cadastro será adicionado."},"conteudo":{"type":"string","maxLength":60,"description":"Conteúdo da característica.\n\n\nCaso o valor desse campo não seja informado a característica\nserá excluída da conta."}}},"description":"Características da conta"},"contatos":{"type":"array","items":{"type":"object","properties":{"alt_data":{"type":"string","maxLength":10,"description":"Data da Alteração"},"alt_hora":{"type":"string","maxLength":8,"description":"Hora da Alteração"},"alt_user":{"type":"string","maxLength":10,"description":"Usuário da Alteração"},"inc_data":{"type":"string","maxLength":10,"description":"Data de Inclusão"},"inc_hora":{"type":"string","maxLength":8,"description":"Hora de Inclusão"},"inc_user":{"type":"string","maxLength":10,"description":"Usuário da Inclusão"},"cod_int":{"type":"string","description":"Código de Integração com sistemas legados."},"bairro":{"type":"string","maxLength":60,"description":"Bairro"},"cargo":{"type":"string","maxLength":60,"description":"Cargo"},"ws_api":{"type":"string","maxLength":1,"example":"S","description":"Gerado da API (S/N)"},"celular1":{"type":"string","maxLength":15,"description":"Celular 1"},"celular2":{"type":"string","maxLength":15,"description":"Celular 2"},"cep":{"type":"string","maxLength":10,"description":"CEP"},"cidade":{"type":"string","maxLength":50,"description":"Cidade"},"data":{"type":"string","maxLength":10,"description":"Data Nascimento"},"ddd_cel1":{"type":"string","maxLength":5,"description":"DDD Celular 1"},"ddd_cel2":{"type":"string","maxLength":5,"description":"DDD Celular 2"},"ddd_fax":{"type":"string","maxLength":5,"description":"DDD Fax"},"ddd_tel":{"type":"string","maxLength":5,"description":"DDD Telefone"},"email":{"type":"string","maxLength":200,"description":"Email"},"endereco":{"type":"string","maxLength":200,"description":"Endereço"},"endereco_c":{"type":"string","maxLength":200,"description":"Endereço Complemento"},"fax":{"type":"string","maxLength":15,"description":"Fax"},"id":{"type":"integer","maxLength":15,"description":"ID do Contato"},"id_conta":{"type":"integer","maxLength":15,"description":"Conta"},"id_img":{"type":"integer","maxLength":15,"description":"ID da Imagem"},"id_telemkt":{"type":"integer","maxLength":15,"description":"Telemarketing"},"id_vend":{"type":"integer","maxLength":15,"description":"Pertence a"},"img_padr":{"type":"string","maxLength":1,"description":"Indica se é uma Imagem Default"},"latlng":{"type":"string","maxLength":50,"description":"Latitude / Longitude do Endereço"},"mapaurl":{"type":"string","description":"Endereço URL do mapa"},"nome":{"type":"string","maxLength":60,"description":"Nome"},"nome_compl":{"type":"string","maxLength":120,"description":"Nome Completo do Usuário"},"observacao":{"type":"string","description":"Observação"},"pais":{"type":"string","maxLength":50,"description":"País"},"sobrenome":{"type":"string","maxLength":60,"description":"Sobrenome"},"telefone":{"type":"string","maxLength":15,"description":"Telefone"},"trial":{"type":"string","maxLength":1,"example":"S","description":"Provisionamento Trial [S/N]"},"uf":{"type":"string","maxLength":50,"description":"Estado/Província"},"website":{"type":"string","maxLength":100,"description":"WebSite"}}},"description":"Contatos da Conta"}}}}},"example":{"call":"IncluirConta","param":[{"identificacao":{"cCodInt":"35250","cNome":"Omiexperience S/A","cObs":"Conta adicionada via API","dDtReg":"30/09/2026","dDtValid":"28/01/2027"},"endereco":{"cEndereco":"Av. Dr. Chucri Zaidan, 1550","cCEP":"04583-110","cCidade":"SAO PAULO","cUF":"SP","cPais":"Brasil"},"telefone_email":{"cDDDTel":"11","cNumTel":"5171-8888","cEmail":"ajuda@omie.com.br","cWebsite":"http://www.omie.com.br/"}}]}},"crm_contas_IncluirConta_retorno":{"type":"object","properties":{"nCod":{"type":"integer","description":"Código da Conta"},"cCodInt":{"type":"string","description":"Código de Integração"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDesStatus":{"type":"string","description":"Descrição do Status"}},"title":"IncluirConta (retorno)"},"crm_contas_ListarContas":{"type":"object","title":"ListarContas","description":"Lista as contas do CRM.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarContas"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"apenas_importado_api":{"type":"string","maxLength":1,"description":"Exibir apenas os registros gerados pela API"},"ordenar_por":{"type":"string","maxLength":100,"example":"CODIGO","description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."},"cDoc":{"type":"string","maxLength":30,"description":"Número do Documento: CNPJ ou CPF."}}}}},"example":{"call":"ListarContas","param":[{"pagina":1,"registros_por_pagina":20}]}},"crm_contas_ListarContas_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada"},"total_de_paginas":{"type":"integer","description":"Número total de páginas"},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"total de registros encontrados"},"cadastros":{"type":"array","items":{"type":"object","properties":{"identificacao":{"type":"object","properties":{"nCod":{"type":"integer","description":"Código da Conta"},"cCodInt":{"type":"string","description":"Código de Integração"},"cNome":{"type":"string","description":"Nome da Conta"},"cNomeFantasia":{"type":"string","description":"Nome fantasia da conta"},"cDoc":{"type":"string","description":"Número do Documento: CNPJ ou CPF."},"nCodVend":{"type":"integer","description":"Código do Vendedor"},"nCodVert":{"type":"integer","description":"Código da Vertical"},"nCodTelemkt":{"type":"integer","description":"Código do Telemarketing"},"dDtReg":{"type":"string","description":"Data de Registro"},"dDtValid":{"type":"string","description":"Data de Validade da Reserva"},"cObs":{"type":"string","description":"Observação"}},"description":"Identificação da conta"},"endereco":{"type":"object","properties":{"cEndereco":{"type":"string","description":"Endereço"},"cCompl":{"type":"string","description":"Complemento do Endereço"},"cCEP":{"type":"string","description":"CEP"},"cBairro":{"type":"string","description":"Bairro"},"cCidade":{"type":"string","description":"Cidade"},"cUF":{"type":"string","description":"Estado"},"cPais":{"type":"string","description":"País"}},"description":"Endereço da conta"},"telefone_email":{"type":"object","properties":{"cDDDTel":{"type":"string","description":"DDD do Telefone"},"cNumTel":{"type":"string","description":"Número do Telefone"},"cDDDFax":{"type":"string","description":"DDD do Fax"},"cNumFax":{"type":"string","description":"Número do Fax"},"cEmail":{"type":"string","description":"E-Mail"},"cWebsite":{"type":"string","description":"Website"}},"description":"Informações de contato com a conta"},"informacoesAdicionais":{"type":"object","properties":{"nNumFunc":{"type":"integer","description":"Número de Funcionários"},"nFaixaFat":{"type":"string","description":"Faixa de Faturamento"},"cCnae":{"type":"string"},"cRegTrib":{"type":"string"}},"description":"Informações adicionais da conta"},"tags":{"type":"array","items":{"type":"object","properties":{"tag":{"type":"string","description":"Tag da conta"}}},"description":"Tags da conta"},"caracteristicas":{"type":"array","items":{"type":"object","properties":{"campo":{"type":"string","description":"Nome da característica. Caso não encontre a característica um novo cadastro será adicionado."},"conteudo":{"type":"string","description":"Conteúdo da característica. Caso o valor desse campo não seja informado a característica será excluída da conta."}}},"description":"Características da conta"},"contatos":{"type":"array","items":{"type":"object","properties":{"alt_data":{"type":"string","description":"Data da Alteração"},"alt_hora":{"type":"string","description":"Hora da Alteração"},"alt_user":{"type":"string","description":"Usuário da Alteração"},"inc_data":{"type":"string","description":"Data de Inclusão"},"inc_hora":{"type":"string","description":"Hora de Inclusão"},"inc_user":{"type":"string","description":"Usuário da Inclusão"},"cod_int":{"type":"string","description":"Código de Integração com sistemas legados."},"bairro":{"type":"string","description":"Bairro"},"cargo":{"type":"string","description":"Cargo"},"ws_api":{"type":"string","description":"Gerado da API (S/N)"},"celular1":{"type":"string","description":"Celular 1"},"celular2":{"type":"string","description":"Celular 2"},"cep":{"type":"string","description":"CEP"},"cidade":{"type":"string","description":"Cidade"},"data":{"type":"string","description":"Data Nascimento"},"ddd_cel1":{"type":"string","description":"DDD Celular 1"},"ddd_cel2":{"type":"string","description":"DDD Celular 2"},"ddd_fax":{"type":"string","description":"DDD Fax"},"ddd_tel":{"type":"string","description":"DDD Telefone"},"email":{"type":"string","description":"Email"},"endereco":{"type":"string","description":"Endereço"},"endereco_c":{"type":"string","description":"Endereço Complemento"},"fax":{"type":"string","description":"Fax"},"id":{"type":"integer","description":"ID do Contato"},"id_conta":{"type":"integer","description":"Conta"},"id_img":{"type":"integer","description":"ID da Imagem"},"id_telemkt":{"type":"integer","description":"Telemarketing"},"id_vend":{"type":"integer","description":"Pertence a"},"img_padr":{"type":"string","description":"Indica se é uma Imagem Default"},"latlng":{"type":"string","description":"Latitude / Longitude do Endereço"},"mapaurl":{"type":"string","description":"Endereço URL do mapa"},"nome":{"type":"string","description":"Nome"},"nome_compl":{"type":"string","description":"Nome Completo do Usuário"},"observacao":{"type":"string","description":"Observação"},"pais":{"type":"string","description":"País"},"sobrenome":{"type":"string","description":"Sobrenome"},"telefone":{"type":"string","description":"Telefone"},"trial":{"type":"string","description":"Provisionamento Trial [S/N]"},"uf":{"type":"string","description":"Estado/Província"},"website":{"type":"string","description":"WebSite"}}},"description":"Contatos da Conta"}}},"description":"Lista os cadastros encontrados."}},"title":"ListarContas (retorno)"},"crm_contas_UpsertConta":{"type":"object","title":"UpsertConta","description":"Inclui ou altera uma conta do CRM conforme a chave informada.","required":["call","param"],"properties":{"call":{"type":"string","enum":["UpsertConta"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"identificacao":{"type":"object","properties":{"nCod":{"type":"integer","maxLength":15,"description":"Código da Conta"},"cCodInt":{"type":"string","description":"Código de Integração"},"cNome":{"type":"string","maxLength":100,"description":"Nome da Conta"},"cNomeFantasia":{"type":"string","maxLength":100,"description":"Nome fantasia da conta"},"cDoc":{"type":"string","maxLength":30,"description":"Número do Documento: CNPJ ou CPF."},"nCodVend":{"type":"integer","maxLength":15,"description":"Código do Vendedor"},"nCodVert":{"type":"integer","maxLength":15,"description":"Código da Vertical"},"nCodTelemkt":{"type":"integer","maxLength":15,"description":"Código do Telemarketing"},"dDtReg":{"type":"string","maxLength":10,"description":"Data de Registro"},"dDtValid":{"type":"string","maxLength":10,"description":"Data de Validade da Reserva"},"cObs":{"type":"string","description":"Observação"}},"description":"Identificação da conta"},"endereco":{"type":"object","properties":{"cEndereco":{"type":"string","maxLength":200,"description":"Endereço"},"cCompl":{"type":"string","maxLength":200,"description":"Complemento do Endereço"},"cCEP":{"type":"string","maxLength":10,"description":"CEP"},"cBairro":{"type":"string","maxLength":60,"description":"Bairro"},"cCidade":{"type":"string","maxLength":50,"description":"Cidade"},"cUF":{"type":"string","maxLength":50,"description":"Estado"},"cPais":{"type":"string","maxLength":50,"description":"País"}},"description":"Endereço da conta"},"telefone_email":{"type":"object","properties":{"cDDDTel":{"type":"string","maxLength":5,"description":"DDD do Telefone"},"cNumTel":{"type":"string","maxLength":15,"description":"Número do Telefone"},"cDDDFax":{"type":"string","maxLength":5,"description":"DDD do Fax"},"cNumFax":{"type":"string","maxLength":15,"description":"Número do Fax"},"cEmail":{"type":"string","maxLength":200,"description":"E-Mail"},"cWebsite":{"type":"string","maxLength":100,"description":"Website"}},"description":"Informações de contato com a conta"},"informacoesAdicionais":{"type":"object","properties":{"nNumFunc":{"type":"integer","maxLength":6,"description":"Número de Funcionários"},"nFaixaFat":{"type":"string","maxLength":100,"description":"Faixa de Faturamento"},"cCnae":{"type":"string"},"cRegTrib":{"type":"string"}},"description":"Informações adicionais da conta"},"tags":{"type":"array","items":{"type":"object","properties":{"tag":{"type":"string","maxLength":50,"description":"Tag da conta"}}},"description":"Tags da conta"},"caracteristicas":{"type":"array","items":{"type":"object","properties":{"campo":{"type":"string","maxLength":30,"description":"Nome da característica.\n\nCaso não encontre a característica um novo cadastro será adicionado."},"conteudo":{"type":"string","maxLength":60,"description":"Conteúdo da característica.\n\n\nCaso o valor desse campo não seja informado a característica\nserá excluída da conta."}}},"description":"Características da conta"},"contatos":{"type":"array","items":{"type":"object","properties":{"alt_data":{"type":"string","maxLength":10,"description":"Data da Alteração"},"alt_hora":{"type":"string","maxLength":8,"description":"Hora da Alteração"},"alt_user":{"type":"string","maxLength":10,"description":"Usuário da Alteração"},"inc_data":{"type":"string","maxLength":10,"description":"Data de Inclusão"},"inc_hora":{"type":"string","maxLength":8,"description":"Hora de Inclusão"},"inc_user":{"type":"string","maxLength":10,"description":"Usuário da Inclusão"},"cod_int":{"type":"string","description":"Código de Integração com sistemas legados."},"bairro":{"type":"string","maxLength":60,"description":"Bairro"},"cargo":{"type":"string","maxLength":60,"description":"Cargo"},"ws_api":{"type":"string","maxLength":1,"example":"S","description":"Gerado da API (S/N)"},"celular1":{"type":"string","maxLength":15,"description":"Celular 1"},"celular2":{"type":"string","maxLength":15,"description":"Celular 2"},"cep":{"type":"string","maxLength":10,"description":"CEP"},"cidade":{"type":"string","maxLength":50,"description":"Cidade"},"data":{"type":"string","maxLength":10,"description":"Data Nascimento"},"ddd_cel1":{"type":"string","maxLength":5,"description":"DDD Celular 1"},"ddd_cel2":{"type":"string","maxLength":5,"description":"DDD Celular 2"},"ddd_fax":{"type":"string","maxLength":5,"description":"DDD Fax"},"ddd_tel":{"type":"string","maxLength":5,"description":"DDD Telefone"},"email":{"type":"string","maxLength":200,"description":"Email"},"endereco":{"type":"string","maxLength":200,"description":"Endereço"},"endereco_c":{"type":"string","maxLength":200,"description":"Endereço Complemento"},"fax":{"type":"string","maxLength":15,"description":"Fax"},"id":{"type":"integer","maxLength":15,"description":"ID do Contato"},"id_conta":{"type":"integer","maxLength":15,"description":"Conta"},"id_img":{"type":"integer","maxLength":15,"description":"ID da Imagem"},"id_telemkt":{"type":"integer","maxLength":15,"description":"Telemarketing"},"id_vend":{"type":"integer","maxLength":15,"description":"Pertence a"},"img_padr":{"type":"string","maxLength":1,"description":"Indica se é uma Imagem Default"},"latlng":{"type":"string","maxLength":50,"description":"Latitude / Longitude do Endereço"},"mapaurl":{"type":"string","description":"Endereço URL do mapa"},"nome":{"type":"string","maxLength":60,"description":"Nome"},"nome_compl":{"type":"string","maxLength":120,"description":"Nome Completo do Usuário"},"observacao":{"type":"string","description":"Observação"},"pais":{"type":"string","maxLength":50,"description":"País"},"sobrenome":{"type":"string","maxLength":60,"description":"Sobrenome"},"telefone":{"type":"string","maxLength":15,"description":"Telefone"},"trial":{"type":"string","maxLength":1,"example":"S","description":"Provisionamento Trial [S/N]"},"uf":{"type":"string","maxLength":50,"description":"Estado/Província"},"website":{"type":"string","maxLength":100,"description":"WebSite"}}},"description":"Contatos da Conta"}}}}},"example":{"call":"UpsertConta","param":[{"identificacao":{"cCodInt":"0004","cNome":"Omiexperience S/A","cObs":"Conta adicionada via API (1790776272)","dDtReg":"30/09/2026","dDtValid":"12/03/2027"},"endereco":{"cEndereco":"Av. Dr. Chucri Zaidan, 1550","cCEP":"04583-110","cCidade":"SAO PAULO","cUF":"SP","cPais":"Brasil"},"telefone_email":{"cDDDTel":"11","cNumTel":"5171-8888","cEmail":"ajuda@omie.com.br","cWebsite":"http://www.omie.com.br/"}}]}},"crm_contas_UpsertConta_retorno":{"type":"object","properties":{"nCod":{"type":"integer","description":"Código da Conta"},"cCodInt":{"type":"string","description":"Código de Integração"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDesStatus":{"type":"string","description":"Descrição do Status"}},"title":"UpsertConta (retorno)"},"crm_contas_VerificarConta":{"type":"object","title":"VerificarConta","description":"Verifica se uma conta foi criada a partir do nome e e-mail.","required":["call","param"],"properties":{"call":{"type":"string","enum":["VerificarConta"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cNome":{"type":"string","maxLength":100,"description":"Nome da Conta"},"cEmail":{"type":"string","maxLength":200,"description":"E-Mail da conta."},"cDoc":{"type":"string","maxLength":30,"description":"Documento CNPJ ou CPF."}}}}},"example":{"call":"VerificarConta","param":[{"cNome":"","cEmail":""}]}},"crm_contas_VerificarConta_retorno":{"type":"object","properties":{"nCod":{"type":"integer","description":"Código da conta."},"cCodInt":{"type":"string","description":"Código de Integração"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDesStatus":{"type":"string","description":"Descrição do Status"}},"title":"VerificarConta (retorno)"},"crm_contascaract_AlterarCaractConta":{"type":"object","title":"AlterarCaractConta","description":"Altera uma característica de uma conta","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarCaractConta"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCod":{"type":"integer","maxLength":15,"description":"Código da conta"},"cCodInt":{"type":"string","description":"Código de integração com sistemas legados"},"campo":{"type":"string","maxLength":30,"description":"Nome da característica."},"conteudo":{"type":"string","maxLength":60,"description":"Conteúdo da característica."}},"required":["campo","conteudo"]}}},"example":{"call":"AlterarCaractConta","param":[{"nCod":0,"cCodInt":"","campo":"","conteudo":""}]}},"crm_contascaract_AlterarCaractConta_retorno":{"type":"object","properties":{"nCod":{"type":"integer","description":"Código da conta"},"cCodInt":{"type":"string","description":"Código de integração com sistemas legados"},"cCodStatus":{"type":"string","description":"Código do status de processamento"},"cDesStatus":{"type":"string","description":"Descrição do status de processamento"}},"title":"AlterarCaractConta (retorno)"},"crm_contascaract_ConsultarCaractConta":{"type":"object","title":"ConsultarCaractConta","description":"Consultar todas as características da conta","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarCaractConta"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCod":{"type":"integer","maxLength":15,"description":"Código da conta"},"cCodInt":{"type":"string","description":"Código de integração com sistemas legados"}}}}},"example":{"call":"ConsultarCaractConta","param":[{"nCod":0,"cCodInt":""}]}},"crm_contascaract_ConsultarCaractConta_retorno":{"type":"object","properties":{"nCod":{"type":"integer","description":"Código da conta"},"cCodInt":{"type":"string","description":"Código de integração com sistemas legados"},"caracteristicas":{"type":"object","properties":{"campo":{"type":"string","description":"Nome da característica."},"conteudo":{"type":"string","description":"Conteúdo da característica."}},"description":"Características da conta"}},"title":"ConsultarCaractConta (retorno)"},"crm_contascaract_ExcluirCaractConta":{"type":"object","title":"ExcluirCaractConta","description":"Exclui uma característica de uma conta","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirCaractConta"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCod":{"type":"integer","maxLength":15,"description":"Código da conta"},"cCodInt":{"type":"string","description":"Código de integração com sistemas legados"},"campo":{"type":"string","maxLength":30,"description":"Nome da característica."}},"required":["campo"]}}},"example":{"call":"ExcluirCaractConta","param":[{"nCod":0,"cCodInt":"","campo":""}]}},"crm_contascaract_ExcluirCaractConta_retorno":{"type":"object","properties":{"nCod":{"type":"integer","description":"Código da conta"},"cCodInt":{"type":"string","description":"Código de integração com sistemas legados"},"cCodStatus":{"type":"string","description":"Código do status de processamento"},"cDesStatus":{"type":"string","description":"Descrição do status de processamento"}},"title":"ExcluirCaractConta (retorno)"},"crm_contascaract_ExcluirTodasCaractConta":{"type":"object","title":"ExcluirTodasCaractConta","description":"Exclui todas as características de uma conta","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirTodasCaractConta"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCod":{"type":"integer","maxLength":15,"description":"Código da conta"},"cCodInt":{"type":"string","description":"Código de integração com sistemas legados"}}}}},"example":{"call":"ExcluirTodasCaractConta","param":[{"nCod":0,"cCodInt":""}]}},"crm_contascaract_ExcluirTodasCaractConta_retorno":{"type":"object","properties":{"nCod":{"type":"integer","description":"Código da conta"},"cCodInt":{"type":"string","description":"Código de integração com sistemas legados"},"cCodStatus":{"type":"string","description":"Código do status de processamento"},"cDesStatus":{"type":"string","description":"Descrição do status de processamento"}},"title":"ExcluirTodasCaractConta (retorno)"},"crm_contascaract_IncluirCaractConta":{"type":"object","title":"IncluirCaractConta","description":"Inclui uma característica para a conta","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirCaractConta"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCod":{"type":"integer","maxLength":15,"description":"Código da conta"},"cCodInt":{"type":"string","description":"Código de integração com sistemas legados"},"campo":{"type":"string","maxLength":30,"description":"Nome da característica."},"conteudo":{"type":"string","maxLength":60,"description":"Conteúdo da característica."}},"required":["campo","conteudo"]}}},"example":{"call":"IncluirCaractConta","param":[{"nCod":0,"cCodInt":"","campo":"","conteudo":""}]}},"crm_contascaract_IncluirCaractConta_retorno":{"type":"object","properties":{"nCod":{"type":"integer","description":"Código da conta"},"cCodInt":{"type":"string","description":"Código de integração com sistemas legados"},"cCodStatus":{"type":"string","description":"Código do status de processamento"},"cDesStatus":{"type":"string","description":"Descrição do status de processamento"}},"title":"IncluirCaractConta (retorno)"},"crm_contatos_AlterarContato":{"type":"object","title":"AlterarContato","description":"Altera um Contato","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarContato"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"identificacao":{"type":"object","properties":{"nCod":{"type":"integer","maxLength":15,"description":"Código do Contato"},"cCodInt":{"type":"string","description":"Código de Integração"},"cNome":{"type":"string","maxLength":60,"description":"Nome do contato"},"cSobrenome":{"type":"string","maxLength":60,"description":"Sobrenome do contato"},"cCargo":{"type":"string","maxLength":60,"description":"Cargo"},"dDtNasc":{"type":"string","maxLength":10,"description":"Data de Nascimento"},"nCodVend":{"type":"integer","maxLength":15,"description":"Código do Vendedor"},"nCodConta":{"type":"integer","maxLength":15,"description":"Código da Conta"}}},"endereco":{"type":"object","properties":{"cEndereco":{"type":"string","maxLength":200,"description":"Endereço do contato"},"cCompl":{"type":"string","maxLength":200,"description":"Complemento"},"cCEP":{"type":"string","maxLength":10,"description":"CEP"},"cBairro":{"type":"string","maxLength":60,"description":"Bairro"},"cCidade":{"type":"string","maxLength":50,"description":"Cidade"},"cUF":{"type":"string","maxLength":50,"description":"Estado"},"cPais":{"type":"string","maxLength":50,"description":"País"}}},"telefone_email":{"type":"object","properties":{"cDDDCel1":{"type":"string","maxLength":5,"description":"DDD do celular"},"cNumCel1":{"type":"string","maxLength":15,"description":"Número do Celular"},"cDDDCel2":{"type":"string","maxLength":5,"description":"DDD do Celular"},"cNumCel2":{"type":"string","maxLength":15,"description":"Número do Celular"},"cDDDTel":{"type":"string","maxLength":5,"description":"DDD do Telefone"},"cNumTel":{"type":"string","maxLength":15,"description":"Número do Telefone"},"cDDDFax":{"type":"string","maxLength":5,"description":"DDD do Fax"},"cNumFax":{"type":"string","maxLength":15,"description":"Número do Fax"},"cEmail":{"type":"string","maxLength":200,"description":"E-mail do contato"},"cWebsite":{"type":"string","maxLength":100,"description":"WebSite"}}},"cObs":{"type":"string","description":"Observações."}}}}},"example":{"call":"AlterarContato","param":[{"identificacao":{"cCodInt":"","cNome":"","cSobrenome":"","cCargo":"","dDtNasc":"","nCodVend":0,"nCodConta":0},"endereco":{"cEndereco":"","cCompl":"","cCEP":"","cBairro":"","cCidade":"","cUF":"","cPais":""},"telefone_email":{"cDDDCel1":"","cNumCel1":"","cEmail":"","cWebsite":""}}]}},"crm_contatos_AlterarContato_retorno":{"type":"object","properties":{"nCod":{"type":"integer","description":"Código do contato"},"cCodInt":{"type":"string","description":"Código de Integração"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDesStatus":{"type":"string","description":"Descrição do Status"}},"title":"AlterarContato (retorno)"},"crm_contatos_ConsultarContato":{"type":"object","title":"ConsultarContato","description":"Consulta o Contato","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarContato"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCod":{"type":"integer","maxLength":15,"description":"Código do Contato"},"cCodInt":{"type":"string","description":"Código de Integração"}}}}},"example":{"call":"ConsultarContato","param":[{"nCod":1,"cCodInt":""}]}},"crm_contatos_ConsultarContato_retorno":{"type":"object","properties":{"identificacao":{"type":"object","properties":{"nCod":{"type":"integer","description":"Código do Contato"},"cCodInt":{"type":"string","description":"Código de Integração"},"cNome":{"type":"string","description":"Nome do contato"},"cSobrenome":{"type":"string","description":"Sobrenome do contato"},"cCargo":{"type":"string","description":"Cargo"},"dDtNasc":{"type":"string","description":"Data de Nascimento"},"nCodVend":{"type":"integer","description":"Código do Vendedor"},"nCodConta":{"type":"integer","description":"Código da Conta"}}},"endereco":{"type":"object","properties":{"cEndereco":{"type":"string","description":"Endereço do contato"},"cCompl":{"type":"string","description":"Complemento"},"cCEP":{"type":"string","description":"CEP"},"cBairro":{"type":"string","description":"Bairro"},"cCidade":{"type":"string","description":"Cidade"},"cUF":{"type":"string","description":"Estado"},"cPais":{"type":"string","description":"País"}}},"telefone_email":{"type":"object","properties":{"cDDDCel1":{"type":"string","description":"DDD do celular"},"cNumCel1":{"type":"string","description":"Número do Celular"},"cDDDCel2":{"type":"string","description":"DDD do Celular"},"cNumCel2":{"type":"string","description":"Número do Celular"},"cDDDTel":{"type":"string","description":"DDD do Telefone"},"cNumTel":{"type":"string","description":"Número do Telefone"},"cDDDFax":{"type":"string","description":"DDD do Fax"},"cNumFax":{"type":"string","description":"Número do Fax"},"cEmail":{"type":"string","description":"E-mail do contato"},"cWebsite":{"type":"string","description":"WebSite"}}},"cObs":{"type":"string","description":"Observações."}},"title":"ConsultarContato (retorno)"},"crm_contatos_ExcluirContato":{"type":"object","title":"ExcluirContato","description":"Exclui um Contato","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirContato"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCod":{"type":"integer","maxLength":15,"description":"Código do Contato"},"cCodInt":{"type":"string","description":"Código de Integração"}}}}},"example":{"call":"ExcluirContato","param":[{"nCod":0,"cCodInt":""}]}},"crm_contatos_ExcluirContato_retorno":{"type":"object","properties":{"nCod":{"type":"integer","description":"Código do contato"},"cCodInt":{"type":"string","description":"Código de Integração"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDesStatus":{"type":"string","description":"Descrição do Status"}},"title":"ExcluirContato (retorno)"},"crm_contatos_IncluirContato":{"type":"object","title":"IncluirContato","description":"Inclui um novo Contato","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirContato"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"identificacao":{"type":"object","properties":{"nCod":{"type":"integer","maxLength":15,"description":"Código do Contato"},"cCodInt":{"type":"string","description":"Código de Integração"},"cNome":{"type":"string","maxLength":60,"description":"Nome do contato"},"cSobrenome":{"type":"string","maxLength":60,"description":"Sobrenome do contato"},"cCargo":{"type":"string","maxLength":60,"description":"Cargo"},"dDtNasc":{"type":"string","maxLength":10,"description":"Data de Nascimento"},"nCodVend":{"type":"integer","maxLength":15,"description":"Código do Vendedor"},"nCodConta":{"type":"integer","maxLength":15,"description":"Código da Conta"}}},"endereco":{"type":"object","properties":{"cEndereco":{"type":"string","maxLength":200,"description":"Endereço do contato"},"cCompl":{"type":"string","maxLength":200,"description":"Complemento"},"cCEP":{"type":"string","maxLength":10,"description":"CEP"},"cBairro":{"type":"string","maxLength":60,"description":"Bairro"},"cCidade":{"type":"string","maxLength":50,"description":"Cidade"},"cUF":{"type":"string","maxLength":50,"description":"Estado"},"cPais":{"type":"string","maxLength":50,"description":"País"}}},"telefone_email":{"type":"object","properties":{"cDDDCel1":{"type":"string","maxLength":5,"description":"DDD do celular"},"cNumCel1":{"type":"string","maxLength":15,"description":"Número do Celular"},"cDDDCel2":{"type":"string","maxLength":5,"description":"DDD do Celular"},"cNumCel2":{"type":"string","maxLength":15,"description":"Número do Celular"},"cDDDTel":{"type":"string","maxLength":5,"description":"DDD do Telefone"},"cNumTel":{"type":"string","maxLength":15,"description":"Número do Telefone"},"cDDDFax":{"type":"string","maxLength":5,"description":"DDD do Fax"},"cNumFax":{"type":"string","maxLength":15,"description":"Número do Fax"},"cEmail":{"type":"string","maxLength":200,"description":"E-mail do contato"},"cWebsite":{"type":"string","maxLength":100,"description":"WebSite"}}},"cObs":{"type":"string","description":"Observações."}}}}},"example":{"call":"IncluirContato","param":[{"identificacao":{"cCodInt":"","cNome":"","cSobrenome":"","cCargo":"","dDtNasc":"","nCodVend":0,"nCodConta":0},"endereco":{"cEndereco":"","cCompl":"","cCEP":"","cBairro":"","cCidade":"","cUF":"","cPais":""},"telefone_email":{"cDDDCel1":"","cNumCel1":"","cEmail":"","cWebsite":""}}]}},"crm_contatos_IncluirContato_retorno":{"type":"object","properties":{"nCod":{"type":"integer","description":"Código do contato"},"cCodInt":{"type":"string","description":"Código de Integração"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDesStatus":{"type":"string","description":"Descrição do Status"}},"title":"IncluirContato (retorno)"},"crm_contatos_ListarContatos":{"type":"object","title":"ListarContatos","description":"Lista os contatos do CRM.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarContatos"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"apenas_importado_api":{"type":"string","maxLength":1,"description":"Exibir apenas os registros gerados pela API"},"ordenar_por":{"type":"string","maxLength":100,"description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."},"exibir_obs":{"type":"string","maxLength":1,"description":"Exibir as observações do contato (S/N).\n\nPreencher com \"S\" ou \"N\"."},"filtrar_por_conta":{"type":"integer","maxLength":15,"description":"Filtrar os contatos pelo código da conta.\n\n\nUtilize a tag \"nCod\" do método \"ListarContas\"  da API\n/api/v1/crm/contas/\npara obter essa informação"}}}}},"example":{"call":"ListarContatos","param":[{"pagina":1,"registros_por_pagina":50}]}},"crm_contatos_ListarContatos_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada"},"total_de_paginas":{"type":"integer","description":"Número total de páginas"},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"total de registros encontrados"},"cadastros":{"type":"array","items":{"type":"object","properties":{"identificacao":{"type":"object","properties":{"nCod":{"type":"integer","description":"Código do Contato"},"cCodInt":{"type":"string","description":"Código de Integração"},"cNome":{"type":"string","description":"Nome do contato"},"cSobrenome":{"type":"string","description":"Sobrenome do contato"},"cCargo":{"type":"string","description":"Cargo"},"dDtNasc":{"type":"string","description":"Data de Nascimento"},"nCodVend":{"type":"integer","description":"Código do Vendedor"},"nCodConta":{"type":"integer","description":"Código da Conta"}}},"endereco":{"type":"object","properties":{"cEndereco":{"type":"string","description":"Endereço do contato"},"cCompl":{"type":"string","description":"Complemento"},"cCEP":{"type":"string","description":"CEP"},"cBairro":{"type":"string","description":"Bairro"},"cCidade":{"type":"string","description":"Cidade"},"cUF":{"type":"string","description":"Estado"},"cPais":{"type":"string","description":"País"}}},"telefone_email":{"type":"object","properties":{"cDDDCel1":{"type":"string","description":"DDD do celular"},"cNumCel1":{"type":"string","description":"Número do Celular"},"cDDDCel2":{"type":"string","description":"DDD do Celular"},"cNumCel2":{"type":"string","description":"Número do Celular"},"cDDDTel":{"type":"string","description":"DDD do Telefone"},"cNumTel":{"type":"string","description":"Número do Telefone"},"cDDDFax":{"type":"string","description":"DDD do Fax"},"cNumFax":{"type":"string","description":"Número do Fax"},"cEmail":{"type":"string","description":"E-mail do contato"},"cWebsite":{"type":"string","description":"WebSite"}}},"cObs":{"type":"string","description":"Observações."}}},"description":"Lista os cadastros encontrados."}},"title":"ListarContatos (retorno)"},"crm_contatos_UpsertContato":{"type":"object","title":"UpsertContato","description":"Upsert do contato","required":["call","param"],"properties":{"call":{"type":"string","enum":["UpsertContato"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"identificacao":{"type":"object","properties":{"nCod":{"type":"integer","maxLength":15,"description":"Código do Contato"},"cCodInt":{"type":"string","description":"Código de Integração"},"cNome":{"type":"string","maxLength":60,"description":"Nome do contato"},"cSobrenome":{"type":"string","maxLength":60,"description":"Sobrenome do contato"},"cCargo":{"type":"string","maxLength":60,"description":"Cargo"},"dDtNasc":{"type":"string","maxLength":10,"description":"Data de Nascimento"},"nCodVend":{"type":"integer","maxLength":15,"description":"Código do Vendedor"},"nCodConta":{"type":"integer","maxLength":15,"description":"Código da Conta"}}},"endereco":{"type":"object","properties":{"cEndereco":{"type":"string","maxLength":200,"description":"Endereço do contato"},"cCompl":{"type":"string","maxLength":200,"description":"Complemento"},"cCEP":{"type":"string","maxLength":10,"description":"CEP"},"cBairro":{"type":"string","maxLength":60,"description":"Bairro"},"cCidade":{"type":"string","maxLength":50,"description":"Cidade"},"cUF":{"type":"string","maxLength":50,"description":"Estado"},"cPais":{"type":"string","maxLength":50,"description":"País"}}},"telefone_email":{"type":"object","properties":{"cDDDCel1":{"type":"string","maxLength":5,"description":"DDD do celular"},"cNumCel1":{"type":"string","maxLength":15,"description":"Número do Celular"},"cDDDCel2":{"type":"string","maxLength":5,"description":"DDD do Celular"},"cNumCel2":{"type":"string","maxLength":15,"description":"Número do Celular"},"cDDDTel":{"type":"string","maxLength":5,"description":"DDD do Telefone"},"cNumTel":{"type":"string","maxLength":15,"description":"Número do Telefone"},"cDDDFax":{"type":"string","maxLength":5,"description":"DDD do Fax"},"cNumFax":{"type":"string","maxLength":15,"description":"Número do Fax"},"cEmail":{"type":"string","maxLength":200,"description":"E-mail do contato"},"cWebsite":{"type":"string","maxLength":100,"description":"WebSite"}}},"cObs":{"type":"string","description":"Observações."}}}}},"example":{"call":"UpsertContato","param":[{"identificacao":{"cCodInt":"","cNome":"","cSobrenome":"","cCargo":"","dDtNasc":"","nCodVend":0,"nCodConta":0},"endereco":{"cEndereco":"","cCompl":"","cCEP":"","cBairro":"","cCidade":"","cUF":"","cPais":""},"telefone_email":{"cDDDCel1":"","cNumCel1":"","cEmail":"","cWebsite":""}}]}},"crm_contatos_UpsertContato_retorno":{"type":"object","properties":{"nCod":{"type":"integer","description":"Código do contato"},"cCodInt":{"type":"string","description":"Código de Integração"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDesStatus":{"type":"string","description":"Descrição do Status"}},"title":"UpsertContato (retorno)"},"crm_contatos_VerificarContato":{"type":"object","title":"VerificarContato","description":"Verifica se um contato já existe.","required":["call","param"],"properties":{"call":{"type":"string","enum":["VerificarContato"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cNome":{"type":"string","maxLength":60,"description":"Nome completo (Nome + Sobrenome) do contato."},"cEmail":{"type":"string","maxLength":200,"description":"E-mail do contato"}}}}},"example":{"call":"VerificarContato","param":[{"cNome":"","cEmail":""}]}},"crm_contatos_VerificarContato_retorno":{"type":"object","properties":{"nCod":{"type":"integer","description":"Código do contato"},"cCodInt":{"type":"string","description":"Código de Integração"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDesStatus":{"type":"string","description":"Descrição do Status"}},"title":"VerificarContato (retorno)"},"crm_fases_ListarFases":{"type":"object","title":"ListarFases","description":"Fases da Oportunidade","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarFases"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"apenas_importado_api":{"type":"string","maxLength":1,"description":"Exibir apenas os registros gerados pela API"},"ordenar_por":{"type":"string","maxLength":100,"example":"CODIGO","description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."}}}}},"example":{"call":"ListarFases","param":[{"pagina":1,"registros_por_pagina":20}]}},"crm_fases_ListarFases_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada"},"total_de_paginas":{"type":"integer","description":"Número total de páginas"},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"total de registros encontrados"},"cadastros":{"type":"array","items":{"type":"object","properties":{"nCodigo":{"type":"integer","description":"Código da fase da oportunidade."},"cDescrPadrao":{"type":"string","description":"Descrição padrão da fase da oportunidade."},"cDescrUsuario":{"type":"string","description":"Descrição personalizada pelo usuário."},"cObservacao":{"type":"string","description":"Observação da fase da oportunidade."},"nOrdem":{"type":"integer","description":"Ordem da fase da oportunidade."}}},"description":"Lista os cadastros encontrados."}},"title":"ListarFases (retorno)"},"crm_finders_ListarFinders":{"type":"object","title":"ListarFinders","description":"Finders da oportunidade.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarFinders"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"apenas_importado_api":{"type":"string","maxLength":1,"description":"Exibir apenas os registros gerados pela API."},"ordenar_por":{"type":"string","maxLength":100,"example":"CODIGO","description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."}}}}},"example":{"call":"ListarFinders","param":[{"pagina":1,"registros_por_pagina":20}]}},"crm_finders_ListarFinders_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada."},"total_de_paginas":{"type":"integer","description":"Número total de páginas."},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"Total de registros encontrados."},"cadastros":{"type":"array","items":{"type":"object","properties":{"nCodigo":{"type":"integer","description":"Código do finder da oportunidade."},"cNome":{"type":"string","description":"Nome do finder da oportunidade."},"cEmail":{"type":"string","description":"Email do finder da oportunidade."},"cObservacao":{"type":"string","description":"Observação do finder da oportunidade."},"cInativo":{"type":"string","description":"Indica se finder da oportunidade está inativo."}}},"description":"Lista os cadastros encontrados."}},"title":"ListarFinders (retorno)"},"crm_motivos_ListarMotivos":{"type":"object","title":"ListarMotivos","description":"Motivos da oportunidade.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarMotivos"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"apenas_importado_api":{"type":"string","maxLength":1,"description":"Exibir apenas os registros gerados pela API."},"ordenar_por":{"type":"string","maxLength":100,"example":"CODIGO","description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."}}}}},"example":{"call":"ListarMotivos","param":[{"pagina":1,"registros_por_pagina":20}]}},"crm_motivos_ListarMotivos_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada."},"total_de_paginas":{"type":"integer","description":"Número total de páginas."},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"Total de registros encontrados."},"cadastros":{"type":"array","items":{"type":"object","properties":{"nCodigo":{"type":"integer","description":"Código do motivo da oportunidade."},"cDescricao":{"type":"string","description":"Descrição do motivo da oportunidade."},"cObservacao":{"type":"string","description":"Observação da oportunidade."}}},"description":"Lista os cadastros encontrados."}},"title":"ListarMotivos (retorno)"},"crm_oportunidadesresumo_ObterListaOp":{"type":"object","title":"ObterListaOp","description":"Lista de Oportunidades.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterListaOp"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cMesAno":{"type":"string","example":"05/2026","description":"Mes e ano. (MM/AAAA).\n\nDefault mês atual."},"cTemperatura":{"type":"string","example":"em-processo","description":"Informe a temperatura da Oportunidade.\n\nPode ser:\nem-processo\nboas-chances\ncomprometido\nconquistado"}},"required":["cTemperatura"]}}},"example":{"call":"ObterListaOp","param":[{"cMesAno":"04/2022","cTemperatura":"em-processo"}]}},"crm_oportunidadesresumo_ObterListaOp_retorno":{"type":"object","properties":{"listaDetalhesOp":{"type":"array","items":{"type":"object","properties":{"nIdOportunidade":{"type":"integer","description":"ID da Oportunidade."},"cDescricao":{"type":"string","description":"Descrição da Oportunidade."},"nIdConta":{"type":"integer","description":"Id da Conta."},"cNomeConta":{"type":"string","description":"Nome da Conta."},"nIdContato":{"type":"integer","description":"ID do Contato."},"cNomeContato":{"type":"string","description":"Nome do Contato."},"nIdVendedor":{"type":"integer","description":"Id do Vendedor."},"cNomeVendedor":{"type":"string","description":"Nome do vendedor."},"cNomeSolucao":{"type":"string","description":"Nome da Solução."},"nTemperatura":{"type":"integer","description":"Temperatura da Oportunidade. (°C)"},"cSituacao":{"type":"string","description":"Situação da Oportunidade. Indica se a Oportunidade está como Previsão,Atrasada ou Concluída."},"cIcone":{"type":"string"},"cCor":{"type":"string"},"vTicket":{"type":"decimal","description":"Valor do Ticket Calculado da Oportunidade."},"nQtdeTarefas":{"type":"integer","description":"Indica o número de tarefas da oportunidade."}}},"description":"Lista de oportunidades."}},"title":"ObterListaOp (retorno)"},"crm_oportunidadesresumo_ObterResumoOp":{"type":"object","title":"ObterResumoOp","description":"Resumo das oportunidades.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterResumoOp"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdVendedor":{"type":"integer","maxLength":15,"description":"Código do usuário / vendedor."},"nIdParceiro":{"type":"integer","maxLength":15,"description":"Código do parceiro ou equipe."},"cMesAno":{"type":"string","example":"05/2026","description":"Mes e ano. (MM/AAAA)."},"lApenasResumo":{"type":"boolean","description":"Exibir apenas o resumo.\n\nQuando true será retornado as estruturas:\n\nfunilOportunidades->mesAtual\nsaudePipeline\n\nQuando false retornará todas as estruturas.\n\nDefault = true"}}}}},"example":{"call":"ObterResumoOp","param":[{"nIdVendedor":0,"nIdParceiro":0,"cMesAno":"02/2022","lApenasResumo":true}]}},"crm_oportunidadesresumo_ObterResumoOp_retorno":{"type":"object","properties":{"nIdVendedor":{"type":"integer","description":"Código do usuário / vendedor."},"nIdParceiro":{"type":"integer","description":"Código do parceiro ou equipe."},"cMesAno":{"type":"string","description":"Mes e ano. (MM/AAAA)."},"funilOportunidades":{"type":"object","properties":{"mesAtual":{"type":"object","properties":{"nEmProcesso":{"type":"decimal","description":"Quantidade em processo."},"nBoasChances":{"type":"decimal","description":"Quantidade boas chances."},"nComprometido":{"type":"decimal","description":"Quantidade comprometido."},"nConquistado":{"type":"decimal","description":"Quantidade conquistado."},"vEmProcesso":{"type":"decimal","description":"Valor em processo."},"vBoasChances":{"type":"decimal","description":"Valor boas chances."},"vComprometido":{"type":"decimal","description":"Valor comprometido."},"vConquistado":{"type":"decimal","description":"Valor conquistado."}},"description":"Resumo total mês atual."},"proximoMes":{"type":"object","properties":{"nEmProcesso":{"type":"decimal","description":"Quantidade em processo."},"nBoasChances":{"type":"decimal","description":"Quantidade boas chances."},"nComprometido":{"type":"decimal","description":"Quantidade Comprometido."},"vEmProcesso":{"type":"decimal","description":"Valor em processo."},"vBoasChances":{"type":"decimal","description":"Valor boas chances."},"vComprometido":{"type":"decimal","description":"Valor comprometido."}},"description":"Resumo total próximo mês."},"mesesSeguintes":{"type":"object","properties":{"nEmProcesso":{"type":"decimal","description":"Quantidade em processo."},"nBoasChances":{"type":"decimal","description":"Quantidade boas chances."},"nComprometido":{"type":"decimal","description":"Quantidade Comprometido."},"vEmProcesso":{"type":"decimal","description":"Valor em processo."},"vBoasChances":{"type":"decimal","description":"Valor boas chances."},"vComprometido":{"type":"decimal","description":"Valor comprometido."}},"description":"Resumo total próximos meses."}},"description":"Funil de oportunidades."},"saudePipeline":{"type":"object","properties":{"vMeta":{"type":"decimal","description":"Valor meta."},"vConquistado":{"type":"decimal","description":"Valor conquistado."},"nConquistado":{"type":"decimal","description":"Quantidade conquistado."},"vNecessario":{"type":"decimal","description":"Valor necessário."},"vARealizar":{"type":"decimal","description":"Valor a realizar."},"pExistente":{"type":"decimal","description":"Percentual existente."},"nSaude":{"type":"decimal","description":"Valor saúde."},"nIndicador":{"type":"decimal","description":"Indicador do status do pipeline. Pode ser de 0 até 300."},"nMultiplicador":{"type":"decimal","description":"Multiplicador da meta."},"cStatus":{"type":"string","description":"Status da saúde do pipeline. Pode ser: Se <= 100 = CRÍTICO Se entre 100 e 200 = ACEITÁVEL Se maior que 200 = EXCELENTE"}},"description":"Saúde do pipeline."}},"title":"ObterResumoOp (retorno)"},"crm_oportunidades_AlterarOportunidade":{"type":"object","title":"AlterarOportunidade","description":"Alteração de oportunidade.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarOportunidade"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"identificacao":{"type":"object","properties":{"nCodOp":{"type":"integer","maxLength":15,"description":"Código da oportunidade.\n(Gerado internamente, não é visualizado na tela)"},"cCodIntOp":{"type":"string","description":"Código de integração da oportunidade.\n(Utilizado em títulos criados via API, não é visualizado na tela)"},"cDesOp":{"type":"string","maxLength":100,"description":"Descrição da oportunidade."},"nCodContato":{"type":"integer","maxLength":15,"description":"Código do contato da oportunidade.\nObrigatório na inclusão: a oportunidade sempre tem um contato, como na tela."},"nCodSolucao":{"type":"integer","maxLength":15,"description":"Código da solução.\n(Gerado internamente, não é visualizado na tela)"},"nCodOrigem":{"type":"integer","maxLength":15,"description":"Código da origem.\n(Gerado internamente, não é visualizado na tela)"},"nCodConta":{"type":"integer","maxLength":15,"description":"Código da conta.\n(Gerado internamente, não é visualizado na tela)"},"nCodVendedor":{"type":"integer","maxLength":15,"description":"Código do vendedor.\n(Gerado internamente, não é visualizado na tela)"},"cNumOp":{"type":"string","maxLength":20,"description":"Número da oportunidade."}}},"fasesStatus":{"type":"object","properties":{"nCodFase":{"type":"integer","maxLength":15,"description":"Código da fase.\n(Gerado internamente, não é visualizado na tela)"},"nCodStatus":{"type":"integer","maxLength":15,"description":"Código do status.\n(Gerado internamente, não é visualizado na tela)"},"nCodMotivo":{"type":"integer","maxLength":15,"description":"Código do motivo.\n(Gerado internamente, não é visualizado na tela)"},"dNovoLead":{"type":"string","maxLength":10,"description":"Data do Novo Lead."},"dQualificacao":{"type":"string","maxLength":10,"description":"Data da Qualificação."},"dTreinamento":{"type":"string","maxLength":10,"description":"Data de Treinamento."},"dShowRoom":{"type":"string","maxLength":10,"description":"Data de ShowRoom."},"dProjeto":{"type":"string","maxLength":10,"description":"Data de projeto."},"dConclusao":{"type":"string","maxLength":10,"description":"Data de conclusão."}}},"ticket":{"type":"object","properties":{"nProdutos":{"type":"number","maxLength":15,"description":"Valor de produtos."},"nServicos":{"type":"number","maxLength":15,"description":"Valor de serviços."},"nRecorrencia":{"type":"number","maxLength":15,"description":"Valor da recorrência."},"nMeses":{"type":"integer","maxLength":3,"description":"Meses de contrato."},"nTicket":{"type":"number","maxLength":15,"description":"Valor do ticket calculado.\n(Calculado automaticamente)"}}},"previsaoTemp":{"type":"object","properties":{"nTemperatura":{"type":"integer","maxLength":3,"description":"Temperatura"},"nMesPrev":{"type":"integer","maxLength":2,"description":"Mês de previsão de fechamento."},"nAnoPrev":{"type":"integer","maxLength":4,"description":"Ano de previsão de fechamento."}},"description":"Previsão e Temperatura"},"observacoes":{"type":"object","properties":{"cObs":{"type":"string","description":"Observações da Oportunidade"}}},"outrasInf":{"type":"object","properties":{"nCodTipo":{"type":"integer","maxLength":15,"description":"Código do tipo."},"cEmailOp":{"type":"string","maxLength":100,"description":"E-mail da oportunidade."},"dInclusao":{"type":"string","maxLength":10,"description":"Data de inclusão da oportunidade."},"hInclusao":{"type":"string","maxLength":8,"description":"Hora de inclusão da oportunidade."},"dAlteracao":{"type":"string","maxLength":10,"description":"Data de alteração da oportunidade."},"hAlteracao":{"type":"string","maxLength":8,"description":"Hora de alteração da oportunidade."}}},"envolvidos":{"type":"object","properties":{"nCodFinder":{"type":"integer","maxLength":15,"description":"Código do Finder.\n(Gerado internamente, não é visualizado na tela)"},"nCodParceiro":{"type":"integer","maxLength":15,"description":"Código do parceiro."},"nCodPrevenda":{"type":"integer","maxLength":15,"description":"Código da prevenda.\n(Gerado internamente, não é visualizado na tela)"}}},"concorrentes":{"type":"array","items":{"type":"object","properties":{"nCodConc":{"type":"integer","maxLength":15,"description":"Código do concorrente.\n(Gerado internamente, não é visualizado na tela)"},"cCodIntConc":{"type":"string","maxLength":20,"description":"Código de integração do concorrente.\n(Utilizado em títulos criados via API, não é visualizado na tela)"},"cObservacao":{"type":"string","description":"Observação do Concorrente."}}}}}}}},"example":{"call":"AlterarOportunidade","param":[{"identificacao":{"nCodOp":7654321,"cDesOp":"Implantacao Omie - Cliente XYZ (revisado)"}}]}},"crm_oportunidades_AlterarOportunidade_retorno":{"type":"object","properties":{"nCodOp":{"type":"integer","description":"Código da Oportunidade"},"cCodIntOp":{"type":"string","description":"Código de Integração da Oportunidade"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDesStatus":{"type":"string","description":"Descrição do Status"}},"title":"AlterarOportunidade (retorno)"},"crm_oportunidades_ConsultarOportunidade":{"type":"object","title":"ConsultarOportunidade","description":"Consulta de oportunidade.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarOportunidade"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodOp":{"type":"integer","maxLength":15,"description":"Código da oportunidade.\n(Gerado internamente, não é visualizado na tela)"},"cCodIntOp":{"type":"string","description":"Código de integração da oportunidade.\n(Utilizado em títulos criados via API, não é visualizado na tela)"}}}}},"example":{"call":"ConsultarOportunidade","param":[{"nCodOp":7654321}]}},"crm_oportunidades_ConsultarOportunidade_retorno":{"type":"object","properties":{"identificacao":{"type":"object","properties":{"nCodOp":{"type":"integer","description":"Código da oportunidade. (Gerado internamente, não é visualizado na tela)"},"cCodIntOp":{"type":"string","description":"Código de integração da oportunidade. (Utilizado em títulos criados via API, não é visualizado na tela)"},"cDesOp":{"type":"string","description":"Descrição da oportunidade."},"nCodContato":{"type":"integer","description":"Código do contato da oportunidade. Obrigatório na inclusão: a oportunidade sempre tem um contato, como na tela."},"nCodSolucao":{"type":"integer","description":"Código da solução. (Gerado internamente, não é visualizado na tela)"},"nCodOrigem":{"type":"integer","description":"Código da origem. (Gerado internamente, não é visualizado na tela)"},"nCodConta":{"type":"integer","description":"Código da conta. (Gerado internamente, não é visualizado na tela)"},"nCodVendedor":{"type":"integer","description":"Código do vendedor. (Gerado internamente, não é visualizado na tela)"},"cNumOp":{"type":"string","description":"Número da oportunidade."}}},"fasesStatus":{"type":"object","properties":{"nCodFase":{"type":"integer","description":"Código da fase. (Gerado internamente, não é visualizado na tela)"},"nCodStatus":{"type":"integer","description":"Código do status. (Gerado internamente, não é visualizado na tela)"},"nCodMotivo":{"type":"integer","description":"Código do motivo. (Gerado internamente, não é visualizado na tela)"},"dNovoLead":{"type":"string","description":"Data do Novo Lead."},"dQualificacao":{"type":"string","description":"Data da Qualificação."},"dTreinamento":{"type":"string","description":"Data de Treinamento."},"dShowRoom":{"type":"string","description":"Data de ShowRoom."},"dProjeto":{"type":"string","description":"Data de projeto."},"dConclusao":{"type":"string","description":"Data de conclusão."}}},"ticket":{"type":"object","properties":{"nProdutos":{"type":"decimal","description":"Valor de produtos."},"nServicos":{"type":"decimal","description":"Valor de serviços."},"nRecorrencia":{"type":"decimal","description":"Valor da recorrência."},"nMeses":{"type":"integer","description":"Meses de contrato."},"nTicket":{"type":"decimal","description":"Valor do ticket calculado. (Calculado automaticamente)"}}},"previsaoTemp":{"type":"object","properties":{"nTemperatura":{"type":"integer","description":"Temperatura"},"nMesPrev":{"type":"integer","description":"Mês de previsão de fechamento."},"nAnoPrev":{"type":"integer","description":"Ano de previsão de fechamento."}},"description":"Previsão e Temperatura"},"observacoes":{"type":"object","properties":{"cObs":{"type":"string","description":"Observações da Oportunidade"}}},"outrasInf":{"type":"object","properties":{"nCodTipo":{"type":"integer","description":"Código do tipo."},"cEmailOp":{"type":"string","description":"E-mail da oportunidade."},"dInclusao":{"type":"string","description":"Data de inclusão da oportunidade."},"hInclusao":{"type":"string","description":"Hora de inclusão da oportunidade."},"dAlteracao":{"type":"string","description":"Data de alteração da oportunidade."},"hAlteracao":{"type":"string","description":"Hora de alteração da oportunidade."}}},"envolvidos":{"type":"object","properties":{"nCodFinder":{"type":"integer","description":"Código do Finder. (Gerado internamente, não é visualizado na tela)"},"nCodParceiro":{"type":"integer","description":"Código do parceiro."},"nCodPrevenda":{"type":"integer","description":"Código da prevenda. (Gerado internamente, não é visualizado na tela)"}}},"concorrentes":{"type":"array","items":{"type":"object","properties":{"nCodConc":{"type":"integer","description":"Código do concorrente. (Gerado internamente, não é visualizado na tela)"},"cCodIntConc":{"type":"string","description":"Código de integração do concorrente. (Utilizado em títulos criados via API, não é visualizado na tela)"},"cObservacao":{"type":"string","description":"Observação do Concorrente."}}}}},"title":"ConsultarOportunidade (retorno)"},"crm_oportunidades_ExcluirOportunidade":{"type":"object","title":"ExcluirOportunidade","description":"Exclusão de oportunidade.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirOportunidade"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodOp":{"type":"integer","maxLength":15,"description":"Código da oportunidade.\n(Gerado internamente, não é visualizado na tela)"},"cCodIntOp":{"type":"string","description":"Código de integração da oportunidade.\n(Utilizado em títulos criados via API, não é visualizado na tela)"}}}}},"example":{"call":"ExcluirOportunidade","param":[{"nCodOp":7654321}]}},"crm_oportunidades_ExcluirOportunidade_retorno":{"type":"object","properties":{"nCodOp":{"type":"integer","description":"Código da Oportunidade"},"cCodIntOp":{"type":"string","description":"Código de Integração da Oportunidade"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDesStatus":{"type":"string","description":"Descrição do Status"}},"title":"ExcluirOportunidade (retorno)"},"crm_oportunidades_IncluirOportunidade":{"type":"object","title":"IncluirOportunidade","description":"Incluir uma oportunidade.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirOportunidade"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"identificacao":{"type":"object","properties":{"nCodOp":{"type":"integer","maxLength":15,"description":"Código da oportunidade.\n(Gerado internamente, não é visualizado na tela)"},"cCodIntOp":{"type":"string","description":"Código de integração da oportunidade.\n(Utilizado em títulos criados via API, não é visualizado na tela)"},"cDesOp":{"type":"string","maxLength":100,"description":"Descrição da oportunidade."},"nCodContato":{"type":"integer","maxLength":15,"description":"Código do contato da oportunidade.\nObrigatório na inclusão: a oportunidade sempre tem um contato, como na tela."},"nCodSolucao":{"type":"integer","maxLength":15,"description":"Código da solução.\n(Gerado internamente, não é visualizado na tela)"},"nCodOrigem":{"type":"integer","maxLength":15,"description":"Código da origem.\n(Gerado internamente, não é visualizado na tela)"},"nCodConta":{"type":"integer","maxLength":15,"description":"Código da conta.\n(Gerado internamente, não é visualizado na tela)"},"nCodVendedor":{"type":"integer","maxLength":15,"description":"Código do vendedor.\n(Gerado internamente, não é visualizado na tela)"},"cNumOp":{"type":"string","maxLength":20,"description":"Número da oportunidade."}}},"fasesStatus":{"type":"object","properties":{"nCodFase":{"type":"integer","maxLength":15,"description":"Código da fase.\n(Gerado internamente, não é visualizado na tela)"},"nCodStatus":{"type":"integer","maxLength":15,"description":"Código do status.\n(Gerado internamente, não é visualizado na tela)"},"nCodMotivo":{"type":"integer","maxLength":15,"description":"Código do motivo.\n(Gerado internamente, não é visualizado na tela)"},"dNovoLead":{"type":"string","maxLength":10,"description":"Data do Novo Lead."},"dQualificacao":{"type":"string","maxLength":10,"description":"Data da Qualificação."},"dTreinamento":{"type":"string","maxLength":10,"description":"Data de Treinamento."},"dShowRoom":{"type":"string","maxLength":10,"description":"Data de ShowRoom."},"dProjeto":{"type":"string","maxLength":10,"description":"Data de projeto."},"dConclusao":{"type":"string","maxLength":10,"description":"Data de conclusão."}}},"ticket":{"type":"object","properties":{"nProdutos":{"type":"number","maxLength":15,"description":"Valor de produtos."},"nServicos":{"type":"number","maxLength":15,"description":"Valor de serviços."},"nRecorrencia":{"type":"number","maxLength":15,"description":"Valor da recorrência."},"nMeses":{"type":"integer","maxLength":3,"description":"Meses de contrato."},"nTicket":{"type":"number","maxLength":15,"description":"Valor do ticket calculado.\n(Calculado automaticamente)"}}},"previsaoTemp":{"type":"object","properties":{"nTemperatura":{"type":"integer","maxLength":3,"description":"Temperatura"},"nMesPrev":{"type":"integer","maxLength":2,"description":"Mês de previsão de fechamento."},"nAnoPrev":{"type":"integer","maxLength":4,"description":"Ano de previsão de fechamento."}},"description":"Previsão e Temperatura"},"observacoes":{"type":"object","properties":{"cObs":{"type":"string","description":"Observações da Oportunidade"}}},"outrasInf":{"type":"object","properties":{"nCodTipo":{"type":"integer","maxLength":15,"description":"Código do tipo."},"cEmailOp":{"type":"string","maxLength":100,"description":"E-mail da oportunidade."},"dInclusao":{"type":"string","maxLength":10,"description":"Data de inclusão da oportunidade."},"hInclusao":{"type":"string","maxLength":8,"description":"Hora de inclusão da oportunidade."},"dAlteracao":{"type":"string","maxLength":10,"description":"Data de alteração da oportunidade."},"hAlteracao":{"type":"string","maxLength":8,"description":"Hora de alteração da oportunidade."}}},"envolvidos":{"type":"object","properties":{"nCodFinder":{"type":"integer","maxLength":15,"description":"Código do Finder.\n(Gerado internamente, não é visualizado na tela)"},"nCodParceiro":{"type":"integer","maxLength":15,"description":"Código do parceiro."},"nCodPrevenda":{"type":"integer","maxLength":15,"description":"Código da prevenda.\n(Gerado internamente, não é visualizado na tela)"}}},"concorrentes":{"type":"array","items":{"type":"object","properties":{"nCodConc":{"type":"integer","maxLength":15,"description":"Código do concorrente.\n(Gerado internamente, não é visualizado na tela)"},"cCodIntConc":{"type":"string","maxLength":20,"description":"Código de integração do concorrente.\n(Utilizado em títulos criados via API, não é visualizado na tela)"},"cObservacao":{"type":"string","description":"Observação do Concorrente."}}}}}}}},"example":{"call":"IncluirOportunidade","param":[{"identificacao":{"cDesOp":"Implantacao Omie - Cliente XYZ","nCodContato":123456},"ticket":{"nProdutos":1500.0,"nMeses":12}}]}},"crm_oportunidades_IncluirOportunidade_retorno":{"type":"object","properties":{"nCodOp":{"type":"integer","description":"Código da Oportunidade"},"cCodIntOp":{"type":"string","description":"Código de Integração da Oportunidade"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDesStatus":{"type":"string","description":"Descrição do Status"}},"title":"IncluirOportunidade (retorno)"},"crm_oportunidades_ListarOportunidades":{"type":"object","title":"ListarOportunidades","description":"Lista de oportunidades.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarOportunidades"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"apenas_importado_api":{"type":"string","maxLength":1,"description":"Exibir apenas os registros gerados pela API"},"ordenar_por":{"type":"string","maxLength":100,"example":"CODIGO","description":"Ordem de exibição dos dados."},"ordem_decrescente":{"type":"string","maxLength":1,"example":"S","description":"Se a lista será apresentada em ordem decrescente."},"email_vendedor":{"type":"string","description":"E-Mail do Vendedor"},"codigo_vendedor":{"type":"integer","maxLength":15,"description":"Código do Vendedor."},"ano_previsao_inicial":{"type":"string","maxLength":4,"description":"Ano de previsão inicial da oportunidade."},"ano_previsao_final":{"type":"string","maxLength":4,"description":"Ano de previsão final da oportunidade."},"mes_previsao_inicial":{"type":"string","maxLength":2,"description":"Mês de previsão inicial da oportunidade."},"mes_previsao_final":{"type":"string","maxLength":2,"description":"Mês de previsão final da oportunidade."},"data_inclusao_inicial":{"type":"string","maxLength":10,"description":"Data de inclusão inicial da oportunidade."},"data_inclusao_final":{"type":"string","maxLength":10,"description":"Data de inclusão final da oportunidade."},"hora_inclusao_inicial":{"type":"string","maxLength":8,"description":"Hora de inclusão inicial."},"hora_inclusao_final":{"type":"string","maxLength":8,"description":"Hora de inclusão final."},"data_alteracao_inicial":{"type":"string","maxLength":10,"description":"Data de alteração inicial."},"data_alteracao_final":{"type":"string","maxLength":10,"description":"Data de alteração final"},"hora_alteracao_inicial":{"type":"string","maxLength":8,"description":"Hora de alteração inicial"},"hora_alteracao_final":{"type":"string","maxLength":8,"description":"Hora de alteração final."},"status":{"type":"string","maxLength":20,"example":"A","description":"Status da oportunidade.\n\nPode ser:\n\nA - Ativo\nC - Cancelado\nP - Perdido\nS - Suspenso\nV - Conquistado\n\nPara informar mais de um status utilize virgulas."},"fase":{"type":"integer","maxLength":15,"description":"Código da fase da oportunidade."},"motivo":{"type":"integer","maxLength":15,"description":"Código do motivo."},"exibir_detalhes":{"type":"string","maxLength":1,"description":"Exibe os detalhes da oportunidade."},"exibir_apenas_op_vendedor":{"type":"string","maxLength":1,"description":"Exibir apenas as oportunidades que pertencem ao vendedor selecionado.\n\nAtivando esse filtro os vendedores com credenciais para visualizar todas as oportunidades passam a se comportam como um usuário comum, que tem acesso apenas as suas próprias oportunidades."},"filtrar_por_descricao":{"type":"string","maxLength":100,"description":"Descrição da oportunidade."},"filtrar_por_conta":{"type":"integer","maxLength":15,"description":"Código da conta.\n(Gerado internamente, não é visualizado na tela)"},"exibir_obs":{"type":"string","maxLength":1,"example":"S","description":"Exibir as observações da oportunidade (S/N).\n\nPreencher com \"S\" ou \"N\"."}}}}},"example":{"call":"ListarOportunidades","param":[{"pagina":1,"registros_por_pagina":20}]}},"crm_oportunidades_ListarOportunidades_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada"},"total_de_paginas":{"type":"integer","description":"Número total de páginas"},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"Total de registros encontrados."},"cadastros":{"type":"array","items":{"type":"object","properties":{"identificacao":{"type":"object","properties":{"nCodOp":{"type":"integer","description":"Código da oportunidade. (Gerado internamente, não é visualizado na tela)"},"cCodIntOp":{"type":"string","description":"Código de integração da oportunidade. (Utilizado em títulos criados via API, não é visualizado na tela)"},"cDesOp":{"type":"string","description":"Descrição da oportunidade."},"nCodContato":{"type":"integer","description":"Código do contato da oportunidade. Obrigatório na inclusão: a oportunidade sempre tem um contato, como na tela."},"nCodSolucao":{"type":"integer","description":"Código da solução. (Gerado internamente, não é visualizado na tela)"},"nCodOrigem":{"type":"integer","description":"Código da origem. (Gerado internamente, não é visualizado na tela)"},"nCodConta":{"type":"integer","description":"Código da conta. (Gerado internamente, não é visualizado na tela)"},"nCodVendedor":{"type":"integer","description":"Código do vendedor. (Gerado internamente, não é visualizado na tela)"},"cNumOp":{"type":"string","description":"Número da oportunidade."}}},"fasesStatus":{"type":"object","properties":{"nCodFase":{"type":"integer","description":"Código da fase. (Gerado internamente, não é visualizado na tela)"},"nCodStatus":{"type":"integer","description":"Código do status. (Gerado internamente, não é visualizado na tela)"},"nCodMotivo":{"type":"integer","description":"Código do motivo. (Gerado internamente, não é visualizado na tela)"},"dNovoLead":{"type":"string","description":"Data do Novo Lead."},"dQualificacao":{"type":"string","description":"Data da Qualificação."},"dTreinamento":{"type":"string","description":"Data de Treinamento."},"dShowRoom":{"type":"string","description":"Data de ShowRoom."},"dProjeto":{"type":"string","description":"Data de projeto."},"dConclusao":{"type":"string","description":"Data de conclusão."}}},"ticket":{"type":"object","properties":{"nProdutos":{"type":"decimal","description":"Valor de produtos."},"nServicos":{"type":"decimal","description":"Valor de serviços."},"nRecorrencia":{"type":"decimal","description":"Valor da recorrência."},"nMeses":{"type":"integer","description":"Meses de contrato."},"nTicket":{"type":"decimal","description":"Valor do ticket calculado. (Calculado automaticamente)"}}},"previsaoTemp":{"type":"object","properties":{"nTemperatura":{"type":"integer","description":"Temperatura"},"nMesPrev":{"type":"integer","description":"Mês de previsão de fechamento."},"nAnoPrev":{"type":"integer","description":"Ano de previsão de fechamento."}},"description":"Previsão e Temperatura"},"observacoes":{"type":"object","properties":{"cObs":{"type":"string","description":"Observações da Oportunidade"}}},"outrasInf":{"type":"object","properties":{"nCodTipo":{"type":"integer","description":"Código do tipo."},"cEmailOp":{"type":"string","description":"E-mail da oportunidade."},"dInclusao":{"type":"string","description":"Data de inclusão da oportunidade."},"hInclusao":{"type":"string","description":"Hora de inclusão da oportunidade."},"dAlteracao":{"type":"string","description":"Data de alteração da oportunidade."},"hAlteracao":{"type":"string","description":"Hora de alteração da oportunidade."}}},"envolvidos":{"type":"object","properties":{"nCodFinder":{"type":"integer","description":"Código do Finder. (Gerado internamente, não é visualizado na tela)"},"nCodParceiro":{"type":"integer","description":"Código do parceiro."},"nCodPrevenda":{"type":"integer","description":"Código da prevenda. (Gerado internamente, não é visualizado na tela)"}}},"concorrentes":{"type":"array","items":{"type":"object","properties":{"nCodConc":{"type":"integer","description":"Código do concorrente. (Gerado internamente, não é visualizado na tela)"},"cCodIntConc":{"type":"string","description":"Código de integração do concorrente. (Utilizado em títulos criados via API, não é visualizado na tela)"},"cObservacao":{"type":"string","description":"Observação do Concorrente."}}}},"tarefas":{"type":"array","items":{"type":"object","properties":{"cCodIntTarefa":{"type":"string","description":"Código de Integração da Tarefa."},"cDescricaoTarefa":{"type":"string","description":"Descrição da Tarefa."},"cDataTarefa":{"type":"string","description":"Data da Tarefa."},"cHoraTarefa":{"type":"string","description":"Hora da Tarefa."},"cImportante":{"type":"string","description":"Tarefa está definida como \"Importante\": S/N."},"cEmExecucao":{"type":"string","description":"Tarefa está definida como \"Em Execução\": S/N"},"cRealizada":{"type":"string","description":"Tarefa está definida como \"Realizada\": S/N"},"cUrgente":{"type":"string","description":"Tarefa está definida como \"Urgente\": S/N"},"nCodAtividade":{"type":"integer","description":"Código do Atividade."},"cDesAtividade":{"type":"string","description":"Descrição da Atividade."},"nCodNotificacao":{"type":"integer","description":"Código da Notificação."},"cDesNotificacao":{"type":"string","description":"Descrição da Notificação."},"nCodUsuario":{"type":"integer","description":"Código do usuário."},"cNomUsuario":{"type":"string","description":"Nome do usuário."},"cEmailUsuario":{"type":"string","description":"E-mail do usuário."}}},"description":"Lista de tarefas associadas."}}},"description":"Lista os cadastros encontrados."},"lista_papeis":{"type":"array","items":{"type":"object","properties":{"cDescricaoPapel":{"type":"string","description":"Descrição do Papel."},"nOrdemPapel":{"type":"integer","description":"Ordem do Papel."}}},"description":"Lista de Papeis"},"lista_tickets":{"type":"array","items":{"type":"object","properties":{"cDescricaoTicket":{"type":"string","description":"Descrição do ticket."},"nOrdemTicket":{"type":"integer","description":"Ordem do Ticket."}}},"description":"Lista de descrições dos títulos."}},"title":"ListarOportunidades (retorno)"},"crm_oportunidades_UpsertOportunidade":{"type":"object","title":"UpsertOportunidade","description":"Upsert de oportunidade.","required":["call","param"],"properties":{"call":{"type":"string","enum":["UpsertOportunidade"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"identificacao":{"type":"object","properties":{"nCodOp":{"type":"integer","maxLength":15,"description":"Código da oportunidade.\n(Gerado internamente, não é visualizado na tela)"},"cCodIntOp":{"type":"string","description":"Código de integração da oportunidade.\n(Utilizado em títulos criados via API, não é visualizado na tela)"},"cDesOp":{"type":"string","maxLength":100,"description":"Descrição da oportunidade."},"nCodContato":{"type":"integer","maxLength":15,"description":"Código do contato da oportunidade.\nObrigatório na inclusão: a oportunidade sempre tem um contato, como na tela."},"nCodSolucao":{"type":"integer","maxLength":15,"description":"Código da solução.\n(Gerado internamente, não é visualizado na tela)"},"nCodOrigem":{"type":"integer","maxLength":15,"description":"Código da origem.\n(Gerado internamente, não é visualizado na tela)"},"nCodConta":{"type":"integer","maxLength":15,"description":"Código da conta.\n(Gerado internamente, não é visualizado na tela)"},"nCodVendedor":{"type":"integer","maxLength":15,"description":"Código do vendedor.\n(Gerado internamente, não é visualizado na tela)"},"cNumOp":{"type":"string","maxLength":20,"description":"Número da oportunidade."}}},"fasesStatus":{"type":"object","properties":{"nCodFase":{"type":"integer","maxLength":15,"description":"Código da fase.\n(Gerado internamente, não é visualizado na tela)"},"nCodStatus":{"type":"integer","maxLength":15,"description":"Código do status.\n(Gerado internamente, não é visualizado na tela)"},"nCodMotivo":{"type":"integer","maxLength":15,"description":"Código do motivo.\n(Gerado internamente, não é visualizado na tela)"},"dNovoLead":{"type":"string","maxLength":10,"description":"Data do Novo Lead."},"dQualificacao":{"type":"string","maxLength":10,"description":"Data da Qualificação."},"dTreinamento":{"type":"string","maxLength":10,"description":"Data de Treinamento."},"dShowRoom":{"type":"string","maxLength":10,"description":"Data de ShowRoom."},"dProjeto":{"type":"string","maxLength":10,"description":"Data de projeto."},"dConclusao":{"type":"string","maxLength":10,"description":"Data de conclusão."}}},"ticket":{"type":"object","properties":{"nProdutos":{"type":"number","maxLength":15,"description":"Valor de produtos."},"nServicos":{"type":"number","maxLength":15,"description":"Valor de serviços."},"nRecorrencia":{"type":"number","maxLength":15,"description":"Valor da recorrência."},"nMeses":{"type":"integer","maxLength":3,"description":"Meses de contrato."},"nTicket":{"type":"number","maxLength":15,"description":"Valor do ticket calculado.\n(Calculado automaticamente)"}}},"previsaoTemp":{"type":"object","properties":{"nTemperatura":{"type":"integer","maxLength":3,"description":"Temperatura"},"nMesPrev":{"type":"integer","maxLength":2,"description":"Mês de previsão de fechamento."},"nAnoPrev":{"type":"integer","maxLength":4,"description":"Ano de previsão de fechamento."}},"description":"Previsão e Temperatura"},"observacoes":{"type":"object","properties":{"cObs":{"type":"string","description":"Observações da Oportunidade"}}},"outrasInf":{"type":"object","properties":{"nCodTipo":{"type":"integer","maxLength":15,"description":"Código do tipo."},"cEmailOp":{"type":"string","maxLength":100,"description":"E-mail da oportunidade."},"dInclusao":{"type":"string","maxLength":10,"description":"Data de inclusão da oportunidade."},"hInclusao":{"type":"string","maxLength":8,"description":"Hora de inclusão da oportunidade."},"dAlteracao":{"type":"string","maxLength":10,"description":"Data de alteração da oportunidade."},"hAlteracao":{"type":"string","maxLength":8,"description":"Hora de alteração da oportunidade."}}},"envolvidos":{"type":"object","properties":{"nCodFinder":{"type":"integer","maxLength":15,"description":"Código do Finder.\n(Gerado internamente, não é visualizado na tela)"},"nCodParceiro":{"type":"integer","maxLength":15,"description":"Código do parceiro."},"nCodPrevenda":{"type":"integer","maxLength":15,"description":"Código da prevenda.\n(Gerado internamente, não é visualizado na tela)"}}},"concorrentes":{"type":"array","items":{"type":"object","properties":{"nCodConc":{"type":"integer","maxLength":15,"description":"Código do concorrente.\n(Gerado internamente, não é visualizado na tela)"},"cCodIntConc":{"type":"string","maxLength":20,"description":"Código de integração do concorrente.\n(Utilizado em títulos criados via API, não é visualizado na tela)"},"cObservacao":{"type":"string","description":"Observação do Concorrente."}}}}}}}},"example":{"call":"UpsertOportunidade","param":[{"identificacao":{"cCodIntOp":"OP0001","cDesOp":"Implantacao Omie - Cliente XYZ"}}]}},"crm_oportunidades_UpsertOportunidade_retorno":{"type":"object","properties":{"nCodOp":{"type":"integer","description":"Código da Oportunidade"},"cCodIntOp":{"type":"string","description":"Código de Integração da Oportunidade"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDesStatus":{"type":"string","description":"Descrição do Status"}},"title":"UpsertOportunidade (retorno)"},"crm_origens_ListarOrigens":{"type":"object","title":"ListarOrigens","description":"Origens da oportunidade.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarOrigens"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"apenas_importado_api":{"type":"string","maxLength":1,"example":"S","description":"Exibir apenas os registros gerados pela API."},"ordenar_por":{"type":"string","maxLength":100,"example":"CODIGO","description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"example":"S","description":"Se a lista será apresentada em ordem decrescente."}}}}},"example":{"call":"ListarOrigens","param":[{"pagina":1,"registros_por_pagina":20}]}},"crm_origens_ListarOrigens_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada."},"total_de_paginas":{"type":"integer","description":"Número total de páginas."},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"Total de registros encontrados."},"cadastros":{"type":"array","items":{"type":"object","properties":{"nCodigo":{"type":"integer","description":"Código do tipo de oportunidade."},"cDescricao":{"type":"string","description":"Descrição do tipo de oportunidade."},"cObservacao":{"type":"string","description":"Observação do tipo de oportunidade."}}},"description":"Lista os cadastros encontrados."}},"title":"ListarOrigens (retorno)"},"crm_parceiros_ListarParceiros":{"type":"object","title":"ListarParceiros","description":"Parceiros e equipes da oportunidade.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarParceiros"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"apenas_importado_api":{"type":"string","maxLength":1,"description":"Exibir apenas os registros gerados pela API."},"ordenar_por":{"type":"string","maxLength":100,"example":"CODIGO","description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."}}}}},"example":{"call":"ListarParceiros","param":[{"pagina":1,"registros_por_pagina":20}]}},"crm_parceiros_ListarParceiros_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada."},"total_de_paginas":{"type":"integer","description":"Número total de páginas."},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"Total de registros encontrados."},"cadastros":{"type":"array","items":{"type":"object","properties":{"nCodigo":{"type":"integer","description":"Código do parceiro / equipe."},"cDescricao":{"type":"string","description":"Descrição do parceiro / equipe."},"cEmail":{"type":"string","description":"Email do parceiro / equipe."},"cObservacao":{"type":"string","description":"Observação."},"cInativo":{"type":"string","description":"Indica se o parceiro / equipe está inativo."}}},"description":"Lista os cadastros encontrados."}},"title":"ListarParceiros (retorno)"},"crm_solucoes_ListarSolucoes":{"type":"object","title":"ListarSolucoes","description":"Lista as soluções disponíveis para a oportunidade.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarSolucoes"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"apenas_importado_api":{"type":"string","maxLength":1,"description":"Exibir apenas os registros gerados pela API"},"ordenar_por":{"type":"string","maxLength":100,"example":"Código","description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."},"nCodigo":{"type":"integer","maxLength":15,"description":"Código da solução."}}}}},"example":{"call":"ListarSolucoes","param":[{"pagina":1,"registros_por_pagina":20}]}},"crm_solucoes_ListarSolucoes_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada"},"total_de_paginas":{"type":"integer","description":"Número total de páginas"},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"total de registros encontrados"},"cadastros":{"type":"array","items":{"type":"object","properties":{"nCodigo":{"type":"integer","description":"Código da solução."},"cDescricao":{"type":"string","description":"Descrição da solução."},"cObservacao":{"type":"string","description":"Observações."},"cInativo":{"type":"string","description":"Indica se a solução está inativa."}}},"description":"Lista os cadastros encontrados."}},"title":"ListarSolucoes (retorno)"},"crm_status_ListarStatus":{"type":"object","title":"ListarStatus","description":"Status da oportunidade.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarStatus"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"apenas_importado_api":{"type":"string","maxLength":1,"description":"Exibir apenas os registros gerados pela API."},"ordenar_por":{"type":"string","maxLength":100,"example":"CODIGO","description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."}}}}},"example":{"call":"ListarStatus","param":[{"pagina":1,"registros_por_pagina":20}]}},"crm_status_ListarStatus_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada."},"total_de_paginas":{"type":"integer","description":"Número total de páginas."},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"Total de registros encontrados."},"cadastros":{"type":"array","items":{"type":"object","properties":{"nCodigo":{"type":"integer","description":"Código do status da oportunidade."},"cDescricao":{"type":"string","description":"Descrição do status da oportunidade."},"cObservacao":{"type":"string","description":"Observação do status da oportunidade."}}},"description":"Lista os cadastros encontrados."}},"title":"ListarStatus (retorno)"},"crm_tarefasresumo_ObterDetalhesTarefa":{"type":"object","title":"ObterDetalhesTarefa","description":"Consulta os detalhes de uma tarefa.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterDetalhesTarefa"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdOportunidade":{"type":"integer","maxLength":15,"description":"Código da oportunidade.\n(Gerado internamente, não é visualizado na tela)"},"nIdTarefa":{"type":"number","maxLength":18,"description":"Código da tarefa.\n(Gerado internamente, não é visualizado na tela)"}},"required":["nIdOportunidade","nIdTarefa"]}}},"example":{"call":"ObterDetalhesTarefa","param":[{"nIdOportunidade":0,"nIdTarefa":0}]}},"crm_tarefasresumo_ObterDetalhesTarefa_retorno":{"type":"object","properties":{"dDataEmail":{"type":"string","description":"Data em que deve ser enviado o e-mail de notificação."},"cHoraEmail":{"type":"string","description":"Hora em que deve ser enviado o e-mail de notificação."},"cEnviadoEmail":{"type":"string","description":"Indica que foi enviado o e-mail de notificação."},"cDescricaoTarefa":{"type":"string","description":"Descrição da tarefa."}},"title":"ObterDetalhesTarefa (retorno)"},"crm_tarefasresumo_ObterListaTarefas":{"type":"object","title":"ObterListaTarefas","description":"Solicitação da listagem de detalhes das tarefas.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterListaTarefas"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"dDia":{"type":"string","maxLength":10,"description":"Data da consulta"},"nPagina":{"type":"integer","maxLength":15,"description":"Número da página."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Número de registros por página."}}}}},"example":{"call":"ObterListaTarefas","param":[{"dDia":"30/09/2026"}]}},"crm_tarefasresumo_ObterListaTarefas_retorno":{"type":"object","properties":{"listaDetalhesTarefas":{"type":"array","items":{"type":"object","properties":{"nIdTarefa":{"type":"decimal","description":"Código da tarefa. (Gerado internamente, não é visualizado na tela)"},"dDataTarefa":{"type":"string","description":"Data da tarefa."},"cHoraTarefa":{"type":"string","description":"Hora da tarefa."},"cEmExecucao":{"type":"string","description":"Indica que a atividade está em execução."},"cRealizada":{"type":"string","description":"Indica que a atividade foi realizada/concluída."},"nIdResponsavel":{"type":"integer","description":"Código do responsável. (Gerado internamente, não é visualizado na tela)"},"cNomeResponsavel":{"type":"string","description":"Nome do responsável."},"nIdNotificacao":{"type":"integer","description":"Código da notificação. (Gerado internamente, não é visualizado na tela)"},"nIdOportunidade":{"type":"integer","description":"Código da oportunidade. (Gerado internamente, não é visualizado na tela)"},"cNomeOportunidade":{"type":"string","description":"Nome da oportunidade."},"cEmailOportunidade":{"type":"string","description":"E-mail da oportunidade."},"nIdContato":{"type":"integer","description":"Código do contato. (Gerado internamente, não é visualizado na tela)"},"cNomeContato":{"type":"string","description":"Nome do contato."},"cCargoContato":{"type":"string","description":"Cargo do contato."},"cEmailContato":{"type":"string","description":"E-mail do contato."},"cTelefoneContato":{"type":"string","description":"Telefone do contato."},"cCelularContato":{"type":"string","description":"Celular do contato."},"nIdAtividade":{"type":"integer","description":"Código da atividade. (Gerado internamente, não é visualizado na tela)"},"cNomeAtividade":{"type":"string","description":"Nome da atividade."},"cImportante":{"type":"string","description":"Indica que é uma atividade importante."},"cUrgente":{"type":"string","description":"Indica que é uma atividade urgente."},"nIdVendedor":{"type":"integer","description":"Código do usuário vendedor. (Gerado internamente, não é visualizado na tela)"},"cNomeVendedor":{"type":"string","description":"Nome do usuário."},"nIdConta":{"type":"integer","description":"Código da conta. (Gerado internamente, não é visualizado na tela)"},"cNomeConta":{"type":"string","description":"Nome da conta."},"nIdSolucao":{"type":"integer","description":"Código da solução"},"cNomeSolucao":{"type":"string","description":"Nome da solução."}}},"description":"Lista de detalhes da tarefa."},"nRegistros":{"type":"integer","description":"Número de registros."},"nPagina":{"type":"integer","description":"Número da página."},"nTotPaginas":{"type":"integer","description":"Número total de páginas."},"nTotRegistros":{"type":"integer","description":"Número total de registros."}},"title":"ObterListaTarefas (retorno)"},"crm_tarefasresumo_ObterResumoTarefas":{"type":"object","title":"ObterResumoTarefas","description":"Resumos das tarefas do CRM.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterResumoTarefas"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"dDataInicio":{"type":"string","maxLength":10,"description":"Data Inicial de Consulta."},"dDataFim":{"type":"string","maxLength":10,"description":"Data final de Consulta."},"cTipoTarefa":{"type":"string","maxLength":1,"description":"Código do tipo da tarefa.\nO valor default desse campo é zero, o que significa que todas as listas serão retornadas.\n\n\nPode ser:\n0 - Todas os resumos\n1 - Apenas Tarefas Futuras\n2 - Apenas Tarefas para Hoje\n3 - Apenas Tarefas em Execução\n4 - Apenas Tarefas Realizadas\n9 - Apenas Tarefas Totalizadas"}}}}},"example":{"call":"ObterResumoTarefas","param":[{"dDataInicio":"30/09/2026","dDataFim":"30/09/2026","cTipoTarefa":""}]}},"crm_tarefasresumo_ObterResumoTarefas_retorno":{"type":"object","properties":{"resumoTarefasTodos":{"type":"object","properties":{"dDia":{"type":"string","description":"Data da consulta"},"nTarefas":{"type":"decimal","description":"Quantidade de tarefas."}}},"resumoTarefasFuturas":{"type":"object","properties":{"dDia":{"type":"string","description":"Data da consulta"},"nTarefas":{"type":"decimal","description":"Quantidade de tarefas."}}},"resumoTarefasHoje":{"type":"object","properties":{"dDia":{"type":"string","description":"Data da consulta"},"nTarefas":{"type":"decimal","description":"Quantidade de tarefas."}}},"resumoTarefasExecucao":{"type":"object","properties":{"dDia":{"type":"string","description":"Data da consulta"},"nTarefas":{"type":"decimal","description":"Quantidade de tarefas."}}},"resumoTarefasRealizadas":{"type":"object","properties":{"dDia":{"type":"string","description":"Data da consulta"},"nTarefas":{"type":"decimal","description":"Quantidade de tarefas."}}}},"title":"ObterResumoTarefas (retorno)"},"crm_tarefas_AlterarTarefa":{"type":"object","title":"AlterarTarefa","description":"Altera uma tarefa.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarTarefa"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodTarefa":{"type":"integer","maxLength":15,"description":"Código da tarefa.\n(Gerado internamente, não é visualizado na tela)"},"nCodOp":{"type":"integer","maxLength":15,"description":"Código da oportunidade.\n(Gerado internamente, não é visualizado na tela)"},"cCodInt":{"type":"string","maxLength":20,"description":"Código de integração da tarefa.\n(Utilizado em títulos criados via API, não é visualizado na tela)"},"nCodUsuario":{"type":"integer","maxLength":15,"description":"Código do usuário vendedor.\n(Gerado internamente, não é visualizado na tela)"},"dData":{"type":"string","maxLength":10,"description":"Data da tarefa."},"cHora":{"type":"string","maxLength":5,"description":"Hora da tarefa."},"nCodNotif":{"type":"integer","maxLength":5,"description":"Código do envio da notificação por e-mail,\nPode ser:\n99999 - Não notificar\n15 - 15 minutos antes\n30 - 30 minutos antes\n60 - 1 hora antes\n120 - 2 horas antes\n180 - 3 horas antes\n1001 - 1 dia antes\n1002 - 2 dias antes\n1003 - 3 dias antes\n2001 - 1 semana antes\n2002 - 2 semanas antes"},"nCodAtividade":{"type":"integer","maxLength":15,"description":"Código da atividade.\nPode ser:\n1 - Ligar\n2 - Reunião\n3 - Tarefa\n4 - E-mail\n5 - Almoço\n6 - Prazo Final\n7 - Nota"},"cDescricao":{"type":"string","description":"Descrição da tarefa."},"cImportante":{"type":"string","maxLength":1,"description":"Indica que é uma atividade importante."},"cUrgente":{"type":"string","maxLength":1,"description":"Indica que é uma atividade urgente."},"cEmExecucao":{"type":"string","maxLength":1,"description":"Indica que a atividade está em execução."},"cRealizada":{"type":"string","maxLength":1,"description":"Indica que a atividade foi realizada/concluída."}},"required":["cDescricao","cHora","dData","nCodNotif","nCodOp","nCodTarefa","nCodUsuario"]}}},"example":{"call":"AlterarTarefa","param":[{"nCodTarefa":0,"nCodOp":0,"cCodInt":"","nCodUsuario":425605408,"dData":"30/09/2026","cHora":"10:15","nCodNotif":99999,"nCodAtividade":1,"cDescricao":"Descricao"}]}},"crm_tarefas_AlterarTarefa_retorno":{"type":"object","properties":{"nCodTarefa":{"type":"integer","description":"Código da tarefa. (Gerado internamente, não é visualizado na tela)"},"nCodOp":{"type":"integer","description":"Código da oportunidade. (Gerado internamente, não é visualizado na tela)"},"cCodInt":{"type":"string","description":"Código de integração da tarefa da oportunidade. (Utilizado em títulos criados via API, não é visualizado na tela)"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDesStatus":{"type":"string","description":"Descrição do Status"}},"title":"AlterarTarefa (retorno)"},"crm_tarefas_CalendarioTarefas":{"type":"object","title":"CalendarioTarefas","description":"Obtém o Calendário de Tarefas no Formato (ICS)","required":["call","param"],"properties":{"call":{"type":"string","enum":["CalendarioTarefas"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"email_vend":{"type":"string"},"calendar_key":{"type":"string"}},"required":["calendar_key","email_vend"]}}},"example":{"call":"CalendarioTarefas","param":[{"email_vend":"omie@omie.com.br","calendar_key":""}]}},"crm_tarefas_CalendarioTarefas_retorno":{"type":"object","properties":{"status":{"type":"string"},"ics":{"type":"string"}},"title":"CalendarioTarefas (retorno)"},"crm_tarefas_ConsultarTarefa":{"type":"object","title":"ConsultarTarefa","description":"Consulta uma tarefa da oportunidade.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarTarefa"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodTarefa":{"type":"integer","maxLength":15,"description":"Código da tarefa.\n(Gerado internamente, não é visualizado na tela)"},"nCodOp":{"type":"integer","maxLength":15,"description":"Código da oportunidade.\n(Gerado internamente, não é visualizado na tela)"},"cCodInt":{"type":"string","maxLength":20,"description":"Código de integração da tarefa da oportunidade.\n(Utilizado em títulos criados via API, não é visualizado na tela)"}},"required":["nCodOp","nCodTarefa"]}}},"example":{"call":"ConsultarTarefa","param":[{"nCodTarefa":0,"nCodOp":0,"cCodInt":""}]}},"crm_tarefas_ConsultarTarefa_retorno":{"type":"object","properties":{"nCodTarefa":{"type":"integer","description":"Código da tarefa (Gerado internamente, não é visualizado na tela)"},"nCodOp":{"type":"integer","description":"Código da oportunidade. (Gerado internamente, não é visualizado na tela)"},"cCodInt":{"type":"string","description":"Código de integração da tarefa. (Utilizado em títulos criados via API, não é visualizado na tela)"},"nCodUsuario":{"type":"integer","description":"Código do usuário vendedor. (Gerado internamente, não é visualizado na tela)"},"dData":{"type":"string","description":"Data da tarefa."},"cHora":{"type":"string","description":"Hora da tarefa."},"nCodNotif":{"type":"integer","description":"Código do envio da notificação por e-mail, Pode ser: 99999 - Não notificar 15 - 15 minutos antes 30 - 30 minutos antes 60 - 1 hora antes 120 - 2 horas antes 180 - 3 horas antes 1001 - 1 dia antes 1002 - 2 dias antes 1003 - 3 dias antes 2001 - 1 semana antes 2002 - 2 semanas antes"},"nCodAtividade":{"type":"integer","description":"Código da atividade. Pode ser: 1 - Ligar 2 - Reunião 3 - Tarefa 4 - E-mail 5 - Almoço 6 - Prazo Final 7 - Nota"},"cDescricao":{"type":"string","description":"Descrição da tarefa."},"cImportante":{"type":"string","description":"Indica que é uma atividade importante."},"cUrgente":{"type":"string","description":"Indica que é uma atividade urgente."},"cEmExecucao":{"type":"string","description":"Indica que a atividade está em execução."},"cRealizada":{"type":"string","description":"Indica que a atividade foi realizada/concluída."},"nIncluidoPor":{"type":"integer","description":"Código do usuário que incluiu a tarefa."}},"title":"ConsultarTarefa (retorno)"},"crm_tarefas_ExcluirTarefa":{"type":"object","title":"ExcluirTarefa","description":"Exclui um tarefa.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirTarefa"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodTarefa":{"type":"integer","maxLength":15,"description":"Código da tarefa.\n(Gerado internamente, não é visualizado na tela)"},"nCodOp":{"type":"integer","maxLength":15,"description":"Código da oportunidade.\n(Gerado internamente, não é visualizado na tela)"},"cCodInt":{"type":"string","maxLength":20,"description":"Código de integração da tarefa da oportunidade.\n(Utilizado em títulos criados via API, não é visualizado na tela)"}},"required":["nCodOp","nCodTarefa"]}}},"example":{"call":"ExcluirTarefa","param":[{"nCodTarefa":0,"nCodOp":0,"cCodInt":""}]}},"crm_tarefas_ExcluirTarefa_retorno":{"type":"object","properties":{"nCodTarefa":{"type":"integer","description":"Código da tarefa. (Gerado internamente, não é visualizado na tela)"},"nCodOp":{"type":"integer","description":"Código da oportunidade. (Gerado internamente, não é visualizado na tela)"},"cCodInt":{"type":"string","description":"Código de integração da tarefa da oportunidade. (Utilizado em títulos criados via API, não é visualizado na tela)"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDesStatus":{"type":"string","description":"Descrição do Status"}},"title":"ExcluirTarefa (retorno)"},"crm_tarefas_IncluirTarefa":{"type":"object","title":"IncluirTarefa","description":"Inclui uma tarefa na oportunidade.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirTarefa"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodOp":{"type":"integer","maxLength":15,"description":"Código da oportunidade.\n(Gerado internamente, não é visualizado na tela)"},"cCodInt":{"type":"string","maxLength":20,"description":"Código de integração da tarefa.\n(Utilizado em títulos criados via API, não é visualizado na tela)"},"nCodUsuario":{"type":"integer","maxLength":15,"description":"Código do usuário vendedor.\n(Gerado internamente, não é visualizado na tela)"},"dData":{"type":"string","maxLength":10,"description":"Data da tarefa."},"cHora":{"type":"string","maxLength":5,"description":"Hora da tarefa."},"nCodNotif":{"type":"integer","maxLength":5,"description":"Código do envio da notificação por e-mail,\nPode ser:\n99999 - Não notificar\n15 - 15 minutos antes\n30 - 30 minutos antes\n60 - 1 hora antes\n120 - 2 horas antes\n180 - 3 horas antes\n1001 - 1 dia antes\n1002 - 2 dias antes\n1003 - 3 dias antes\n2001 - 1 semana antes\n2002 - 2 semanas antes"},"nCodAtividade":{"type":"integer","maxLength":15,"description":"Código da atividade.\nPode ser:\n1 - Ligar\n2 - Reunião\n3 - Tarefa\n4 - E-mail\n5 - Almoço\n6 - Prazo Final\n7 - Nota"},"cDescricao":{"type":"string","description":"Descrição da tarefa."},"cImportante":{"type":"string","maxLength":1,"description":"Indica que é uma atividade importante."},"cUrgente":{"type":"string","maxLength":1,"description":"Indica que é uma atividade urgente."},"cEmExecucao":{"type":"string","maxLength":1,"description":"Indica que a atividade está em execução."},"cRealizada":{"type":"string","maxLength":1,"description":"Indica que a atividade foi realizada/concluída."}},"required":["cCodInt","cDescricao","cHora","dData","nCodNotif","nCodOp","nCodUsuario"]}}},"example":{"call":"IncluirTarefa","param":[{"nCodOp":0,"cCodInt":"","nCodUsuario":425605408,"dData":"30/09/2026","cHora":"10:15","nCodNotif":99999,"nCodAtividade":1,"cDescricao":"Descricao"}]}},"crm_tarefas_IncluirTarefa_retorno":{"type":"object","properties":{"nCodTarefa":{"type":"integer","description":"Código da tarefa. (Gerado internamente, não é visualizado na tela)"},"nCodOp":{"type":"integer","description":"Código da oportunidade. (Gerado internamente, não é visualizado na tela)"},"cCodInt":{"type":"string","description":"Código de integração da tarefa da oportunidade. (Utilizado em títulos criados via API, não é visualizado na tela)"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDesStatus":{"type":"string","description":"Descrição do Status"}},"title":"IncluirTarefa (retorno)"},"crm_tarefas_ListarEmailsTarefas":{"type":"object","title":"ListarEmailsTarefas","description":"Lista os  emails tarefas.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarEmailsTarefas"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"apenas_importado_api":{"type":"string","maxLength":1,"description":"Exibir apenas os registros gerados pela API"},"ordenar_por":{"type":"string","maxLength":100,"description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."},"nCodOp":{"type":"integer","maxLength":15,"description":"Código da oportunidade.\n(Gerado internamente, não é visualizado na tela)"},"email_vendedor":{"type":"string","description":"E-Mail do Vendedor"},"codigo_vendedor":{"type":"integer","maxLength":15,"description":"Código do Vendedor."},"data_inicial":{"type":"string","maxLength":10,"description":"Data inicial da tarefa."},"data_final":{"type":"string","maxLength":10,"description":"Data final da tarefa."},"hora_inicial":{"type":"string","maxLength":8,"description":"Hora inicial da tarefa."},"hora_final":{"type":"string","maxLength":8,"description":"Hora final da tarefa."},"exibir_detalhes":{"type":"string","maxLength":1,"description":"Exibe os detalhes da tarefa."},"cImportante":{"type":"string","maxLength":1,"description":"Indica que é uma atividade importante."},"cUrgente":{"type":"string","maxLength":1,"description":"Indica que é uma atividade urgente."},"cTarefasUsuario":{"type":"string","maxLength":1,"description":"Retornar apenas tarefas atribuidas ao vendedor (S/N)."}}}}},"example":{"call":"ListarEmailsTarefas","param":[{"pagina":1,"registros_por_pagina":20}]}},"crm_tarefas_ListarEmailsTarefas_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada"},"total_de_paginas":{"type":"integer","description":"Número total de páginas"},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"total de registros encontrados"},"cadastrosEmail":{"type":"array","items":{"type":"object","properties":{"nCodOp":{"type":"integer","description":"Código da oportunidade. (Gerado internamente, não é visualizado na tela)"},"nIdEmail":{"type":"string","description":"ID do E-mail."},"dData":{"type":"string","description":"Data da tarefa."},"cHora":{"type":"string","description":"Hora da tarefa."},"cDescricao":{"type":"string","description":"Descrição da tarefa."},"cImportante":{"type":"string","description":"Indica que é uma atividade importante."},"cUrgente":{"type":"string","description":"Indica que é uma atividade urgente."},"cEmailDe":{"type":"string","description":"Email enviado de."},"cEmailPara":{"type":"string","description":"Email enviado para."},"cEmailCopia":{"type":"string","description":"Enviar cópia para."},"cEmailCopiaOculta":{"type":"string","description":"Enviar cópia oculta para."},"cEmailDados":{"type":"string","description":"Conteúdo do e-mail."},"cEmailOportunidade":{"type":"string","description":"E-mail da Oportunidade."},"nQtdeAnexos":{"type":"integer","description":"Quantidade de anexos."},"detalhesOportunidade":{"type":"object","properties":{"cDesOportunidade":{"type":"string","description":"Descrição da Oportunidade."},"nCodUsuario":{"type":"integer","description":"Código do usuário vendedor. (Gerado internamente, não é visualizado na tela)"},"cNomUsuario":{"type":"string","description":"Nome do usuário."},"cEmailUsuario":{"type":"string","description":"E-Mail do usuário."},"cDesConta":{"type":"string","description":"Descrição da Conta"},"cDDD1Conta":{"type":"string","description":"DDD do Telefone principal."},"cTelefone1Conta":{"type":"string","description":"Telefone Principal."},"cDDD2Conta":{"type":"string","description":"DDD do Celular."},"cTelefone2Conta":{"type":"string","description":"Telefone secundário."},"cEnderecoConta":{"type":"string","description":"Endereço."},"cComplementoConta":{"type":"string","description":"Complemento do endereço."},"cCEPConta":{"type":"string","description":"CEP."},"cBairroConta":{"type":"string","description":"Bairro."},"cCidadeConta":{"type":"string","description":"Cidade."},"cEstadoConta":{"type":"string","description":"Estado."},"cNomeContato":{"type":"string","description":"Nome do Contato."}},"description":"Detalhes da Oportunidade."}}},"description":"Lista os cadastros de emails encontrados."}},"title":"ListarEmailsTarefas (retorno)"},"crm_tarefas_ListarTarefas":{"type":"object","title":"ListarTarefas","description":"Tarefas da oportunidade.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarTarefas"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"apenas_importado_api":{"type":"string","maxLength":1,"description":"Exibir apenas os registros gerados pela API"},"ordenar_por":{"type":"string","maxLength":100,"description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."},"nCodOp":{"type":"integer","maxLength":15,"description":"Código da oportunidade.\n(Gerado internamente, não é visualizado na tela)"},"email_vendedor":{"type":"string","description":"E-Mail do Vendedor"},"codigo_vendedor":{"type":"integer","maxLength":15,"description":"Código do Vendedor."},"data_inicial":{"type":"string","maxLength":10,"description":"Data inicial da tarefa."},"data_final":{"type":"string","maxLength":10,"description":"Data final da tarefa."},"hora_inicial":{"type":"string","maxLength":8,"description":"Hora inicial da tarefa."},"hora_final":{"type":"string","maxLength":8,"description":"Hora final da tarefa."},"exibir_detalhes":{"type":"string","maxLength":1,"description":"Exibe os detalhes da tarefa."},"cImportante":{"type":"string","maxLength":1,"description":"Indica que é uma atividade importante."},"cUrgente":{"type":"string","maxLength":1,"description":"Indica que é uma atividade urgente."},"cEmExecucao":{"type":"string","maxLength":1,"description":"Indica que a atividade está em execução."},"cRealizada":{"type":"string","maxLength":1,"description":"Indica que a atividade foi realizada/concluída."},"cTarefasUsuario":{"type":"string","maxLength":1,"description":"Retornar apenas tarefas atribuidas ao vendedor (S/N)."}}}}},"example":{"call":"ListarTarefas","param":[{"pagina":1,"registros_por_pagina":20}]}},"crm_tarefas_ListarTarefas_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada"},"total_de_paginas":{"type":"integer","description":"Número total de páginas"},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"total de registros encontrados"},"cadastros":{"type":"array","items":{"type":"object","properties":{"nCodTarefa":{"type":"integer","description":"Código da tarefa. (Gerado internamente, não é visualizado na tela)"},"nCodOp":{"type":"integer","description":"Código da oportunidade. (Gerado internamente, não é visualizado na tela)"},"cCodInt":{"type":"string","description":"Código de integração da tarefa. (Utilizado em títulos criados via API, não é visualizado na tela)"},"nCodUsuario":{"type":"integer","description":"Código do usuário vendedor. (Gerado internamente, não é visualizado na tela)"},"dData":{"type":"string","description":"Data da tarefa."},"cHora":{"type":"string","description":"Hora da tarefa."},"nCodNotif":{"type":"integer","description":"Código do envio da notificação por e-mail, Pode ser: 99999 - Não notificar 15 - 15 minutos antes 30 - 30 minutos antes 60 - 1 hora antes 120 - 2 horas antes 180 - 3 horas antes 1001 - 1 dia antes 1002 - 2 dias antes 1003 - 3 dias antes 2001 - 1 semana antes 2002 - 2 semanas antes"},"nCodAtividade":{"type":"integer","description":"Código da atividade. Pode ser: 1 - Ligar 2 - Reunião 3 - Tarefa 4 - E-mail 5 - Almoço 6 - Prazo Final 7 - Nota"},"cDescricao":{"type":"string","description":"Descrição da tarefa."},"nIncluidoPor":{"type":"integer","description":"Código do usuário que incluiu a tarefa."},"cImportante":{"type":"string","description":"Indica que é uma atividade importante."},"cUrgente":{"type":"string","description":"Indica que é uma atividade urgente."},"cEmExecucao":{"type":"string","description":"Indica que a atividade está em execução."},"cRealizada":{"type":"string","description":"Indica que a atividade foi realizada/concluída."},"detalhesOportunidade":{"type":"object","properties":{"cDesOportunidade":{"type":"string","description":"Descrição da Oportunidade."},"nCodUsuario":{"type":"integer","description":"Código do usuário vendedor. (Gerado internamente, não é visualizado na tela)"},"cNomUsuario":{"type":"string","description":"Nome do usuário."},"cEmailUsuario":{"type":"string","description":"E-Mail do usuário."},"cDesConta":{"type":"string","description":"Descrição da Conta"},"cDDD1Conta":{"type":"string","description":"DDD do Telefone principal."},"cTelefone1Conta":{"type":"string","description":"Telefone Principal."},"cDDD2Conta":{"type":"string","description":"DDD do Celular."},"cTelefone2Conta":{"type":"string","description":"Telefone secundário."},"cEnderecoConta":{"type":"string","description":"Endereço."},"cComplementoConta":{"type":"string","description":"Complemento do endereço."},"cCEPConta":{"type":"string","description":"CEP."},"cBairroConta":{"type":"string","description":"Bairro."},"cCidadeConta":{"type":"string","description":"Cidade."},"cEstadoConta":{"type":"string","description":"Estado."},"cNomeContato":{"type":"string","description":"Nome do Contato."}},"description":"Detalhes da Oportunidade."}}},"description":"Lista os cadastros encontrados."}},"title":"ListarTarefas (retorno)"},"crm_tarefas_UpsertTarefa":{"type":"object","title":"UpsertTarefa","description":"Inclusão / alteração de uma tarefa.","required":["call","param"],"properties":{"call":{"type":"string","enum":["UpsertTarefa"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodTarefa":{"type":"integer","maxLength":15,"description":"Código da tarefa.\n(Gerado internamente, não é visualizado na tela)"},"nCodOp":{"type":"integer","maxLength":15,"description":"Código da oportunidade.\n(Gerado internamente, não é visualizado na tela)"},"cCodInt":{"type":"string","maxLength":20,"description":"Código de integração da tarefa.\n(Utilizado em títulos criados via API, não é visualizado na tela)"},"nCodUsuario":{"type":"integer","maxLength":15,"description":"Código do usuário vendedor.\n(Gerado internamente, não é visualizado na tela)"},"dData":{"type":"string","maxLength":10,"description":"Data da tarefa."},"cHora":{"type":"string","maxLength":5,"description":"Hora da tarefa."},"nCodNotif":{"type":"integer","maxLength":5,"description":"Código do envio da notificação por e-mail,\nPode ser:\n99999 - Não notificar\n15 - 15 minutos antes\n30 - 30 minutos antes\n60 - 1 hora antes\n120 - 2 horas antes\n180 - 3 horas antes\n1001 - 1 dia antes\n1002 - 2 dias antes\n1003 - 3 dias antes\n2001 - 1 semana antes\n2002 - 2 semanas antes"},"nCodAtividade":{"type":"integer","maxLength":15,"description":"Código da atividade.\nPode ser:\n1 - Ligar\n2 - Reunião\n3 - Tarefa\n4 - E-mail\n5 - Almoço\n6 - Prazo Final\n7 - Nota"},"cDescricao":{"type":"string","description":"Descrição da tarefa."},"cImportante":{"type":"string","maxLength":1,"description":"Indica que é uma atividade importante."},"cUrgente":{"type":"string","maxLength":1,"description":"Indica que é uma atividade urgente."},"cEmExecucao":{"type":"string","maxLength":1,"description":"Indica que a atividade está em execução."},"cRealizada":{"type":"string","maxLength":1,"description":"Indica que a atividade foi realizada/concluída."}},"required":["cCodInt","cDescricao","cHora","dData","nCodNotif","nCodOp","nCodUsuario"]}}},"example":{"call":"UpsertTarefa","param":[{"nCodTarefa":0,"nCodOp":0,"cCodInt":"","nCodUsuario":425605408,"dData":"30/09/2026","cHora":"10:15","nCodNotif":99999,"nCodAtividade":1,"cDescricao":"Descricao"}]}},"crm_tarefas_UpsertTarefa_retorno":{"type":"object","properties":{"nCodTarefa":{"type":"integer","description":"Código da tarefa. (Gerado internamente, não é visualizado na tela)"},"nCodOp":{"type":"integer","description":"Código da Oportunidade."},"cCodInt":{"type":"string","description":"Código de integração da tarefa da oportunidade. (Utilizado em títulos criados via API, não é visualizado na tela)"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDesStatus":{"type":"string","description":"Descrição do Status"}},"title":"UpsertTarefa (retorno)"},"crm_tipos_ListarTipos":{"type":"object","title":"ListarTipos","description":"Tipos de oportunidades.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarTipos"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"apenas_importado_api":{"type":"string","maxLength":1,"description":"Exibir apenas os registros gerados pela API."},"ordenar_por":{"type":"string","maxLength":100,"description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."}}}}},"example":{"call":"ListarTipos","param":[{"pagina":1,"registros_por_pagina":20}]}},"crm_tipos_ListarTipos_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada."},"total_de_paginas":{"type":"integer","description":"Número total de páginas."},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"Total de registros encontrados."},"cadastros":{"type":"array","items":{"type":"object","properties":{"nCodigo":{"type":"integer","description":"Código do tipo de oportunidade."},"cDescricao":{"type":"string","description":"Descrição do tipo de oportunidade."},"cObservacao":{"type":"string","description":"Observação do tipo de oportunidade."}}},"description":"Lista os cadastros encontrados."}},"title":"ListarTipos (retorno)"},"crm_tipostarefa_AlterarTipoTarefa":{"type":"object","title":"AlterarTipoTarefa","description":"Alterar tipo de tarefa.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarTipoTarefa"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdTipoTarefa":{"type":"integer","maxLength":15,"description":"Id do Tipo de Tarefa."},"cDescricao":{"type":"string","maxLength":40,"description":"Descrição para o tipo de tarefa."},"nMinutos":{"type":"integer","maxLength":3,"description":"Duração padrão (em minutos) da tarefa."},"cSyncCalend":{"type":"string","maxLength":1,"description":"Indica se deve sincronizar com o calendário.\n\nValores possíveis:\n\nS - Sim\nN - Não."}},"required":["nIdTipoTarefa"]}}},"example":{"call":"AlterarTipoTarefa","param":[{"nIdTipoTarefa":0,"cDescricao":"","nMinutos":50,"cSyncCalend":"S"}]}},"crm_tipostarefa_AlterarTipoTarefa_retorno":{"type":"object","properties":{"nIdTipoTarefa":{"type":"integer","description":"Id do Tipo de Tarefa."},"cCodStatus":{"type":"string","description":"Código do status."},"cDescStatus":{"type":"string","description":"Descrição do status."}},"title":"AlterarTipoTarefa (retorno)"},"crm_tipostarefa_ConsultarTipoTarefa":{"type":"object","title":"ConsultarTipoTarefa","description":"Consulta tipo de tarefa.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarTipoTarefa"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdTipoTarefa":{"type":"integer","maxLength":15,"description":"Identificador do tipo da tarefa."}},"required":["nIdTipoTarefa"]}}},"example":{"call":"ConsultarTipoTarefa","param":[{"nIdTipoTarefa":0}]}},"crm_tipostarefa_ConsultarTipoTarefa_retorno":{"type":"object","properties":{"nIdTipoTarefa":{"type":"integer","description":"Id do Tipo de Tarefa."},"cDescricao":{"type":"string","description":"Descrição para o tipo de tarefa."},"nMinutos":{"type":"integer","description":"Duração padrão (em minutos) da tarefa."},"cSyncCalend":{"type":"string","description":"Indica se deve sincronizar com o calendário. Valores possíveis: S - Sim N - Não."}},"title":"ConsultarTipoTarefa (retorno)"},"crm_tipostarefa_ExcluirTipoTarefa":{"type":"object","title":"ExcluirTipoTarefa","description":"Excluir tipo de tarefa.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirTipoTarefa"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdTipoTarefa":{"type":"integer","maxLength":15,"description":"Identificador do tipo da tarefa."}},"required":["nIdTipoTarefa"]}}},"example":{"call":"ExcluirTipoTarefa","param":[{"nIdTipoTarefa":0}]}},"crm_tipostarefa_ExcluirTipoTarefa_retorno":{"type":"object","properties":{"nIdTipoTarefa":{"type":"integer","description":"Id do Tipo de Tarefa."},"cCodStatus":{"type":"string","description":"Código do status."},"cDescStatus":{"type":"string","description":"Descrição do status."}},"title":"ExcluirTipoTarefa (retorno)"},"crm_tipostarefa_IncluirTipoTarefa":{"type":"object","title":"IncluirTipoTarefa","description":"Incluir tipo de tarefa.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirTipoTarefa"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cDescricao":{"type":"string","maxLength":40,"description":"Descrição para o tipo de tarefa."},"nMinutos":{"type":"integer","maxLength":3,"description":"Duração padrão (em minutos) da tarefa."},"cSyncCalend":{"type":"string","maxLength":1,"description":"Indica se deve sincronizar com o calendário.\n\nValores possíveis:\n\nS - Sim\nN - Não."}},"required":["cDescricao"]}}},"example":{"call":"IncluirTipoTarefa","param":[{"cDescricao":"","nMinutos":50,"cSyncCalend":"S"}]}},"crm_tipostarefa_IncluirTipoTarefa_retorno":{"type":"object","properties":{"nIdTipoTarefa":{"type":"integer","description":"Id do Tipo de Tarefa."},"cCodStatus":{"type":"string","description":"Código do status."},"cDescStatus":{"type":"string","description":"Descrição do status."}},"title":"IncluirTipoTarefa (retorno)"},"crm_tipostarefa_ListarTiposTarefa":{"type":"object","title":"ListarTiposTarefa","description":"Lista tipos de tarefa.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarTiposTarefa"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"ordenar_por":{"type":"string","maxLength":100,"description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."}}}}},"example":{"call":"ListarTiposTarefa","param":[{"pagina":1,"registros_por_pagina":50}]}},"crm_tipostarefa_ListarTiposTarefa_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada."},"total_de_paginas":{"type":"integer","description":"Número total de páginas."},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"Total de registros encontrados."},"cadastros":{"type":"array","items":{"type":"object","properties":{"nIdTipoTarefa":{"type":"integer","description":"Id do Tipo de Tarefa."},"cDescricao":{"type":"string","description":"Descrição para o tipo de tarefa."},"nMinutos":{"type":"integer","description":"Duração padrão (em minutos) da tarefa."},"cSyncCalend":{"type":"string","description":"Indica se deve sincronizar com o calendário. Valores possíveis: S - Sim N - Não."}}},"description":"Lista os tipos de tarefa."}},"title":"ListarTiposTarefa (retorno)"},"crm_usuarios_ListarUsuarios":{"type":"object","title":"ListarUsuarios","description":"Usuários da oportunidade.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarUsuarios"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"apenas_importado_api":{"type":"string","maxLength":1,"description":"Exibir apenas os registros gerados pela API"},"ordenar_por":{"type":"string","maxLength":100,"example":"CODIGO","description":"Ordem de exibição dos dados. Padrão: CODIGO."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."},"email_usuario":{"type":"string","description":"E-Mail do usuário."},"codigo_usuario":{"type":"integer","maxLength":15,"description":"Código do usuário."},"apenas_ativos":{"type":"string","maxLength":1,"example":"S","description":"Retornar apenas usuários ativos (S/N)."}}}}},"example":{"call":"ListarUsuarios","param":[{"pagina":1,"registros_por_pagina":20}]}},"crm_usuarios_ListarUsuarios_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada"},"total_de_paginas":{"type":"integer","description":"Número total de páginas"},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"total de registros encontrados"},"cadastros":{"type":"array","items":{"type":"object","properties":{"nCodigo":{"type":"integer","description":"Código do usuário / vendedor / prevenda."},"cNome":{"type":"string","description":"Nome do usuário."},"cEmail":{"type":"string","description":"Email do usuário."},"cTelefone":{"type":"string","description":"Telefone do usuário."},"cCelular":{"type":"string","description":"Celular do usuário."},"nMetaAnual":{"type":"decimal","description":"Meta anual individual do usuário."}}},"description":"Lista os cadastros encontrados."}},"title":"ListarUsuarios (retorno)"},"crm_usuarios_ObterUsuarios":{"type":"object","title":"ObterUsuarios","description":"Usuário da oportunidade.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterUsuarios"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cExibirTodos":{"type":"string","maxLength":1,"example":"S","description":"Exibe todos os usuários. (S/N).\n\n\nO padrão é \"N\""}}}}},"example":{"call":"ObterUsuarios","param":[{"cExibirTodos":"N"}]}},"crm_usuarios_ObterUsuarios_retorno":{"type":"object","properties":{"listaUsuarios":{"type":"array","items":{"type":"object","properties":{"nCodigo":{"type":"integer","description":"Código do usuário / vendedor / prevenda."},"cNome":{"type":"string","description":"Nome do usuário."},"cEmail":{"type":"string","description":"Email do usuário."},"nMeta":{"type":"decimal","description":"Meta anual individual do usuário."},"cTelefone":{"type":"string","description":"Telefone do usuário."},"cCelular":{"type":"string","description":"Celular do usuário."}}},"description":"cadastro de usuário."}},"title":"ObterUsuarios (retorno)"},"crm_verticais_ListarVerticais":{"type":"object","title":"ListarVerticais","description":"Lista as verticais cadastradas.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarVerticais"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"apenas_importado_api":{"type":"string","maxLength":1,"description":"Exibir apenas os registros gerados pela API."},"ordenar_por":{"type":"string","maxLength":100,"example":"CODIGO","description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."}}}}},"example":{"call":"ListarVerticais","param":[{"pagina":1,"registros_por_pagina":20}]}},"crm_verticais_ListarVerticais_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada."},"total_de_paginas":{"type":"integer","description":"Número total de páginas."},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"Total de registros encontrados."},"cadastros":{"type":"array","items":{"type":"object","properties":{"nCodigo":{"type":"integer","description":"Código da solução."},"cDescricao":{"type":"string","description":"Descrição da solução."},"cObservacao":{"type":"string","description":"Observações."}}},"description":"Lista os cadastros encontrados."}},"title":"ListarVerticais (retorno)"},"estoque_ajuste_AlterarEstoqueMinimo":{"type":"object","title":"AlterarEstoqueMinimo","description":"Alterar quantidade mínima em um local de estoque.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarEstoqueMinimo"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do local do estoque.\n\n\nSe não for preenchido assumirá o local do estoque padrão."},"cod_int":{"type":"string","maxLength":20,"description":"Código de Integração do Produto.\n\n\nPreencha esse campo apenas se não tiver preenchido o campo \"id_prod\"."},"id_prod":{"type":"integer","maxLength":15,"description":"Código do produto."},"quan_min":{"type":"number","maxLength":18,"description":"Novo valor para quantidade mínima no estoque."}}}}},"example":{"call":"AlterarEstoqueMinimo","param":[{"codigo_local_estoque":0,"id_prod":16487740,"cod_int":"","quan_min":"15"}]}},"estoque_ajuste_AlterarEstoqueMinimo_retorno":{"type":"object","properties":{"codigo_status":{"type":"string","description":"Código do status de resposta do ajuste de estoque mínimo."},"descricao_status":{"type":"string","description":"Descrição do status de resposta do ajuste de estoque mínimo."}},"title":"AlterarEstoqueMinimo (retorno)"},"estoque_ajuste_ExcluirAjusteEstoque":{"type":"object","title":"ExcluirAjusteEstoque","description":"Excluir um Movimento de Ajuste de Estoque.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirAjusteEstoque"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"id_ajuste":{"type":"integer","maxLength":15,"description":"ID do Movimento de Ajuste de Estoque."}},"required":["id_ajuste"]}}},"example":{"call":"ExcluirAjusteEstoque","param":[{"id_ajuste":0}]}},"estoque_ajuste_ExcluirAjusteEstoque_retorno":{"type":"object","properties":{"codigo_status":{"type":"string","description":"Código do Status de Resposta do Movimento de Estoque."},"descricao_status":{"type":"string","description":"Descrição do Status de Resposta do Movimento de Ajuste de Estoque."},"id_movest":{"type":"integer","description":"ID do Movimento de Ajuste de Estoque (Original)."},"id_ajuste":{"type":"integer","description":"ID do Movimento de Ajuste de Estoque."}},"title":"ExcluirAjusteEstoque (retorno)"},"estoque_ajuste_IncluirAjusteEstoque":{"type":"object","title":"IncluirAjusteEstoque","description":"Incluir um Ajuste de Estoque.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirAjusteEstoque"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do local do estoque.\n\n\nSe não for preenchido assumirá o local do estoque padrão."},"id_prod":{"type":"integer","maxLength":15,"description":"Código do Produto."},"cod_int":{"type":"string","maxLength":20,"description":"Código de Integração do Produto.\n\n\nPreencha esse campo apenas se não tiver preenchido o campo \"id_prod\"."},"cod_int_ajuste":{"type":"string","maxLength":60},"data":{"type":"string","maxLength":10,"description":"Data do Movimento."},"tipo":{"type":"string","maxLength":3,"description":"Tipo do Ajuste de Estoque.\n\n\nPode ser:\nENT - Efetua uma entrada no estoque.\nSAI - Efetua uma saída no estoque.\nSLD - Efetua um ajuste do estoque.\nTRF - Efetua uma transferência entre locais de estoque."},"quan":{"type":"number","maxLength":18,"description":"Quantidade do Movimento."},"valor":{"type":"number","maxLength":18,"description":"Valor do Movimento."},"obs":{"type":"string","description":"Observação do Movimento de Estoque."},"origem":{"type":"string","maxLength":3,"description":"Origem do Movimento de Estoque.\n\n\nPode ser:\n\nAJU - Ajuste manual de estoque.\nPDV - Ajuste realizado pelo PDV."},"motivo":{"type":"string","maxLength":3,"description":"Motivo do ajuste.\n\n\nPode ser:\n\nEntrada:\nINV - Ajuste por Inventário.\nOPE - Integração com Ordem de Produção - Entrada.\nPDV - Integração com PDV.\n\nSaída:\nINV - Ajuste por Inventário.\nPER - Baixa por Perda ou Quebra.\nOPS - Integração com Ordem de Produção - Saída.\nPDV - Integração com PDV.\n\nAjuste saldo estoque:\nINV - Ajuste por Inventário.\nPDV - Integração com PDV.\n\nTransferência entre locais:\nTPQ - Transferência por Perda ou Quebra.\nTRF - Transferência entre Locais de Estoque."},"codigo_local_estoque_destino":{"type":"integer","maxLength":15,"description":"Obrigatório quando utilizar Tipo = \"TRF\"\n\nCódigo do local de estoque destino para a transferência."},"lote_validade":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","maxLength":15,"description":"Id do lote do produto.\n\nObrigatório quando o produto possui controle de lote e a tag [tipo] for diferente de 'ENT' (entrada)."},"nQtdLote":{"type":"number","maxLength":18,"description":"Informe aqui a quantidade do lote para o produto."},"cNumLote":{"type":"string","maxLength":60,"description":"Número do lote do produto.\n\nDeve ser informado apenas quando a tag [tipo] for 'ENT' (entrada) e a tag [nIdLote] não for informada, com isso, será criado um novo lote a partir do número informado."},"cCodAgreg":{"type":"string","maxLength":20,"description":"Código de agregação do lote do produto.\n\nDeve ser informado apenas quando a tag [tipo] for 'ENT' (entrada) e a tag [nIdLote] não for informada."},"dDataFab":{"type":"string","description":"Data de fabricação do lote.\n\nDeve ser informado apenas quando a tag [tipo] for 'ENT' (entrada) e a tag [nIdLote] não for informada.\n\nComo default é utilizado a data atual."},"dDataVal":{"type":"string","description":"Data de validade do lote.\n\nDeve ser informado apenas quando a tag [tipo] for 'ENT' (entrada) e a tag [nIdLote] não for informada, situação em que o preenchimento é obrigatório."}},"required":["dDataVal"]},"description":"Informações referente ao lote e validade do produto.\n\nObrigatório preenchimento para produtos que possuem controle de lote quando a tag [tipo] for 'ENT' (entrada) ou 'TRF' (transferência).\n\nNa saída (tipo = 'SAI'), o preenchimento é opcional quando o método de consumo do lote está configurado como FEFO, FIFO ou LIFO: nesse caso os lotes são consumidos automaticamente conforme o método. Continua obrigatório quando o método de consumo é Manual ou não está configurado."},"empresa":{"type":"integer","maxLength":15,"description":"Código da empresa.\n\nDEPRECATED.\n\nNão é necessário informar esse campo."}},"required":["data","tipo"]}}},"example":{"call":"IncluirAjusteEstoque","param":[{"codigo_local_estoque":0,"id_prod":16487740,"data":"30/09/2026","quan":"15","obs":"Ajuste feito pela ferramenta de Teste de API (30082)","origem":"AJU","tipo":"SLD","motivo":"INV","valor":10}]}},"estoque_ajuste_IncluirAjusteEstoque_retorno":{"type":"object","properties":{"codigo_status":{"type":"string","description":"Código do Status de Resposta do Movimento de Estoque."},"descricao_status":{"type":"string","description":"Descrição do Status de Resposta do Movimento de Ajuste de Estoque."},"id_movest":{"type":"integer","description":"ID do Movimento de Ajuste de Estoque (Original)."},"id_ajuste":{"type":"integer","description":"ID do Movimento de Ajuste de Estoque."}},"title":"IncluirAjusteEstoque (retorno)"},"estoque_ajuste_ListarAjusteEstoque":{"type":"object","title":"ListarAjusteEstoque","description":"Listar os ajuste de estoque.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarAjusteEstoque"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15},"registros_por_pagina":{"type":"integer","maxLength":15},"ordenar_por":{"type":"string","maxLength":100,"description":"Ordenar o resultado da página por:\n\nDATA_MOVIMENTO\nLOCAL_ESTOQUE\nPRODUTO."},"cod_int_ajuste":{"type":"string","maxLength":60},"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do local do estoque."},"id_prod":{"type":"integer","maxLength":15,"description":"Código do Produto."},"tipo":{"type":"string","maxLength":3,"description":"Tipo do Ajuste de Estoque.\n\n\nPode ser:\n\nENT - Efetua uma entrada no estoque.\nSAI - Efetua uma saída no estoque.\nSLD - Efetua um ajuste do estoque."},"origem":{"type":"string","maxLength":3,"description":"Origem do Movimento de Estoque.\n\n\nPode ser:\n\nAJU - Ajuste manual de estoque.\nPDV - Ajuste realizado pelo PDV."},"motivo":{"type":"string","maxLength":3,"description":"Motivo do ajuste.\n\n\nPode ser:\n\nEntrada:\nINV - Ajuste por Inventário.\nOPE - Integração com Ordem de Produção - Entrada.\nPDV - Integração com PDV.\nINI - Ajuste por Inventário (Estoque Inicial).\n\nSaída:\nINV - Ajuste por Inventário.\nPER - Baixa por Perda ou Quebra.\nOPS - Integração com Ordem de Produção - Saída.\nPDV - Integração com PDV.\n\nAjuste saldo estoque:\nINV - Ajuste por Inventário.\nINI - Ajuste por Inventário (Estoque Inicial).\nCMC - Ajuste do Valor do CMC.\nPDV - Integração com PDV.\n\nTransferência entre locais:\nTPQ - Transferência por Perda ou Quebra.\nTRF - Transferência entre Locais de Estoque."},"data_movimento_de":{"type":"string","maxLength":10,"description":"Data do Movimento inicio."},"data_movimento_ate":{"type":"string","maxLength":10,"description":"Data movimento final."},"apenas_importado_api":{"type":"string","maxLength":1,"description":"Preencher com \"S\" ou \"N\"."}}}}},"example":{"call":"ListarAjusteEstoque","param":[{"pagina":1,"registros_por_pagina":100,"apenas_importado_api":"N"}]}},"estoque_ajuste_ListarAjusteEstoque_retorno":{"type":"object","properties":{"pagina":{"type":"integer"},"total_de_paginas":{"type":"integer"},"registros":{"type":"integer"},"total_de_registros":{"type":"integer"},"ajuste_estoque_lista":{"type":"array","items":{"type":"object","properties":{"id_ajuste":{"type":"integer"},"cod_int_ajuste":{"type":"string"},"codigo_local_estoque":{"type":"integer","description":"Código do local do estoque."},"id_prod":{"type":"integer","description":"Código do produto."},"data":{"type":"string","description":"Data do ajuste."},"obs":{"type":"string","description":"Observação do movimento de estoque."},"id_local_ds":{"type":"integer"},"quantidade":{"type":"decimal","description":"Quantidade do movimento."},"valor":{"type":"decimal","description":"Valor do Movimento."},"tipo":{"type":"string","description":"Tipo do Ajuste de Estoque. Pode ser: ENT - Efetua uma entrada no estoque. SAI - Efetua uma saída no estoque. SLD - Efetua um ajuste do estoque."},"origem":{"type":"string","description":"Origem do Movimento de Estoque. Pode ser: AJU - Ajuste manual de estoque. PDV - Ajuste realizado pelo PDV."},"motivo":{"type":"string","description":"Motivo do ajuste. Pode ser: Entrada: INV - Ajuste por Inventário. OPE - Integração com Ordem de Produção - Entrada. PDV - Integração com PDV. INI - Ajuste por Inventário (Estoque Inicial). Saída: INV - Ajuste por Inventário. PER - Baixa por Perda ou Quebra. OPS - Integração com Ordem de Produção - Saída. PDV - Integração com PDV. Ajuste saldo estoque: INV - Ajuste por Inventário. INI - Ajuste por Inventário (Estoque Inicial). CMC - Ajuste do Valor do CMC. PDV - Integração com PDV. Transferência entre locais: TPQ - Transferência por Perda ou Quebra. TRF - Transferência entre Locais de Estoque."},"bloqueado":{"type":"string"},"imp_api":{"type":"string"}}},"description":"Estoque mínimo para o produto."}},"title":"ListarAjusteEstoque (retorno)"},"estoque_comprador_ListarCompradores":{"type":"object","title":"ListarCompradores","description":"Lista os compradores cadastrados.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarCompradores"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"apenas_importado_api":{"type":"string","maxLength":1,"description":"Exibir apenas os registros gerados pela API."},"ordenar_por":{"type":"string","maxLength":100,"example":"CODIGO","description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."}}}}},"example":{"call":"ListarCompradores","param":[{"pagina":1,"registros_por_pagina":20}]}},"estoque_comprador_ListarCompradores_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada."},"total_de_paginas":{"type":"integer","description":"Número total de páginas."},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"Total de registros encontrados."},"cadastros":{"type":"array","items":{"type":"object","properties":{"nCodigo":{"type":"integer","description":"Código do tipo de oportunidade."},"cDescricao":{"type":"string","description":"Descrição do tipo de oportunidade."},"cInativo":{"type":"string","description":"Comprador Inativo S/N."}}},"description":"Lista os cadastros encontrados."}},"title":"ListarCompradores (retorno)"},"estoque_consulta_ListarMovimentoEstoque":{"type":"object","title":"ListarMovimentoEstoque","description":"Lista a movimentação de estoque.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarMovimentoEstoque"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página."},"idProd":{"type":"integer","maxLength":15,"description":"Código do Produto."},"cCodInt":{"type":"string","maxLength":60,"description":"Código de Integração do Produto."},"dDtInicial":{"type":"string","maxLength":10,"description":"Data Inicial de Consulta de Estoque."},"dDtFinal":{"type":"string","maxLength":10,"description":"Data Final da Consulta de Estoque."},"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do Local do Estoque.\n\n\nCaso não informado assumirá o Local do Estoque Padrão."},"lista_local_estoque":{"type":"string","description":"Lista de Códigos de Locais do Estoque.\n\n\nSeparar os IDs por virgula (,) ou informar \"TODOS\" para listar todos os estoques de estoque."}}}}},"example":{"call":"ListarMovimentoEstoque","param":[{"nPagina":1,"nRegPorPagina":50,"codigo_local_estoque":0,"idProd":0,"dDtInicial":"30/09/2026","dDtFinal":"30/09/2026","lista_local_estoque":""}]}},"estoque_consulta_ListarMovimentoEstoque_retorno":{"type":"object","properties":{"nPagina":{"type":"integer","description":"Número da página retornada."},"nTotPaginas":{"type":"integer","description":"Número total de páginas."},"nRegistros":{"type":"integer","description":"Número de registros retornados na página."},"nTotRegistros":{"type":"integer","description":"Total de registros encontrados."},"movProdutoListar":{"type":"array","items":{"type":"object","properties":{"idMov":{"type":"integer","description":"Identificação do Movimento."},"dtMov":{"type":"string","description":"Data do movimento."},"dtEmissao":{"type":"string","description":"Data de emissão."},"codOrigem":{"type":"string","description":"Código da Origem."},"desOrigem":{"type":"string","description":"Descrição da Origem."},"numDoc":{"type":"string","description":"Número do Documento (Nota Fiscal)."},"numPedido":{"type":"string","description":"Número do Pedido. Identifica o Pedido de Vendas de Produto, Remessa ou Devolução."},"operacao":{"type":"string","description":"Código da Operação realizada. Pode ser: 00 - Ajuste no estoque 11 - Venda de Produto 12 - Venda de Produto pelo PDV 13 - Devolução de Venda 14 - Remessa de Produto 16 - Nota Complementar de Saída 21 - Compra de Produto 23 - Devolução ao Fornecedor 24 - Retorno de Remessa 26 - Nota Complementar de Entrada 22 - Compra de Produto (Importação) 28 - Ordem de Produção."},"cancelamento":{"type":"string","description":"Indica se é um movimento de cancelamento de Nota Fiscal (S/N)."},"devolucao":{"type":"string","description":"Indica se é um movimento de devolução de Nota Fiscal (S/N)."},"idAjuste":{"type":"integer","description":"Id do Ajuste de estoque."},"idDoc":{"type":"integer","description":"ID da Nota Fiscal."},"idPedido":{"type":"integer","description":"ID do Pedido. Identifica o Pedido de Venda de Produto, Remessa ou Devolução."},"idCupom":{"type":"integer","description":"ID do Cupom Fiscal."},"idCte":{"type":"integer","description":"ID do CTE (Conhecimento de Transporte)."},"idRecebimento":{"type":"integer","description":"ID do recebimento. Para notas de entrada."},"codigo_local_estoque":{"type":"integer","description":"Código do local do estoque."},"idProd":{"type":"integer","description":"Código do Produto."},"tipo":{"type":"string","description":"Tipo da operação. Pode ser: saida entrada."},"descricao":{"type":"string","description":"Descrição do Produto."},"cmc":{"type":"decimal","description":"Valor do CMC da Consulta de Estoque."},"qtde":{"type":"decimal","description":"Quantidade do Movimento."},"valor":{"type":"decimal","description":"Valor do movimento."},"saldo":{"type":"decimal","description":"Saldo de Estoque da Consulta."},"idItem":{"type":"integer","description":"Id do item do movimento."}}},"description":"Movimentação do produto."}},"title":"ListarMovimentoEstoque (retorno)"},"estoque_consulta_ListarPosEstoque":{"type":"object","title":"ListarPosEstoque","description":"Lista as posições de estoque de um dia.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarPosEstoque"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página."},"dDataPosicao":{"type":"string","maxLength":10,"description":"Data da posição do estoque."},"cExibeTodos":{"type":"string","maxLength":1,"description":"Exibir todos os produtos mesmo que não haja movimento.\nPadrão: \"N\"."},"cExibeApenasPDV":{"type":"string","maxLength":1,"description":"Exibe apenas os produtos marcados para PDV.\n\nEsse recurso funciona apenas se o cenário de impostos estiver habilitado.\n\nPadrão: \"N\"."},"cExibeApenasMarketplace":{"type":"string","maxLength":1,"description":"Exibe apenas os produtos marcados para venda como Marketplace.\n\nPadrão: \"N\"."},"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do Local do Estoque.\n\n\nCaso não informado assumirá o Local do Estoque Padrão."},"lista_local_estoque":{"type":"string","description":"Lista de Códigos de Locais do Estoque.\n\n\nSeparar os IDs por virgula (,) ou informar \"TODOS\" para listar todos os estoques de estoque."},"cTipoItem":{"type":"string","maxLength":2,"description":"Código do Tipo do Item.\n\nInformação localizada na aba Recomendações Fiscais do cadastro do produto.\n\n\nPode ser:\n\n00 - Mercadoria para Revenda\n01 - Matéria Prima\n02 - Embalagem\n03 - Produto em Processo\n04 - Produto Acabado\n05 - Subproduto\n06 - Produto Intermediário\n07 - Material de Uso e Consumo\n08 - Ativo Imobilizado\n09 - Serviços\n10 - Outros Insumos\n99 - Outras\nKT - Kit."},"lista_produtos":{"type":"array","items":{"type":"object","properties":{"nCodProd":{"type":"integer","maxLength":15,"description":"Código do Produto.\n(Código interno para integração)."},"cCodInt":{"type":"string","maxLength":60,"description":"Código de Integração do Produto."},"cCodigo":{"type":"string","maxLength":60,"description":"Código do produto.\n(Visualizado na tela)."}}},"description":"Lista de produtos por ID, Código de Integração ou código do produto."}}}}},"example":{"call":"ListarPosEstoque","param":[{"nPagina":1,"nRegPorPagina":50,"dDataPosicao":"30/09/2026","cExibeTodos":"N","codigo_local_estoque":0}]}},"estoque_consulta_ListarPosEstoque_retorno":{"type":"object","properties":{"nPagina":{"type":"integer","description":"Número da página para resgatar os dados."},"nTotPaginas":{"type":"integer","description":"Número total de páginas."},"nRegistros":{"type":"integer","description":"Número de registros retornados na página."},"nTotRegistros":{"type":"integer","description":"Total de registros encontrados."},"dDataPosicao":{"type":"string"},"produtos":{"type":"array","items":{"type":"object","properties":{"nCodProd":{"type":"integer","description":"Código do Produto. (Código interno para integração)."},"cCodInt":{"type":"string","description":"Código de Integração do Produto."},"cCodigo":{"type":"string","description":"Código do produto. (Visualizado na tela)."},"cDescricao":{"type":"string","description":"Descrição do produto."},"nPrecoUnitario":{"type":"decimal","description":"Preço Unitário de venda."},"nSaldo":{"type":"decimal","description":"Saldo do produto."},"nCMC":{"type":"decimal","description":"Custo Médio Contábil."},"nPendente":{"type":"decimal","description":"Saldo pendente em pedidos de venda em aberto (não faturados) e não cancelados."},"estoque_minimo":{"type":"decimal","description":"Estoque mínimo para o produto."},"codigo_local_estoque":{"type":"integer","description":"Código do local do estoque. Se não informado pesquisará no local de estoque padrão."},"reservado":{"type":"decimal","description":"Indica a quantidade reservada do estoque para o produto."},"fisico":{"type":"decimal","description":"Indica a quantidade física em estoque para o produto."}}}}},"title":"ListarPosEstoque (retorno)"},"estoque_consulta_ListarSaldoPendente":{"type":"object","title":"ListarSaldoPendente","description":"Lista o saldo pendente de estoque.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarSaldoPendente"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15},"registros_por_pagina":{"type":"integer","maxLength":15},"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do Local do Estoque.\n\n\nCaso não informado assumirá o Local do Estoque Padrão."},"lista_local_estoque":{"type":"string","description":"Lista de Códigos de Locais do Estoque.\n\n\nSeparar os IDs por virgula (,) ou informar \"TODOS\" para listar todos os estoques de estoque."},"id_prod":{"type":"integer","maxLength":15,"description":"Código do Produto."},"tipo":{"type":"string","maxLength":100,"description":"Preencher com:\n\n\nSAIDA\nENTRADA\nTODOS."}},"required":["tipo"]}}},"example":{"call":"ListarSaldoPendente","param":[{"pagina":1,"registros_por_pagina":50,"codigo_local_estoque":0,"id_prod":0,"tipo":"TODOS"}]}},"estoque_consulta_ListarSaldoPendente_retorno":{"type":"object","properties":{"pagina":{"type":"integer"},"total_de_paginas":{"type":"integer"},"registros":{"type":"integer"},"total_de_registros":{"type":"integer"},"saldo_pendente_lista":{"type":"array","items":{"type":"object","properties":{"codigo_local_estoque":{"type":"integer","description":"Código do local do estoque."},"id_prod":{"type":"integer","description":"Código do produto."},"qtde_saida":{"type":"decimal","description":"Quantidade pendente de saída."},"qtde_entrada":{"type":"decimal","description":"Quantidade pendente de entrada."}}},"description":"Estoque mínimo para o produto."}},"title":"ListarSaldoPendente (retorno)"},"estoque_consulta_MovimentoEstoque":{"type":"object","title":"MovimentoEstoque","description":"Consulta do Movimento de Estoque.","required":["call","param"],"properties":{"call":{"type":"string","enum":["MovimentoEstoque"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do local do estoque.\n\n\nCaso não informado assumirá o local de estoque padrão."},"id_prod":{"type":"integer","maxLength":15,"description":"Código do Produto."},"cod_int":{"type":"string","maxLength":60,"description":"Código de Integração do Produto.\n\n\nInformar apenas se o campo \"id_prod\" não tiver sido preenchido."},"dataInicial":{"type":"string","maxLength":10,"description":"Data Inicial de Consulta de Estoque."},"dataFinal":{"type":"string","maxLength":10,"description":"Data Final da Consulta de Estoque."},"tipo_movimento":{"type":"string","maxLength":1,"description":"Tipo de movimento.\n\nPode ser:\nS - Saída\nE - Entrada."}},"required":["dataFinal","dataInicial"]}}},"example":{"call":"MovimentoEstoque","param":[{"codigo_local_estoque":0,"id_prod":0,"cod_int":"","dataInicial":"30/09/2026","dataFinal":"30/09/2026"}]}},"estoque_consulta_MovimentoEstoque_retorno":{"type":"object","properties":{"codigo_local_estoque":{"type":"integer","description":"Código do local do estoque. Caso não informado assumirá o local de estoque padrão."},"id_prod":{"type":"integer","description":"Código do Produto. (Código interno para integração)."},"cod_int":{"type":"string","description":"Código de Integração do Produto."},"descricao":{"type":"string","description":"Descrição do Produto."},"movProduto":{"type":"array","items":{"type":"object","properties":{"idMov":{"type":"integer","description":"Identificação do Movimento."},"dtMov":{"type":"string","description":"Data do movimento."},"codOrigem":{"type":"string","description":"Código da Origem."},"desOrigem":{"type":"string","description":"Descrição da Origem."},"numDoc":{"type":"string","description":"Número do Documento (Nota Fiscal)."},"movPeriodo":{"type":"array","items":{"type":"object","properties":{"tipo":{"type":"string","description":"Tipo do lançamento (Anterior,Entrada,Saída,Atual)."},"qtde":{"type":"decimal","description":"Quantidade."},"cmcUnitario":{"type":"decimal","description":"Valor unitário do CMC."},"cmcTotal":{"type":"decimal","description":"CMC Total."}}},"description":"Movimentação no período."},"numPedido":{"type":"string","description":"Número do Pedido. Identifica o Pedido de Vendas de Produto, Remessa ou Devolução."},"operacao":{"type":"string","description":"Código da Operação realizada. Pode ser: 00 - Ajuste no estoque 11 - Venda de Produto 12 - Venda de Produto pelo PDV 13 - Devolução de Venda 14 - Remessa de Produto 16 - Nota Complementar de Saída 21 - Compra de Produto 23 - Devolução ao Fornecedor 24 - Retorno de Remessa 26 - Nota Complementar de Entrada 22 - Compra de Produto (Importação) 28 - Ordem de Produção."},"cancelamento":{"type":"string","description":"Indica se é um movimento de cancelamento de Nota Fiscal (S/N)."},"devolucao":{"type":"string","description":"Indica se é um movimento de devolução de Nota Fiscal (S/N)."},"idAjuste":{"type":"integer","description":"Id do Ajuste de estoque."},"idDoc":{"type":"integer","description":"ID da Nota Fiscal."},"idPedido":{"type":"integer","description":"ID do Pedido. Identifica o Pedido de Venda de Produto, Remessa ou Devolução."},"idCupom":{"type":"integer","description":"ID do Cupom Fiscal."},"idCte":{"type":"integer","description":"ID do CTE (Conhecimento de Transporte)."},"idRecebimento":{"type":"integer","description":"ID do recebimento. Para notas de entrada."}}},"description":"Movimentação do produto."}},"title":"MovimentoEstoque (retorno)"},"estoque_consulta_PosicaoEstoque":{"type":"object","title":"PosicaoEstoque","description":"Obtém a Posição de Estoque de um determinado produto para a data.","required":["call","param"],"properties":{"call":{"type":"string","enum":["PosicaoEstoque"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do local do estoque.\n\n\nSe não informado pesquisará no local de estoque padrão."},"id_prod":{"type":"integer","maxLength":15,"description":"Código do Produto."},"cod_int":{"type":"string","maxLength":60,"description":"Código de Integração do Produto.\n\n\nPreencher esse campo apenas se não tiver informado o campo \"id_prod\"."},"data":{"type":"string","maxLength":10,"description":"Data da Consulta de Estoque."},"apenas_saldo":{"type":"string","maxLength":1,"example":"N","description":"Exibir apenas saldo em estoque (S/N).\n\nObs: Se preenchido com \"S\" será exibido somente saldo em estoque.\nInformações como CMC, pedido de vendas em aberto e estoque mínimo não serão apresentados.\n\nPadrão: \"N\"."}}}}},"example":{"call":"PosicaoEstoque","param":[{"codigo_local_estoque":0,"id_prod":0,"cod_int":"","data":"30/09/2026"}]}},"estoque_consulta_PosicaoEstoque_retorno":{"type":"object","properties":{"codigo_status":{"type":"string","description":"Código de Resposta do Status da Consulta de Estoque."},"descricao_status":{"type":"string","description":"Descrição de Resposta do Status da Consulta de Estoque."},"saldo":{"type":"decimal","description":"Saldo de Estoque da Consulta."},"cmc":{"type":"decimal","description":"Valor do CMC da Consulta de Estoque."},"pendente":{"type":"decimal","description":"Saldo pendente em pedidos de venda em aberto (não faturados) e não cancelados."},"estoque_minimo":{"type":"decimal","description":"Estoque mínimo para o produto."},"codigo_local_estoque":{"type":"integer","description":"Código do local do estoque. Se não informado pesquisará no local de estoque padrão."},"reservado":{"type":"decimal","description":"Indica a quantidade reservada do estoque para o produto."},"fisico":{"type":"decimal","description":"Indica a quantidade física em estoque para o produto."}},"title":"PosicaoEstoque (retorno)"},"estoque_local_AlterarLocalEstoque":{"type":"object","title":"AlterarLocalEstoque","description":"Alterar local de Estoque.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarLocalEstoque"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Id do Estoque."},"codigo":{"type":"string","maxLength":50,"description":"Codigo do estoque."},"descricao":{"type":"string","maxLength":250,"description":"Descricao do Estoque."},"tipo":{"type":"string","maxLength":1,"description":"Tipo do Estoque."},"consiSugeCompra":{"type":"string","maxLength":1,"description":"Indica se o Local de Estoque deve ser considerado na sugestão de compra."},"codigo_cliente":{"type":"integer","maxLength":15,"description":"Codigo do Cliente."},"dispOrdemProducao":{"type":"string","maxLength":1,"description":"Disponivel para ordem de producao."},"dispConsumoOP":{"type":"string","maxLength":1,"description":"Consumo da ordem de Producao."},"dispRemessa":{"type":"string","maxLength":1,"description":"Remessa."},"dispVenda":{"type":"string","maxLength":1,"description":"Local de estoque disponivel para Venda."}},"required":["codigo_local_estoque"]}}},"example":{"call":"AlterarLocalEstoque","param":[{"codigo":"L0","descricao":"descrição de teste","tipo":"1","dispOrdemProducao":"N","codigo_cliente":0,"dispConsumoOP":"N","dispRemessa":"N","dispVenda":"N"}]}},"estoque_local_AlterarLocalEstoque_retorno":{"type":"object","properties":{"codigo_local_estoque":{"type":"integer","description":"Codigo do Estoque."},"cCodStatus":{"type":"string","description":"Codigo de Status."},"cDesStatus":{"type":"string","description":"Descricao do Status."}},"title":"AlterarLocalEstoque (retorno)"},"estoque_local_IncluirLocalEstoque":{"type":"object","title":"IncluirLocalEstoque","description":"Adiciona um local de estoque.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirLocalEstoque"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo":{"type":"string","maxLength":50,"description":"Código do local."},"descricao":{"type":"string","maxLength":250,"description":"Descrição do Local."},"tipo":{"type":"string","maxLength":1,"description":"Tipo."},"consiSugeCompra":{"type":"string","maxLength":1},"codigo_cliente":{"type":"integer","maxLength":15,"description":"Codigo do cliente."},"dispOrdemProducao":{"type":"string","maxLength":1,"description":"Disponível para ordem de produção."},"dispConsumoOP":{"type":"string","maxLength":1,"description":"Disponível para consumo."},"dispRemessa":{"type":"string","maxLength":1,"description":"Disponível para remessa."},"dispVenda":{"type":"string","maxLength":1,"description":"Disponível Venda."}},"required":["codigo","descricao","tipo"]}}},"example":{"call":"IncluirLocalEstoque","param":[{"codigo":"L0","descricao":"descrição de teste","tipo":"1","dispOrdemProducao":"N","dispConsumoOP":"N","dispRemessa":"N","dispVenda":"N","consiSugeCompra":"N"}]}},"estoque_local_IncluirLocalEstoque_retorno":{"type":"object","properties":{"codigo_local_estoque":{"type":"integer","description":"Código do Local do Estoque."},"codigo":{"type":"string","description":"Código do Local de Estoque."},"cCodStatus":{"type":"string","description":"Código de Status."},"cDesStatus":{"type":"string","description":"Descrição do Status."}},"title":"IncluirLocalEstoque (retorno)"},"estoque_local_ListarLocaisEstoque":{"type":"object","title":"ListarLocaisEstoque","description":"Lista os Locais de Estoque encontrados.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarLocaisEstoque"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15},"nRegPorPagina":{"type":"integer","maxLength":15},"filtrar_por_data_de":{"type":"string","maxLength":10,"description":"Filtrar os registros a partir de uma data.\n\n\nFormato: \"dd/mm/aaaa\"."},"filtrar_por_hora_de":{"type":"string","maxLength":8,"description":"Filtrar a partir da hora.\n\n\nFormato: \"hh:mm:ss\"."},"filtrar_por_data_ate":{"type":"string","maxLength":10,"description":"Filtrar os registros até uma data.\n\n\nFormato: \"dd/mm/aaaa\"."},"filtrar_por_hora_ate":{"type":"string","maxLength":8,"description":"Filtrar até a hora.\n\n\nFormato: \"hh:mm:ss\"."},"filtrar_apenas_inclusao":{"type":"string","maxLength":1,"example":"S","description":"Filtrar apenas os registros incluídos (S/N).\n\n\nPreencher com \"S\" ou \"N\"."},"filtrar_apenas_alteracao":{"type":"string","maxLength":1,"example":"S","description":"Filtrar apenas os registros alterados (S/N).\n\n\nPreencher com \"S\" ou \"N\"."}}}}},"example":{"call":"ListarLocaisEstoque","param":[{"nPagina":1,"nRegPorPagina":20}]}},"estoque_local_ListarLocaisEstoque_retorno":{"type":"object","properties":{"nPagina":{"type":"integer"},"nTotPaginas":{"type":"integer"},"nRegistros":{"type":"integer"},"nTotRegistros":{"type":"integer"},"locaisEncontrados":{"type":"array","items":{"type":"object","properties":{"codigo_local_estoque":{"type":"integer","description":"Código do Local do Estoque. Utilize esse ID para identificar os locais do estoque que serão utilizados nas demais APIs."},"codigo":{"type":"string","description":"Código do Local do Estoque. Conforme informado na tela de cadastro do Local do Estoque. Para identificação do Local do Estoque via API utilize o campo \"codigo_local_estoque\"."},"descricao":{"type":"string","description":"Descrição do Local de Estoque."},"tipo":{"type":"string","description":"Tipo de Local de Estoque. Pode ser: 1 - Estoque próprio da Empresa 2 - Estoque próprio da Empresa em poder de terceiros 3 - Estoque de terceiros em poder da Empresa."},"padrao":{"type":"string","description":"Indica se o Local do Estoque é padrão (S/N)."},"inativo":{"type":"string","description":"Indica se o Local do Estoque está inativo (S/N)."},"codigo_cliente":{"type":"integer","description":"Código do cliente/fornecedor."},"dispOrdemProducao":{"type":"string","description":"Indica se o Local do Estoque está disponível para Ordem de Produção (S/N)."},"dispConsumoOP":{"type":"string","description":"Indica se o Local do Estoque está disponível para consumo da Ordem de Produção (S/N)."},"dispRemessa":{"type":"string","description":"Indica se o Local do Estoque está disponível para Remessa (S/N)."},"dispVenda":{"type":"string","description":"Indica se o Local do Estoque está disponível para Venda (S/N)."},"dInc":{"type":"string","description":"Data de Inclusão."},"hInc":{"type":"string","description":"Hora de inclusão."},"uInc":{"type":"string","description":"Código do usuário que realizou a inclusão."},"dAlt":{"type":"string","description":"Data de alteração."},"hAlt":{"type":"string","description":"Hora de alteração."},"uAlt":{"type":"string","description":"Código do usuário que realizou a alteração."}}},"description":"Lista de Locais de Estoque encontrados."}},"title":"ListarLocaisEstoque (retorno)"},"estoque_movestoque_ConsultarPrevisao":{"type":"object","title":"ConsultarPrevisao","description":"Consulta a previsão de venda em estoque de um produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarPrevisao"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodProd":{"type":"integer","maxLength":15,"description":"Código do produto.\n(Gerado internamente, não é visualizado na tela)."},"cCodIntProd":{"type":"string","maxLength":60,"description":"Código de Integração do produto.\n(Utilizado em produtos criados via API, não é visualizado na tela)."},"cCodigo":{"type":"string","maxLength":60,"description":"Código do produto, conforme o fornecedor utiliza."},"dDtInicial":{"type":"string","maxLength":10,"description":"Data inicial da pesquisa."},"dDtFinal":{"type":"string","maxLength":10,"description":"Data final da pesquisa."},"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do local do estoque.\n\n\nSe não informado pesquisará no local de estoque padrão."}}}}},"example":{"call":"ConsultarPrevisao","param":[{"nCodProd":1}]}},"estoque_movestoque_ConsultarPrevisao_retorno":{"type":"object","properties":{"nCodProd":{"type":"integer","description":"Código do produto. (Gerado internamente, não é visualizado na tela)."},"cCodIntProd":{"type":"string","description":"Código de Integração do produto. (Utilizado em produtos criados via API, não é visualizado na tela)."},"cCodigo":{"type":"string","description":"Código do produto, conforme o fornecedor utiliza."},"cDescricao":{"type":"string","description":"Descrição do produto."},"nQtdePrevista":{"type":"decimal","description":"Quantidade prevista de estoque."},"codigo_local_estoque":{"type":"integer","description":"Código do local do estoque. Se não informado pesquisará no local de estoque padrão."}},"title":"ConsultarPrevisao (retorno)"},"estoque_movestoque_ListarMovimentos":{"type":"object","title":"ListarMovimentos","description":"Lista os movimentos de entrada/saida de um período.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarMovimentos"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"apenas_importado_api":{"type":"string","maxLength":1,"description":"Exibir apenas os registros gerados pela API."},"ordenar_por":{"type":"string","maxLength":100,"example":"CODIGO","description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."},"data_inicial":{"type":"string","maxLength":10,"description":"Data de inicio do período a ser pesquisado."},"data_final":{"type":"string","maxLength":10,"description":"Data final do período a ser pesquisado."},"hora_inicial":{"type":"string","maxLength":8,"description":"Hora Inicial."},"hora_final":{"type":"string","maxLength":8,"description":"Hora Final."},"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do Local do Estoque.\n\n\nSe não informado assumirá o Local de Estoque padrão."}}}}},"example":{"call":"ListarMovimentos","param":[{"pagina":1,"registros_por_pagina":20,"codigo_local_estoque":0}]}},"estoque_movestoque_ListarMovimentos_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada."},"total_de_paginas":{"type":"integer","description":"Número total de páginas."},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"Total de registros encontrados."},"cadastros":{"type":"array","items":{"type":"object","properties":{"nCodProd":{"type":"integer","description":"Código do produto. (Gerado internamente, não é visualizado na tela)."},"cCodIntProd":{"type":"string","description":"Código de Integração do produto. (Utilizado em produtos criados via API, não é visualizado na tela)."},"cCodigo":{"type":"string","description":"Código do produto, conforme o fornecedor utiliza."},"cDescricao":{"type":"string","description":"Descrição do produto."},"movimentos":{"type":"array","items":{"type":"object","properties":{"dDataMovimento":{"type":"string","description":"Data do movimento."},"nQtdeEntradas":{"type":"decimal","description":"Quantidade total de entradas para o dia."},"nQtdeSaidas":{"type":"decimal","description":"Quantidade total de saídas para o dia."}}},"description":"Movimentos de entrada/saída do produto."}}},"description":"Lista os cadastros de produtos encontrados."}},"title":"ListarMovimentos (retorno)"},"estoque_produtofornecedor_ListarProdutoFornecedor":{"type":"object","title":"ListarProdutoFornecedor","description":"Listar os produtos por fornecedores.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarProdutoFornecedor"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 10."},"apenas_importado_api":{"type":"string","maxLength":1,"description":"Exibir apenas os registros gerados pela API."},"ordenar_por":{"type":"string","maxLength":100,"description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."}}}}},"example":{"call":"ListarProdutoFornecedor","param":[{"pagina":1,"registros_por_pagina":50}]}},"estoque_produtofornecedor_ListarProdutoFornecedor_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada."},"total_de_paginas":{"type":"integer","description":"Número total de páginas."},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"Total de registros encontrados."},"cadastros":{"type":"array","items":{"type":"object","properties":{"nCodForn":{"type":"integer","description":"Código do fornecedor. (Gerado internamente, não é visualizado na tela)."},"cCodIntForn":{"type":"string","description":"Código de Integração do fornecedor. (Utilizado em fornecedores criados via API, não é visualizado na tela)."},"cCpfCnpj":{"type":"string","description":"CPF / CNPJ do fornecedor."},"cRazaoSocial":{"type":"string","description":"Razão Social do fornecedor."},"cNomeFantasia":{"type":"string","description":"Nome Fantasia do fornecedor."},"produtos":{"type":"array","items":{"type":"object","properties":{"nCodProd":{"type":"integer","description":"Código do produto. (Gerado internamente, não é visualizado na tela)."},"cCodIntProd":{"type":"string","description":"Código de Integração do produto. (Utilizado em produtos criados via API, não é visualizado na tela)."},"cCodigo":{"type":"string","description":"Código do produto, conforme o fornecedor utiliza."},"cDescricao":{"type":"string","description":"Descrição do produto."}}},"description":"Lista de produtos."}}},"description":"Lista os cadastros encontrados."}},"title":"ListarProdutoFornecedor (retorno)"},"estoque_reserva_ConsumirReservaEstoque":{"type":"object","title":"ConsumirReservaEstoque","description":"Consumir reserva estoque","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsumirReservaEstoque"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"id_reserva":{"type":"integer","maxLength":15,"description":"Id da reserva devolvido por IncluirReservaEstoque. Obrigatório."},"id_prod":{"type":"integer","maxLength":15,"description":"Código interno do produto da reserva. Obrigatório."},"quan":{"type":"number","maxLength":18,"description":"Quantidade a consumir. Obrigatória e maior que zero."}},"required":["id_prod","id_reserva","quan"]}}},"example":{"call":"ConsumirReservaEstoque","param":[{"id_reserva":12345678,"id_prod":16487740,"quan":15}]}},"estoque_reserva_ConsumirReservaEstoque_retorno":{"type":"object","properties":{"codigo_status":{"type":"string","description":"Código do status. \"0\" indica sucesso."},"descricao_status":{"type":"string","description":"Descrição do status."}},"title":"ConsumirReservaEstoque (retorno)"},"estoque_reserva_ExcluirReservaEstoque":{"type":"object","title":"ExcluirReservaEstoque","description":"Exclui uma reserva de estoque","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirReservaEstoque"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"id_reserva":{"type":"integer","maxLength":15,"description":"Id da reserva a excluir (devolvido por IncluirReservaEstoque). Obrigatório."}},"required":["id_reserva"]}}},"example":{"call":"ExcluirReservaEstoque","param":[{"id_reserva":12345678}]}},"estoque_reserva_ExcluirReservaEstoque_retorno":{"type":"object","properties":{"codigo_status":{"type":"string","description":"Código do status. \"0\" indica sucesso."},"descricao_status":{"type":"string","description":"Descrição do status."}},"title":"ExcluirReservaEstoque (retorno)"},"estoque_reserva_IncluirReservaEstoque":{"type":"object","title":"IncluirReservaEstoque","description":"Incluir uma Reserva de Estoque","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirReservaEstoque"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"empresa":{"type":"integer","maxLength":15,"description":"Código da empresa da reserva. Padrão a empresa atual do aplicativo."},"id_prod":{"type":"integer","maxLength":15,"description":"Código interno do produto no Omie. Obrigatório."},"id_local":{"type":"integer","description":"Id do local de estoque. Hoje é validado mas não é usado; a reserva vai para o local padrão."},"data":{"type":"string","maxLength":10,"description":"Data da reserva (dd/mm/aaaa). Obrigatória."},"quan":{"type":"number","maxLength":18,"description":"Quantidade a reservar. Obrigatória e maior que zero."},"origem":{"type":"string","maxLength":3,"description":"Origem do ajuste da reserva. Padrão \"PDV\"."},"tipo":{"type":"string","maxLength":3,"description":"Tipo do ajuste. Obrigatório. Use \"RES\" (reserva).\n\nTambém aceita \"ENT\", \"SAI\", \"SLD\" e \"TRF\", mas esses fazem um ajuste real de estoque em vez de uma reserva."},"motivo":{"type":"string","maxLength":3,"description":"Motivo do ajuste. Só aceita \"RES\" (padrão)."},"valor":{"type":"number","maxLength":18,"description":"Valor unitário do produto reservado. Não pode ser negativo."},"obs":{"type":"string","description":"Observação da reserva."}},"required":["data","id_prod","quan","tipo"]}}},"example":{"call":"IncluirReservaEstoque","param":[{"empresa":0,"id_prod":16487740,"id_local":0,"data":"#TODAY#","quan":15,"origem":"PDV","tipo":"RES","motivo":"RES","valor":10,"obs":"Reserva gerada pela API"}]}},"estoque_reserva_IncluirReservaEstoque_retorno":{"type":"object","properties":{"codigo_status":{"type":"string","description":"Código do status. \"0\" indica sucesso."},"descricao_status":{"type":"string","description":"Descrição do status."},"id_reserva":{"type":"integer","description":"Id da reserva incluída (é o id do ajuste de estoque). Usado para consumir ou excluir a reserva. Vem 0 em caso de erro."}},"title":"IncluirReservaEstoque (retorno)"},"estoque_resumo_ObterEstoqueProduto":{"type":"object","title":"ObterEstoqueProduto","description":"Obtem a posição de estoque do produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterEstoqueProduto"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cEAN":{"type":"string","maxLength":14,"description":"Código EAN (GTIN - Global Trade Item Number)."},"nIdProduto":{"type":"integer","maxLength":15,"description":"Código do produto.\n(Gerado internamente, não é visualizado na tela)."},"cCodigo":{"type":"string","maxLength":60,"description":"Código do Produto.\n(É o código do produto que é exibido na tela do Omie.)."},"xCodigo":{"type":"string","maxLength":120,"description":"Campo dinâmico para filtrar o cadastro de produto.\n\nPode ser:\n\nEAN\nCódigo (SKU)\nDescrição.\n\nQuando mais de um produto for encontrado, a lista de itens será retornada na tag \"ListaProduto\" e a \"listaEstoque\" não será retornada."},"dDia":{"type":"string","maxLength":10,"description":"Data da consulta."},"cExibirImagens":{"type":"string","maxLength":1,"example":"S","description":"Exibir imagens do produto? (S/N)."}}}}},"example":{"call":"ObterEstoqueProduto","param":[{"cEAN":"","nIdProduto":0,"cCodigo":"","xCodigo":"","dDia":"30/09/2026"}]}},"estoque_resumo_ObterEstoqueProduto_retorno":{"type":"object","properties":{"nIdProduto":{"type":"integer","description":"Código do produto. (Gerado internamente, não é visualizado na tela)."},"cCodigo":{"type":"string","description":"Código do Produto. (É o código do produto que é exibido na tela do Omie.)."},"cDescricao":{"type":"string","description":"Descrição do produto."},"cEAN":{"type":"string","description":"Código EAN (GTIN - Global Trade Item Number)."},"dDia":{"type":"string","description":"Data da consulta."},"cNCM":{"type":"string","description":"Código da Nomenclatura Comum do Mercosul (NCM)."},"cUnidade":{"type":"string","description":"Código da Unidade."},"listaEstoque":{"type":"array","items":{"type":"object","properties":{"nIdlocal":{"type":"integer","description":"Código do local do estoque."},"nFisico":{"type":"decimal","description":"Indica a quantidade física em estoque para o produto."},"nReservado":{"type":"decimal","description":"Indica a quantidade reservada do estoque para o produto."},"nPrevisaoSaida":{"type":"decimal","description":"Indica a quantidade prevista de saída do produto."},"nPrevisaoEntrada":{"type":"decimal","description":"Indica a quantidade prevista de entrada do produto."},"nDisponivel":{"type":"decimal","description":"Indica a quantidade disponivel de estoque do produto."},"nCMC":{"type":"decimal","description":"Valor do CMC da Estoque do produto."},"nPrecoUnitario":{"type":"decimal","description":"Preço Unitário de venda."},"nPrecoUltComp":{"type":"decimal","description":"Preço unitário da última compra do produto."},"dDtUltComp":{"type":"string","description":"Data da última compra do produto."},"nEstoqueMinimo":{"type":"decimal","description":"Estoque mínimo para o produto."},"cIcone":{"type":"string"},"cCor":{"type":"string"},"cDescricaoLocal":{"type":"string","description":"Descrição do local de estoque."}}},"description":"Exibe os totais de estoque do produto."},"listaProduto":{"type":"object","properties":{"nIdProduto":{"type":"integer","description":"Código do produto. (Gerado internamente, não é visualizado na tela)."},"cCodigo":{"type":"string","description":"Código do Produto. (É o código do produto que é exibido na tela do Omie.)."},"cDescricao":{"type":"string","description":"Descrição do produto."},"cEAN":{"type":"string","description":"Código EAN (GTIN - Global Trade Item Number)."},"cNCM":{"type":"string","description":"Código da Nomenclatura Comum do Mercosul (NCM)."},"cUnidade":{"type":"string","description":"Código da Unidade."}},"description":"Lista com as informações dos produtos encontrados a partir do dado informado na tag \"xCodigo\". Essa estrutura será retornada apenas quando a tag \"xCodigo\" for preenchida."},"listaImagens":{"type":"array","items":{"type":"object","properties":{"cUrlImagem":{"type":"string","description":"URL da Imagem do produto."}}}}},"title":"ObterEstoqueProduto (retorno)"},"financas_caixa_ListarOrcamentos":{"type":"object","title":"ListarOrcamentos","description":"Lista os Orçamentos de Caixa.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarOrcamentos"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nAno":{"type":"integer","maxLength":15,"description":"Ano."},"nMes":{"type":"integer","maxLength":15,"description":"Mês."}},"required":["nAno","nMes"]}}},"example":{"call":"ListarOrcamentos","param":[{"nAno":2018,"nMes":3}]}},"financas_caixa_ListarOrcamentos_retorno":{"type":"object","properties":{"nAno":{"type":"integer","description":"Ano."},"nMes":{"type":"integer","description":"Mês."},"ListaOrcamentos":{"type":"array","items":{"type":"object","properties":{"cCodCateg":{"type":"string","description":"Código da Categoria"},"cDesCateg":{"type":"string","description":"Descrição da Categoria."},"nValorPrevisto":{"type":"decimal","description":"Valor Previsto."},"nValorRealilzado":{"type":"decimal","description":"Valor Realizado / a realizar."}}},"description":"Orçamento por categorias."}},"title":"ListarOrcamentos (retorno)"},"financas_consultaaging_ListarContasAging":{"type":"object","title":"ListarContasAging","description":"Retorna a aging de Contas a Pagar e a Receber atrasadas e aging completo de contas. Aging também é conhecido como faixa e carteira.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarContasAging"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"tipo_conta":{"type":"string","example":"","description":"Tipo de conta para consulta sendo 'P' para contas a pagar e 'R' para contas a receber. Caso o usuário não informe nenhum tipo de conta, envie obrigatoriamente tipo_conta = \"\" (string vazia)"},"nome_cliente":{"type":"string","example":"","description":"Nome do Cliente fornecedor para consulta"},"documento_cliente":{"type":"string","example":"","description":"Documento do Cliente fornecedor para consulta"},"dias_atraso":{"type":"integer","example":-1,"description":"Quantidade máxima de dias de atraso considerada na consulta. Utilize obrigatoriamente um dos valores abaixo, conforme a expressão informada pelo usuário:\n  - SE usuário disser 'todas as contas' ENTÃO dias_atraso = -1\n  - SE usuário disser 'até 3 dias' ENTÃO dias_atraso = 3\n  - SE usuário disser 'até 5 dias' ENTÃO dias_atraso = 5\n  - SE usuário disser 'até 7 dias' ENTÃO dias_atraso = 7\n  - SE usuário disser 'até 10 dias' ENTÃO dias_atraso = 10\n  - SE usuário disser 'até 15 dias' ENTÃO dias_atraso = 15\n  - SE usuário disser 'até 30 dias' ENTÃO dias_atraso = 30\n  - SE usuário disser 'até 60 dias' ENTÃO dias_atraso = 60\n  - SE usuário disser 'até 90 dias' ENTÃO dias_atraso = 90\n  - SE usuário disser 'até 120 dias' ENTÃO dias_atraso = 120\n  - SE usuário disser 'até 6 meses' ENTÃO dias_atraso = 180\n  - SE usuário disser 'até 1 ano' ENTÃO dias_atraso = 365\n  - SE usuário disser 'até 2 anos' ENTÃO dias_atraso = 730\n  - SE usuário disser 'até 3 anos' ENTÃO dias_atraso = 1095\n  - SE usuário disser 'até 5 anos' ENTÃO dias_atraso = 1825\n  - SE usuário disser 'não exibir contas atrasadas' ENTÃO dias_atraso = 0\nO valor -1 significa que não deve ser aplicado limite máximo de dias de atraso. As conversões de meses e anos acima são fixas; nunca recalcule esses períodos com base no calendário. Caso o usuário não informe nenhuma quantidade ou faixa de atraso, envie obrigatoriamente dias_atraso = -1. Nunca omita dias_atraso e nunca envie o objeto de request vazio, pois a API rejeita a requisição."}},"required":["dias_atraso","tipo_conta"]}}}},"financas_consultaaging_ListarContasAging_retorno":{"type":"object","properties":{"success":{"type":"boolean"},"dados":{"type":"array","items":{"type":"object","properties":{"detalhes":{"type":"object","properties":{"tip":{"type":"string","description":"Tipo da conta. 'R' representa Contas a Receber e 'P' representa Contas a Pagar."}}},"dados_lancamento":{"type":"array","items":{"type":"object","properties":{"valores":{"type":"object","properties":{"valor_liq":{"type":"decimal","description":"Valor líquido original do lançamento."}}}}}},"pagamento":{"type":"object","properties":{"valor_doc":{"type":"decimal","description":"Valor a pagar ou receber."}}},"dados_baixa":{"type":"array","items":{"type":"object","properties":{"valores":{"type":"object","properties":{"valor_liq":{"type":"decimal","description":"Valor líquido do título."},"vl_pagar":{"type":"decimal","description":"Saldo atual em aberto do título. Este é o valor oficial utilizado para cálculos de aging."},"vl_pago":{"type":"decimal","description":"Valor já recebido ou pago do título."}}}}}},"cliente":{"type":"string","description":"Nome do Cliente ou Fornecedor."},"cliente_documento":{"type":"string","description":"CPF ou CNPJ do Cliente ou Fornecedor."},"faixa_vencimento":{"type":"string","description":"Faixa oficial de aging calculada."}}}}},"title":"ListarContasAging (retorno)"},"financas_contacorrentelancamentos_AlterarLancCC":{"type":"object","title":"AlterarLancCC","description":"Alterar lançamento de conta corrente","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarLancCC"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodLanc":{"type":"integer","maxLength":15,"description":"Código do lançamento da conta corrente.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno do lançamento da conta corrente gerado pelo Omie."},"cCodIntLanc":{"type":"string","maxLength":20,"description":"Código interno do lançamento da conta corrente.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código do lançamento da conta corrente utilizado no seu aplicativo quando incluir um lançamento no Omie."},"cabecalho":{"type":"object","properties":{"nCodCC":{"type":"integer","maxLength":15,"description":"Código da conta corrente.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno da conta corrente cadastrada no Omie."},"dDtLanc":{"type":"string","maxLength":10,"description":"Data do lançamento na conta corrente.\nNo formato dd/mm/aaaa."},"nValorLanc":{"type":"number","maxLength":18,"description":"Valor do lançamento"}},"description":"Cabeçalho do lançamento do conta corrente"},"detalhes":{"type":"object","properties":{"cCodCateg":{"type":"string","maxLength":20,"description":"Código da categoria.\n(Interno, utilizado apenas na integração via API, não é exibido na tela)."},"aCodCateg":{"type":"array","items":{"type":"object","properties":{"cCodCateg":{"type":"string","maxLength":20,"description":"Código da categoria"},"nValor":{"type":"number","description":"Valor da categoria"},"nPerc":{"type":"number","description":"Percentual da categoria"}}}},"cTipo":{"type":"string","maxLength":5,"description":"Tipo de documento.\nPode ser:\nADI - Adiantamento\nBOL - Boleto\nCRT - Cartão\nCHQ - Cheque\nCON - Convênios\nCRE - Crediário\nDRF - DARF\nDAS - DAS\nDEB - Débito em conta\nDIN - Dinheiro\nDOC - DOC\nGUIA - Guia de Recolhimento\nPROT - Protesto\nREC - Recibo\nRPA - RPA\nTED - TED\nTRA - Transferência\n99999 - Outros"},"cNumDoc":{"type":"string","maxLength":20,"description":"Número do Documento."},"nCodCliente":{"type":"integer","maxLength":15,"description":"Código de Cliente / Favorecido.\n(Gerado internamente, não é visualizado na tela)"},"nCodProjeto":{"type":"integer","maxLength":15,"description":"Código do projeto.\n(Gerado internamente, não é visualizado na tela)"},"cObs":{"type":"string","description":"Observações."}},"description":"Detalhes do lançamento do conta corrente."},"transferencia":{"type":"object","properties":{"nCodCCDestino":{"type":"integer","maxLength":15,"description":"Código da conta corrente de destino.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno da conta corrente cadastrada no Omie."}},"description":"Dados da transferência do lançamento do conta corrente"},"departamentos":{"type":"array","items":{"type":"object","properties":{"cCodDep":{"type":"string","maxLength":40,"description":"Código do departamento.\n(Gerado internamente, não é visualizado na tela)"},"nValDep":{"type":"number","maxLength":18,"description":"Valor do departamento"},"nPerDep":{"type":"number","maxLength":10,"description":"Percentual do departamento"}}},"description":"Distribuição por departamento do lançamento do conta corrente"}}}}},"example":{"call":"AlterarLancCC","param":[{"cCodIntLanc":"1790776553","cabecalho":{"nCodCC":427619317,"dDtLanc":"30/09/2026","nValorLanc":123.46},"detalhes":{"cCodCateg":"1.01.02","cTipo":"DIN","nCodCliente":2485994,"cObs":"Referente a jardinagem executada na matriz"}}]}},"financas_contacorrentelancamentos_AlterarLancCC_retorno":{"type":"object","properties":{"nCodLanc":{"type":"integer","description":"Código do lançamento da conta corrente. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do lançamento da conta corrente gerado pelo Omie."},"cCodIntLanc":{"type":"string","description":"Código do lançamento da conta corrente. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código lançamento da conta corrente utilizado no seu aplicativo quando incluir um lançamento no Omie."},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro durante o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodigoStatus\"."}},"title":"AlterarLancCC (retorno)"},"financas_contacorrentelancamentos_ConsultaLancCC":{"type":"object","title":"ConsultaLancCC","description":"Consulta o lançamento de conta corrente","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultaLancCC"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodLanc":{"type":"integer","maxLength":15,"description":"Código do lançamento da conta corrente.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno do lançamento da conta corrente gerado pelo Omie."},"cCodIntLanc":{"type":"string","maxLength":20,"description":"Código do lançamento da conta corrente.\n(Interno, utilizado apenas na integração via API, não aparece na tela).\nUtilize esse campo para informar o código interno do lançamento da conta corrente utilizado no seu aplicativo quando incluir um lançamento no Omie."}}}}},"example":{"call":"ConsultaLancCC","param":[{"nCodLanc":0,"cCodIntLanc":""}]}},"financas_contacorrentelancamentos_ConsultaLancCC_retorno":{"type":"object","properties":{"nCodLanc":{"type":"integer","description":"Código do lançamento da conta corrente. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do lançamento da Conta Corrente gerado pelo Omie."},"cCodIntLanc":{"type":"string","description":"Código do lançamento da conta corrente. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código interno do lançamento da conta corrente utilizado no seu aplicativo quando incluir um lançamento no Omie."},"nCodAgrup":{"type":"integer","description":"Código do agrupamento do lançamento de conta corrente."},"cabecalho":{"type":"object","properties":{"nCodCC":{"type":"integer","description":"Código da conta corrente. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da conta corrente cadastrada no Omie."},"dDtLanc":{"type":"string","description":"Data do lançamento na conta corrente. No formato dd/mm/aaaa."},"nValorLanc":{"type":"decimal","description":"Valor do lançamento"}},"description":"Cabeçalho do lançamento do conta corrente"},"detalhes":{"type":"object","properties":{"cCodCateg":{"type":"string","description":"Código da categoria. (Interno, utilizado apenas na integração via API, não é exibido na tela)."},"aCodCateg":{"type":"array","items":{"type":"object","properties":{"cCodCateg":{"type":"string","description":"Código da categoria"},"nValor":{"type":"decimal","description":"Valor da categoria"},"nPerc":{"type":"decimal","description":"Percentual da categoria"}}}},"cTipo":{"type":"string","description":"Tipo de documento. Pode ser: ADI - Adiantamento BOL - Boleto CRT - Cartão CHQ - Cheque CON - Convênios CRE - Crediário DRF - DARF DAS - DAS DEB - Débito em conta DIN - Dinheiro DOC - DOC GUIA - Guia de Recolhimento PROT - Protesto REC - Recibo RPA - RPA TED - TED TRA - Transferência 99999 - Outros"},"cNumDoc":{"type":"string","description":"Número do Documento."},"nCodCliente":{"type":"integer","description":"Código de Cliente / Favorecido. (Gerado internamente, não é visualizado na tela)"},"nCodProjeto":{"type":"integer","description":"Código do projeto. (Gerado internamente, não é visualizado na tela)"},"cObs":{"type":"string","description":"Observações."}},"description":"Detalhes do lançamento do conta corrente."},"transferencia":{"type":"object","properties":{"nCodCCDestino":{"type":"integer","description":"Código da conta corrente de destino. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da conta corrente cadastrada no Omie."}},"description":"Dados da transferência do lançamento do conta corrente"},"departamentos":{"type":"array","items":{"type":"object","properties":{"cCodDep":{"type":"string","description":"Código do departamento. (Gerado internamente, não é visualizado na tela)"},"nValDep":{"type":"decimal","description":"Valor do departamento"},"nPerDep":{"type":"decimal","description":"Percentual do departamento"}}},"description":"Distribuição por departamento do lançamento do conta corrente"},"diversos":{"type":"object","properties":{"cOrigem":{"type":"string","description":"Origem do lançamento Pode ser: DEVP - Conta a pagar da devolução de venda DEVR - Conta a receber da devolução ao fornecedor EXTP - Lançamento manual de despesa EXTR - Lançamento manual de receita IMPP - Parcela a pagar de uma nota de importação MANP - Lançamento manual de conta a pagar MANR - Lançamento manual de conta a receber NFEP - Conta a pagar importada de uma NF-e NFER - Conta a receber importada de uma NF-e OFXP- Pagamento importado de um arquivo OFX OFXR - Recebimento importado de um arquivo OFX RPTP - Repetição de contas a pagar RPTR - Repetição de contas a receber TRAP - Débito de transferência entre contas correntes TRAR - Crédito de transferência entre contas correntes VENR - Parcela a receber de vendas XMLP - Conta a pagar importada de um arquivo XML XMLR - Conta a receber importada de um arquivo XML"},"dDtConc":{"type":"string","description":"Data da conciliação do lançamento na conta corrente No formato dd/mm/aaaa."},"cHrConc":{"type":"string","description":"Hora da conciliação do lançamento na conta corrente"},"cUsConc":{"type":"string","description":"Código do usuário responsável pela conciliação"},"nCodVendedor":{"type":"integer","description":"Código do vendedor. (Gerado internamente, não é visualizado na tela)"},"nCodComprador":{"type":"integer","description":"Código do comprador. (Gerado internamente, não é visualizado na tela)"},"cNatureza":{"type":"string","description":"Natureza do lançamento. Pode ser: P - Contas a pagar R - Contas a receber"},"cIdentLanc":{"type":"string","description":"Identificação do lançamento do extrato importado"},"nCodLancCP":{"type":"integer","description":"Código do lançamento de contas a pagar que gerou o lançamento de conta corrente"},"nCodLancCR":{"type":"integer","description":"Código do lançamento de contas a receber que gerou o lançamento de conta corrente"}},"description":"Outras informações."},"info":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão. No formato dd/mm/aaaa."},"hInc":{"type":"string","description":"Hora da Inclusão. No formato hh:mm:ss."},"uInc":{"type":"string","description":"Usuário da Inclusão."},"dAlt":{"type":"string","description":"Data da Alteração. No formato dd/mm/aaaa."},"hAlt":{"type":"string","description":"Hora da Alteração. No formato hh:mm:ss."},"uAlt":{"type":"string","description":"Usuário da Alteração."},"cImpAPI":{"type":"string","description":"Importado pela API (S/N)."}},"description":"Informações do cadastro."}},"title":"ConsultaLancCC (retorno)"},"financas_contacorrentelancamentos_ExcluirLancCC":{"type":"object","title":"ExcluirLancCC","description":"Excluir o lançamento de conta corrente","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirLancCC"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodLanc":{"type":"integer","maxLength":15,"description":"Código do lançamento da conta corrente.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno do lançamento da conta corrente gerado pelo Omie."},"cCodIntLanc":{"type":"string","maxLength":20,"description":"Código do lançamento da conta corrente.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código interno do lançamento da conta corrente utilizado no seu aplicativo quando incluir um lançamento no Omie."}}}}},"example":{"call":"ExcluirLancCC","param":[{"nCodLanc":0,"cCodIntLanc":""}]}},"financas_contacorrentelancamentos_ExcluirLancCC_retorno":{"type":"object","properties":{"nCodLanc":{"type":"integer","description":"Código do lançamento da conta corrente. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do lançamento da conta corrente gerado pelo Omie."},"cCodIntLanc":{"type":"string","description":"Código do lançamento da conta corrente. (Interno, utilizado apenas na integração via API, não aparece na tela). Utilize esse campo para informar o código interno do lançamento da conta corrente utilizado no seu aplicativo quando incluir um lançamento no Omie."},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro durante o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodigoStatus\"."}},"title":"ExcluirLancCC (retorno)"},"financas_contacorrentelancamentos_IncluirLancCC":{"type":"object","title":"IncluirLancCC","description":"Incluir lançamento de conta corrente","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirLancCC"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cCodIntLanc":{"type":"string","maxLength":20,"description":"Código do lançamento da conta corrente.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o lançamento da conta corrente utilizado no seu aplicativo quando incluir um lançamento no Omie."},"cabecalho":{"type":"object","properties":{"nCodCC":{"type":"integer","maxLength":15,"description":"Código da conta corrente.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno da conta corrente cadastrada no Omie."},"dDtLanc":{"type":"string","maxLength":10,"description":"Data do lançamento na conta corrente.\nNo formato dd/mm/aaaa."},"nValorLanc":{"type":"number","maxLength":18,"description":"Valor do lançamento"}},"description":"Cabeçalho do lançamento do conta corrente"},"detalhes":{"type":"object","properties":{"cCodCateg":{"type":"string","maxLength":20,"description":"Código da categoria.\n(Interno, utilizado apenas na integração via API, não é exibido na tela)."},"aCodCateg":{"type":"array","items":{"type":"object","properties":{"cCodCateg":{"type":"string","maxLength":20,"description":"Código da categoria"},"nValor":{"type":"number","description":"Valor da categoria"},"nPerc":{"type":"number","description":"Percentual da categoria"}}}},"cTipo":{"type":"string","maxLength":5,"description":"Tipo de documento.\nPode ser:\nADI - Adiantamento\nBOL - Boleto\nCRT - Cartão\nCHQ - Cheque\nCON - Convênios\nCRE - Crediário\nDRF - DARF\nDAS - DAS\nDEB - Débito em conta\nDIN - Dinheiro\nDOC - DOC\nGUIA - Guia de Recolhimento\nPROT - Protesto\nREC - Recibo\nRPA - RPA\nTED - TED\nTRA - Transferência\n99999 - Outros"},"cNumDoc":{"type":"string","maxLength":20,"description":"Número do Documento."},"nCodCliente":{"type":"integer","maxLength":15,"description":"Código de Cliente / Favorecido.\n(Gerado internamente, não é visualizado na tela)"},"nCodProjeto":{"type":"integer","maxLength":15,"description":"Código do projeto.\n(Gerado internamente, não é visualizado na tela)"},"cObs":{"type":"string","description":"Observações."}},"description":"Detalhes do lançamento do conta corrente."},"transferencia":{"type":"object","properties":{"nCodCCDestino":{"type":"integer","maxLength":15,"description":"Código da conta corrente de destino.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno da conta corrente cadastrada no Omie."}},"description":"Dados da transferência do lançamento do conta corrente"},"departamentos":{"type":"array","items":{"type":"object","properties":{"cCodDep":{"type":"string","maxLength":40,"description":"Código do departamento.\n(Gerado internamente, não é visualizado na tela)"},"nValDep":{"type":"number","maxLength":18,"description":"Valor do departamento"},"nPerDep":{"type":"number","maxLength":10,"description":"Percentual do departamento"}}},"description":"Distribuição por departamento do lançamento do conta corrente"}}}}},"example":{"call":"IncluirLancCC","param":[{"cCodIntLanc":"1790776553","cabecalho":{"nCodCC":427619317,"dDtLanc":"30/09/2026","nValorLanc":123.46},"detalhes":{"cCodCateg":"1.01.02","cTipo":"DIN","nCodCliente":2485994,"cObs":"Referente a jardinagem executada na matriz"}}]}},"financas_contacorrentelancamentos_IncluirLancCC_retorno":{"type":"object","properties":{"nCodLanc":{"type":"integer","description":"Código do lançamento da conta corrente. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do lançamento da conta corrente gerado pelo Omie."},"cCodIntLanc":{"type":"string","description":"Código interno do lançamento da conta corrente. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código interno do lançamento da conta corrente utilizado no seu aplicativo quando incluir um lançamento no Omie."},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro durante o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodigoStatus\"."}},"title":"IncluirLancCC (retorno)"},"financas_contacorrentelancamentos_ListarLancCC":{"type":"object","title":"ListarLancCC","description":"Lista os lançamentos de conta corrente","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarLancCC"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página que se deseja resgatar.\nO padrão é \"1\"."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Número de registros retornados por página.\nO padrão é 20.\nO limite máximo é 50 por página."},"cOrdenarPor":{"type":"string","maxLength":100,"description":"Ordem de exibição dos dados. Padrão: Código."},"cOrdemDecrescente":{"type":"string","maxLength":1,"description":"Indica se a ordem de exibição é decrescente caso seja informado \"S\"."},"cOrigem":{"type":"string","maxLength":4,"description":"Origem do lançamento\n\nPode ser:\n\nDEVP  - Conta a pagar da devolução de venda\nDEVR - Conta a receber da devolução ao fornecedor\nEXTP - Lançamento manual de despesa\nEXTR - Lançamento manual de receita\nIMPP - Parcela a pagar de uma nota de importação\nMANP - Lançamento manual de conta a pagar\nMANR - Lançamento manual de conta a receber\nNFEP - Conta a pagar importada de uma NF-e\nNFER - Conta a receber importada de uma NF-e\nOFXP- Pagamento importado de um arquivo OFX\nOFXR - Recebimento importado de um arquivo OFX\nRPTP - Repetição de contas a pagar\nRPTR - Repetição de contas a receber\nTRAP - Débito de transferência entre contas correntes\nTRAR - Crédito de transferência entre contas correntes\nVENR - Parcela a receber de vendas\nXMLP - Conta a pagar importada de um arquivo XML\nXMLR - Conta a receber importada de um arquivo XML"},"dDtIncDe":{"type":"string","maxLength":10,"description":"Data de inclusão inicial.\nNo formato dd/mm/aaaa."},"dDtIncAte":{"type":"string","maxLength":10,"description":"Data de inclusão final.\nNo formato dd/mm/aaaa."},"dDtAltDe":{"type":"string","maxLength":10,"description":"Data de alteração inicial.\nNo formato dd/mm/aaaa."},"dDtAltAte":{"type":"string","maxLength":10,"description":"Data de alteração final.\nNo formato dd/mm/aaaa."},"dtPagInicial":{"type":"string","maxLength":10,"description":"Filtra os registros a partir da data"},"dtPagFinal":{"type":"string","maxLength":10,"description":"Filtra os registros até a data especificada"}}}}},"example":{"call":"ListarLancCC","param":[{"nPagina":1,"nRegPorPagina":20}]}},"financas_contacorrentelancamentos_ListarLancCC_retorno":{"type":"object","properties":{"nPagina":{"type":"integer","description":"Número da página resgatada."},"nTotPaginas":{"type":"integer","description":"Número total de páginas encontradas."},"nRegistros":{"type":"integer","description":"Número de registros retornados na página."},"nTotRegistros":{"type":"integer","description":"Número total de registros encontrados."},"listaLancamentos":{"type":"array","items":{"type":"object","properties":{"nCodLanc":{"type":"integer","description":"Código do lançamento da conta corrente. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do lançamento da conta corrente gerado pelo Omie."},"cCodIntLanc":{"type":"string","description":"Código do lançamento da conta corrente. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o lançamento da conta corrente utilizado no seu aplicativo quando incluir um Lançamento no Omie."},"nCodAgrup":{"type":"integer","description":"Código do agrupamento do lançamento de conta corrente."},"cabecalho":{"type":"object","properties":{"nCodCC":{"type":"integer","description":"Código da conta corrente. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da conta corrente cadastrada no Omie."},"dDtLanc":{"type":"string","description":"Data do lançamento na conta corrente. No formato dd/mm/aaaa."},"nValorLanc":{"type":"decimal","description":"Valor do lançamento"}},"description":"Cabeçalho do lançamento do conta corrente"},"detalhes":{"type":"object","properties":{"cCodCateg":{"type":"string","description":"Código da categoria. (Interno, utilizado apenas na integração via API, não é exibido na tela)."},"aCodCateg":{"type":"array","items":{"type":"object","properties":{"cCodCateg":{"type":"string","description":"Código da categoria"},"nValor":{"type":"decimal","description":"Valor da categoria"},"nPerc":{"type":"decimal","description":"Percentual da categoria"}}}},"cTipo":{"type":"string","description":"Tipo de documento. Pode ser: ADI - Adiantamento BOL - Boleto CRT - Cartão CHQ - Cheque CON - Convênios CRE - Crediário DRF - DARF DAS - DAS DEB - Débito em conta DIN - Dinheiro DOC - DOC GUIA - Guia de Recolhimento PROT - Protesto REC - Recibo RPA - RPA TED - TED TRA - Transferência 99999 - Outros"},"cNumDoc":{"type":"string","description":"Número do Documento."},"nCodCliente":{"type":"integer","description":"Código de Cliente / Favorecido. (Gerado internamente, não é visualizado na tela)"},"nCodProjeto":{"type":"integer","description":"Código do projeto. (Gerado internamente, não é visualizado na tela)"},"cObs":{"type":"string","description":"Observações."}},"description":"Detalhes do lançamento do conta corrente."},"transferencia":{"type":"object","properties":{"nCodCCDestino":{"type":"integer","description":"Código da conta corrente de destino. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da conta corrente cadastrada no Omie."}},"description":"Dados da transferência do lançamento do conta corrente"},"departamentos":{"type":"array","items":{"type":"object","properties":{"cCodDep":{"type":"string","description":"Código do departamento. (Gerado internamente, não é visualizado na tela)"},"nValDep":{"type":"decimal","description":"Valor do departamento"},"nPerDep":{"type":"decimal","description":"Percentual do departamento"}}},"description":"Distribuição por departamento do lançamento do conta corrente"},"diversos":{"type":"object","properties":{"cOrigem":{"type":"string","description":"Origem do lançamento Pode ser: DEVP - Conta a pagar da devolução de venda DEVR - Conta a receber da devolução ao fornecedor EXTP - Lançamento manual de despesa EXTR - Lançamento manual de receita IMPP - Parcela a pagar de uma nota de importação MANP - Lançamento manual de conta a pagar MANR - Lançamento manual de conta a receber NFEP - Conta a pagar importada de uma NF-e NFER - Conta a receber importada de uma NF-e OFXP- Pagamento importado de um arquivo OFX OFXR - Recebimento importado de um arquivo OFX RPTP - Repetição de contas a pagar RPTR - Repetição de contas a receber TRAP - Débito de transferência entre contas correntes TRAR - Crédito de transferência entre contas correntes VENR - Parcela a receber de vendas XMLP - Conta a pagar importada de um arquivo XML XMLR - Conta a receber importada de um arquivo XML"},"dDtConc":{"type":"string","description":"Data da conciliação do lançamento na conta corrente No formato dd/mm/aaaa."},"cHrConc":{"type":"string","description":"Hora da conciliação do lançamento na conta corrente"},"cUsConc":{"type":"string","description":"Código do usuário responsável pela conciliação"},"nCodVendedor":{"type":"integer","description":"Código do vendedor. (Gerado internamente, não é visualizado na tela)"},"nCodComprador":{"type":"integer","description":"Código do comprador. (Gerado internamente, não é visualizado na tela)"},"cNatureza":{"type":"string","description":"Natureza do lançamento. Pode ser: P - Contas a pagar R - Contas a receber"},"cIdentLanc":{"type":"string","description":"Identificação do lançamento do extrato importado"},"nCodLancCP":{"type":"integer","description":"Código do lançamento de contas a pagar que gerou o lançamento de conta corrente"},"nCodLancCR":{"type":"integer","description":"Código do lançamento de contas a receber que gerou o lançamento de conta corrente"}},"description":"Outras informações."},"info":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão. No formato dd/mm/aaaa."},"hInc":{"type":"string","description":"Hora da Inclusão. No formato hh:mm:ss."},"uInc":{"type":"string","description":"Usuário da Inclusão."},"dAlt":{"type":"string","description":"Data da Alteração. No formato dd/mm/aaaa."},"hAlt":{"type":"string","description":"Hora da Alteração. No formato hh:mm:ss."},"uAlt":{"type":"string","description":"Usuário da Alteração."},"cImpAPI":{"type":"string","description":"Importado pela API (S/N)."}},"description":"Informações do cadastro."}}},"description":"Lista de lançamentos de conta corrente."}},"title":"ListarLancCC (retorno)"},"financas_contapagarbarras_IncluirContaPagarCodBar":{"type":"object","title":"IncluirContaPagarCodBar","description":"Inclui uma conta a Pagar a partir de um Código de Barras.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirContaPagarCodBar"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cCodigoBarras":{"type":"string","maxLength":70,"description":"Código de barras ou linha digitável do boleto."},"nIdFornecedor":{"type":"integer","maxLength":15,"description":"ID do Fornecedor / Favorecido.\n\n\nUtilize a tag \"codigo_cliente_omie\" do método \"ListarClientes\" da API\nhttp://app.omie.com.br/api/v1/geral/clientes/\npara obter essa informação."},"cCpfCnpj":{"type":"string","maxLength":60,"description":"CNPJ / CPF do Fornecedor / Favorecido.\nUtilizado como identificação do Fornecedor.\n\nPreechimento Obrigatório caso a tag \"nIdFornecedor\"  não seja informada."},"dVencimento":{"type":"string","maxLength":10,"description":"Data de vencimento, no formato dd/mm/aaaa.\n\nSe não informada, assume o vencimento lido do código de barras; sem código de barras, é obrigatória."},"dPrevisao":{"type":"string","maxLength":10,"description":"Data da previsão de pagamento, no formato dd/mm/aaaa.\n\nSe não informada, assume a data de hoje."},"vDocumento":{"type":"number","maxLength":18,"description":"Valor da conta.\n\nSe não informado, assume o valor lido do código de barras; sem código de barras, é obrigatório."},"cCodCateg":{"type":"string","maxLength":20,"description":"Código da categoria (despesa).\n\nSe não informado, assume a categoria padrão do fornecedor; sem padrão, a chamada é recusada pedindo a categoria.\n\nUtilize a tag \"codigo\" do método \"ListarCategorias\" da API\nhttp://app.omie.com.br/api/v1/geral/categorias/\npara obter essa informação."},"nIdConta":{"type":"integer","maxLength":15,"description":"Código da conta corrente.\n\nSe não informado, assume a conta padrão do fornecedor; sem padrão, a chamada é recusada pedindo a conta.\nCom lBaixarDocumento true, é também a conta em que o pagamento é registrado (conta do Omie.CASH é recusada).\n\nUtilize a tag \"codigo\" do método \"PesquisarContaCorrente\" da API\nhttp://app.omie.com.br/api/v1/geral/contacorrente/\npara obter essa informação."},"cDocumento":{"type":"string","maxLength":20,"description":"Número do documento.\n\nAtenção: hoje este campo não é gravado (a função lê outra tag). O número do documento do lançamento fica com o nosso número lido do código de barras."},"cObservacao":{"type":"string","description":"Observações.\n\nUtilize o carater ( | ) pipe como separador de linhas.\n\nInformação localizada na Aba \"Detalhes\" do Contas a Pagar."},"lBaixarDocumento":{"type":"boolean","description":"true registra o pagamento logo após lançar a conta, com a data de hoje, o valor total e a conta corrente do lançamento.\n\nPadrão false. Use só quando o boleto já tiver sido pago."}},"required":["dVencimento","vDocumento"]}}},"example":{"call":"IncluirContaPagarCodBar","param":[{"cCodigoBarras":"","nIdFornecedor":0,"cCpfCnpj":"","dVencimento":"#TODAY#","dPrevisao":"#TODAY#","vDocumento":0,"cCodCateg":"2.04.01","nIdConta":0,"cDocumento":"","cObservacao":"","lBaixarDocumento":false}]}},"financas_contapagarbarras_IncluirContaPagarCodBar_retorno":{"type":"object","properties":{"nIdTitulo":{"type":"integer","description":"ID do lançamento de Contas a Pagar. O conteúdo desse campo é o código interno gerado pelo Omie ao cadastrar o lançamento. Esse campo não é exibido na tela do Contas a Pagar mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs."},"codigo_status":{"type":"string","description":"Código do status do processamento. \"0\" indica sucesso."},"descricao_status":{"type":"string","description":"Descrição do status do processamento."}},"title":"IncluirContaPagarCodBar (retorno)"},"financas_contapagar_AlterarContaPagar":{"type":"object","title":"AlterarContaPagar","description":"Altera uma conta a pagar","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarContaPagar"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_lancamento_omie":{"type":"integer","maxLength":15,"description":"Código do Lançamento de Contas a Pagar.\nInforme esse campo somente para pesquisa.\n\nEsse campo não é exibido na tela do Contas a Pagar mas é a chave de integração via API.\nÉ uma informação interna, utilizada apenas nas APIs."},"codigo_lancamento_integracao":{"type":"string","maxLength":60,"description":"Código de Integração do Lançamento de Contas a Pagar.\n\nPreencha esse campo com o código do lançamento do Contas a Pagar no aplicativo que você está integração com o Omie.\nA função dele é servir como uma mapa de relacionamento entre as aplicações.\nAo realizar uma consulta/listagem de Contas a Pagar você conseguirá ver a relação entre o id do Contas a Pagar gerado no Omie e o código do Contas a Pagar existente em sua aplicação."},"codigo_cliente_fornecedor":{"type":"integer","maxLength":15,"description":"Código do Favorecido / Fornecedor.\n\nUtilize a tag \"codigo_cliente_omie\" do método \"ListarClientes\" da API\nhttp://app.omie.com.br/api/v1/geral/clientes/\npara obter essa informação."},"codigo_cliente_fornecedor_integracao":{"type":"string","maxLength":60,"description":"Código de Integração do Favorecido / Fornecedor.\n\nEsse campo deve ser informado apenas se você incluiu o cliente via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag \"codigo_cliente_omie\"."},"data_vencimento":{"type":"string","maxLength":10,"description":"Data de Vencimento.\n\nUtilize o formato \"dd/mm/aaaa\".\n\nEsse campo indica a data da vencimento do título e deve ser informado com uma data igual ou superior a data corrente."},"valor_documento":{"type":"number","maxLength":18,"description":"Valor da Conta."},"codigo_categoria":{"type":"string","maxLength":20,"description":"Código da Categoria.\n\nCaso não preenchido, assumirá a categoria padrão para o fornecedor informado. Caso não hajá um específico, retornará erro até que um código de categoria válido seja informado.\n\nUtilize a tag \"codigo\" do método \"ListarCategorias\" da API\nhttp://app.omie.com.br/api/v1/geral/categorias/\npara obter essa informação."},"categorias":{"type":"array","items":{"type":"object","properties":{"codigo_categoria":{"type":"string","maxLength":20},"valor":{"type":"number","maxLength":18},"percentual":{"type":"number","maxLength":10,"description":"Percentual da categoria"}}}},"data_previsao":{"type":"string","maxLength":10,"description":"Data da Previsão de Pagamento.\n\nUtilize o formato \"dd/mm/aaaa\".\n\nCaso não informado, assumirá a data de vencimento informada.\n\nEsse campo indica a data da previsão do título e deve ser informado com uma data igual ou superior a data corrente."},"id_conta_corrente":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente.\n\nCaso não informado, assumirá o padrão para o fornecedor. Caso não haja um padrão definido, retornará erro até que uma Conta Corrente válida seja informada.\n\nUtilize a tag \"codigo\" do método \"PesquisarContaCorrente\" da API\nhttp://app.omie.com.br/api/v1/geral/contacorrente/\npara obter essa informação."},"numero_documento_fiscal":{"type":"string","maxLength":20,"description":"Número da Nota Fiscal associada ao lançamento de Contas a Pagar.\n\nInformação localizada na Aba \"Detalhes\" do Contas a Pagar."},"data_emissao":{"type":"string","maxLength":10,"description":"Data de Emissão.\n\nCaso não informado, assumirá a data corrente.\n\nInformação localizada na Aba \"Detalhes\" do Contas a Pagar."},"data_entrada":{"type":"string","maxLength":10,"description":"Data de Registro.\n\nCaso não informado, assumirá a data corrente.\n\nInformação localizada na Aba \"Detalhes\" do Contas a Pagar."},"codigo_projeto":{"type":"integer","maxLength":15,"description":"Código do Projeto.\n\nInformação localizada na Aba \"Detalhes\" do Contas a Pagar.\n\nUtilize a tag \"codigo\" do método \"ListarProjetos\" da API\nhttp://app.omie.com.br/api/v1/geral/projetos/\npara obter essa informação."},"observacao":{"type":"string","description":"Observações.\n\nUtilize o carater ( | ) pipe como separador de linhas.\n\nInformação localizada na Aba \"Detalhes\" do Contas a Pagar."},"valor_pis":{"type":"number","maxLength":18,"description":"Valor PIS.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_pis":{"type":"string","maxLength":1,"description":"Reter PIS.\n\nInformar \"S\" ou \"N\".\n\nSe não informado, será assumido \"N\" por padrão.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_cofins":{"type":"number","maxLength":18,"description":"Valor COFINS.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_cofins":{"type":"string","maxLength":1,"description":"Reter COFINS.\n\nInformar \"S\" ou \"N\".\n\nSe não informado, será assumido \"N\" por padrão.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_csll":{"type":"number","maxLength":18,"description":"Valor CSLL.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_csll":{"type":"string","maxLength":1,"description":"Reter CSLL.\n\nInformar \"S\" ou \"N\".\n\nSe não informado, será assumido \"N\" por padrão.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_ir":{"type":"number","maxLength":18,"description":"Valor IR.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_ir":{"type":"string","maxLength":1,"description":"Reter IR.\n\nInformar \"S\" ou \"N\".\n\nSe não informado, será assumido \"N\" por padrão.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_iss":{"type":"number","maxLength":18,"description":"Valor ISS.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_iss":{"type":"string","maxLength":1,"description":"Reter ISS.\n\nInformar \"S\" ou \"N\".\n\nSe não informado, será assumido \"N\" por padrão.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_inss":{"type":"number","maxLength":18,"description":"Valor INSS.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_inss":{"type":"string","maxLength":1,"description":"Reter INSS.\n\nInformar \"S\" ou \"N\".\n\nSe não informado, será assumido \"N\" por padrão.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"distribuicao":{"type":"array","items":{"type":"object","properties":{"cCodDep":{"type":"string","maxLength":40,"description":"Código do Departamento"},"cDesDep":{"type":"string","maxLength":50,"description":"Descrição do Departamento"},"nValDep":{"type":"number","maxLength":18,"description":"Valor do rateio"},"nPerDep":{"type":"number","maxLength":10,"description":"Percentual do rateio"}}},"description":"Distribuição por Departamentos."},"numero_pedido":{"type":"string","maxLength":15,"description":"Número do Pedido.\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar."},"codigo_tipo_documento":{"type":"string","maxLength":5,"description":"Código do Tipo de Documento.\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar."},"numero_documento":{"type":"string","maxLength":20,"description":"Número do Documento.\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar."},"numero_parcela":{"type":"string","maxLength":7,"description":"Número da parcela.\n\nUtilizar o formato \"999/999\".\n\nPara 1 parcela utilize \"001/001\"\n\nSe não informado assumirá o valor \"001/001\".\nInformação localizada na Aba \"Diversos\" do Contas a Pagar."},"chave_nfe":{"type":"string","maxLength":44,"description":"Chave da NF.e.\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar."},"codigo_barras_ficha_compensacao":{"type":"string","maxLength":70,"description":"Código de Barras\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar."},"codigo_vendedor":{"type":"integer","maxLength":15,"description":"Código do Vendedor.\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar.\n\nUtilize a tag \"codigo\" do método \"ListarVendedores\" da API\nhttp://app.omie.com.br/api/v1/geral/vendedores/\npara obter essa informação."},"id_origem":{"type":"string","maxLength":4,"description":"Código da Origem.\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar.\n\nOs valores disponíveis são:\n\n\"APIP\" - Integração de Conta a Pagar\n\"BARP\" - Conta a Pagar Importada por Código de Barras\n\"COMP\" - Parcela a Pagar de Compras\n\"CTEP\" - Parcela a Pagar de um CT-e\n\"DEVP\" - Conta a Pagar da Devolução de Venda\n\"IMPP\" - Parcela a Pagar de uma Nota de Importação\n\"MANP\" - Lançamento Manual de Conta a Pagar\n\"NFEP\" - Conta a Pagar Importada de uma NF-e\n\"RPTP\" - Repetição de Contas a Pagar\n\"XMLP\" - Conta a Pagar Importada de um arquivo XML"},"info":{"type":"object","properties":{"dInc":{"type":"string","maxLength":10,"description":"Data da Inclusão.\nNo formato dd/mm/aaaa.\n\nNão deve ser informado na Inclusão/Alteração."},"hInc":{"type":"string","maxLength":8,"description":"Hora da Inclusão.\nNo formato hh:mm:ss.\n\nNão deve ser informado na Inclusão/Alteração."},"uInc":{"type":"string","maxLength":10,"description":"Usuário da Inclusão.\n\nNão deve ser informado na Inclusão/Alteração."},"dAlt":{"type":"string","maxLength":10,"description":"Data da Alteração.\nNo formato dd/mm/aaaa.\n\nNão deve ser informado na Inclusão/Alteração."},"hAlt":{"type":"string","maxLength":8,"description":"Hora da Alteração.\nNo formato hh:mm:ss.\n\nNão deve ser informado na Inclusão/Alteração."},"uAlt":{"type":"string","maxLength":10,"description":"Usuário da Alteração.\n\nNão deve ser informado na Inclusão/Alteração."},"cImpAPI":{"type":"string","maxLength":1,"description":"Importado pela API (S/N).\n\nNão deve ser informado na Inclusão/Alteração."}},"description":"Informações complemetares do cadastro do produto."},"operacao":{"type":"string","maxLength":2,"description":"Código da Operação. .\n\nEsse campo indica qual tipo de operação está associada ao lançamento de Contas a Pagar.\n\nOs valores disponíveis são:\n\n\"01\" - Venda de Serviço\n\"11\" - Venda de Produto\n\"12\" - Venda de Produto pelo PDV\n\"13\" - Devolução de Venda\n\"14\" - Remessa de Produto\n\"16\" - Nota Complementar de Saída"},"status_titulo":{"type":"string","maxLength":3,"description":"Status do Título.\n\nEssa informação é retornada na consulta/pesquisa dos lançamentos de Contas a Pagar."},"nsu":{"type":"string","maxLength":100,"description":"DEPRECATED."},"acao":{"deprecated":true,"type":"string","description":"DEPRECATED"},"id_conta_corrente_integracao":{"deprecated":true,"type":"string","maxLength":20,"description":"DEPRECATED"},"bloqueado":{"deprecated":true,"type":"string","maxLength":1,"description":"DEPRECATED"},"baixa_bloqueada":{"deprecated":true,"type":"string","maxLength":1,"description":"DEPRECATED"},"codigo_cmc7_cheque":{"deprecated":true,"type":"string","maxLength":40,"description":"DEPRECATED"},"importado_api":{"deprecated":true,"type":"string","maxLength":1,"description":"DEPRECATED"},"bloquear_exclusao":{"type":"string","maxLength":1,"description":"Bloqueia a exclusão do registro. (S/N)"},"cnab_integracao_bancaria":{"type":"object","properties":{"codigo_forma_pagamento":{"type":"string","maxLength":3,"description":"Código da Forma de Pagamento.\n\n\nPode ser:\n\nTRA - Transferência Bancária.\nBOL - Pagamento de Boleto.\nPIX - Transferência via PIX por QR Code."},"banco_transferencia":{"type":"string","maxLength":3,"description":"Código do Banco para Transferência Bancária."},"agencia_transferencia":{"type":"string","maxLength":10,"description":"Número da Agência para Transferência Bancária."},"conta_corrente_transferencia":{"type":"string","maxLength":25,"description":"Número da Conta Corrente para Transferência Bancária."},"finalidade_transferencia":{"type":"string","maxLength":10,"description":"Finalidade da transferência.\n\n\nVerificar código da Finalidade de acordo com o banco vinculado ao cadastro da conta corrente informada na tag [\"id_conta_corrente\"]\n\nPode ser:\n00001 - Pagamento de Impostos, Tributos e Taxas\n00002 - Pagamento a Concessionárias de Serviço Público\n00003 - Pagamento de Dividendos\n00004 - Pagamento de Salários\n00005 - Pagamento de Fornecedores\n00006 - Pagamento de Honorários\n00007 - Pagamento de Aluguéis e Taxas e Condomínio\n00008 - Pagamento de Duplicatas e Títulos\n00009 - Pagamento de Honorários\n00010 - Crédito em Conta\n00011 - Pagamento a Corretoras\n00016 - Crédito em Conta Investimento\n00100 - Depósito Judicial\n00101 - Pensão Alimentícia\n00200 - Transferência Internacional de Reais\n00201 - Ajuste Posição Mercado Futuro\n00202 - Repasse de valores do BNDES\n00203 - Liquidação de compromisso com BNDES\n00204 - Compra/Venda de Ações - Bolsas de Valores e Mercado de Balcão\n00205 - Contrato referenciado em Ações/Índices de Ações - BV/BMF\n00300 - Restituição de Imposto de Renda\n00500 - Restitiuição de Prêmio de Seguros\n00501 - Pagamento de indenização de Sinistro de Seguro\n00502 - Pagamento de Prêmio de Co-seguro\n00503 - Restituição de prêmio de Co-seguro\n00504 - Pagamento de indenização de Co-seguro\n00505 - Pagamento de prêmio de Resseguro\n00506 - Restituição de prêmio de Resseguro\n00507 - Pagamento de Indenização de Sinistro de Resseguro\n00508 - Restituição de Indenização de Sinistro de Resseguro\n00509 - Pagamento de Despesas com Sinistros\n00510 - Pagamento de Inspeções/Vistorias Prévias\n00511 - Pagamento de Resgate de Título de Capitalização\n00512 - Pagamento de Sorteio de Título de Capitalização\n00513 - Pagamento de Devolução de Mensalidade de Título de Capitalização\n00514 - Restituição de Contribuição de Plano Previdenciário\n00515 - Pagamento de Benefício Previdenciário de Pecúlio\n00516 - Pagamento de Benefício Previdenciário de Pensão\n00517 - Pagamento de Benefício Previdenciário de Aposentadoria\n00518 - Pagamento de Resgate Previdenciário\n00519 - Pagamento de Comissão de Corretagem\n00520 - Pagamento de Transferências/Portabilidade de Reserva de Seguro/Previdência\n01 - Crédito em Conta\n01 - Crédito em Conta Corrente\n01.3 - Transferência por Chave PIX (Obrigatório informar a chave pix na tag \"pix_qrcode\")\n02 - Pagamento de Aluguel / Condomínio\n03 - Pagamento de Duplicatas e Títulos\n04 - Pagamento de Dividendos\n05 - Pagamento de Mensalidades Escolares\n07 - Pagamento a Fornecedor / Honorários\n08 - Pagamento de Câmbio / Fundos / Bolsas\n09 - Repasse de Arrecadação / Pagamento de Tributos\n11 - DOC / TED para Poupança\n12 - DOC / TED para Depósito Judicial\n13 - Pensão Alimentícia\n14 - Restituição de Imposto de Renda\n99 - Outros\n99999 - Outros"},"cpf_cnpj_transferencia":{"type":"string","maxLength":20,"description":"CNPJ ou CPF do Titular."},"nome_transferencia":{"type":"string","maxLength":60,"description":"Nome do Titular da Conta Corrente."},"codigo_barras_boleto":{"type":"string","maxLength":70,"description":"Código de Barras (de Cobrança Bancária, de Concessionária ou de Impostos)"},"juros_boleto":{"type":"number","maxLength":10,"description":"Percentual de Juros ao Mês do Boleto."},"multa_boleto":{"type":"number","maxLength":10,"description":"Percentual de Multa por Atraso do Boleto."},"pix_qrcode":{"type":"string","maxLength":300,"description":"QR Code do PIX."}},"required":["finalidade_transferencia"],"description":"Dados do CNAB e Integração Bancária."},"servico_tomado":{"type":"object","properties":{"numero_nf":{"type":"string","maxLength":20,"description":"Número da Nota Fiscal."},"serie_nf":{"type":"string","maxLength":20,"description":"Série da Nota Fiscal."},"codigo_servico":{"type":"string","maxLength":10,"description":"Código do serviço (LC116)."},"valor_nf":{"type":"number","maxLength":18,"description":"Valor total da Nota Fiscal."},"cst_pis":{"type":"string","maxLength":2,"description":"CST do PIS (Código da Situação Tributária)."},"base_pis":{"type":"number","maxLength":18,"description":"Base de cálculo do PIS."},"aliquota_pis":{"type":"number","maxLength":18,"description":"Alíquota do PIS (%)."},"valor_pis":{"type":"number","maxLength":18,"description":"Valor do PIS."},"cst_cofins":{"type":"string","maxLength":2,"description":"CST do COFINS (Código da Situação Tributária)."},"base_cofins":{"type":"number","maxLength":18,"description":"Base de cálculo do COFINS."},"aliquota_cofins":{"type":"number","maxLength":18,"description":"Alíquota do COFINS (%)."},"valor_cofins":{"type":"number","maxLength":18,"description":"Valor do PIS."}}},"valor_pag":{"type":"number","maxLength":18,"description":"Valor a pagar.\n\nDisponível apenas para os métodos de consulta e listagem."},"aprendizado_rateio":{"type":"string","maxLength":1,"description":"Aprendizado de rateio de departamento.\n\nPreencher com \"S\" ou \"N\".\n\nDefault \"N\"\n\nQuando essa tag for preenchida com \"S\" será assumido o rateio de departamento para a categoria informada na tag \"codigo_categoria\".\n\nEssa tag é utilizada apenas nos métodos de inclusão e alteração."},"baixar_documento":{"type":"string","maxLength":1,"description":"Efetua a baixa automática do documento."},"conciliar_documento":{"type":"string","maxLength":1,"description":"Efetua a conciliação do documento automaticamente. Opcional.\n\nPreencher com S/N."},"pagamento":{"type":"object","properties":{"codigo_pagamento_integracao":{"type":"string","maxLength":20},"codigo_conta_corrente":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente."},"valor":{"type":"number","maxLength":18,"description":"Valor a ser baixado."},"desconto":{"type":"number","maxLength":18,"description":"Valor do desconto."},"juros":{"type":"number","maxLength":18,"description":"Valor do Juros."},"multa":{"type":"number","maxLength":18,"description":"Valor da multa."},"data":{"type":"string","maxLength":10,"description":"Data da Baixa"},"observacao":{"type":"string","description":"Observação da Baixa do Contas a Receber."}},"description":"Detalhes do pagamento(baixa).\nInforme aqui os detalhes do pagamento do lançamento.\n\nAo preencher esse campo é possível detalhar informações da baixa do documento, como: Valor pago, Desconto, Juros, Multa, etc.\n\nQuando essa tag estiver preenchida é obrigatório o preenchimento da tag \"baixar_documento\" com \"S\"\n\nCaso essa tag não seja preenchida o lançamento será baixado de forma integral de acordo com os valores do lançamento.\n\nEssa tag é utilizada apenas nos métodos de Inclusão e Alteração.\n\nInformação localizada na Aba \"Pagamentos\" no cadastro do lançamento."}},"required":["pagamento"]}}},"example":{"call":"AlterarContaPagar","param":[{"codigo_lancamento_integracao":"1790774898","codigo_cliente_fornecedor":4214850,"data_vencimento":"30/09/2026","valor_documento":100.0,"codigo_categoria":"2.04.01","data_previsao":"30/09/2026","id_conta_corrente":4243124}]}},"financas_contapagar_AlterarContaPagar_retorno":{"type":"object","properties":{"codigo_lancamento_omie":{"type":"integer","description":"Código do Lançamento de Contas a Pagar. Informe esse campo somente para pesquisa. Esse campo não é exibido na tela do Contas a Pagar mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs."},"codigo_lancamento_integracao":{"type":"string","description":"Código de Integração do Lançamento de Contas a Pagar. Preencha esse campo com o código do lançamento do Contas a Pagar no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de Contas a Pagar você conseguirá ver a relação entre o id do Contas a Pagar gerado no Omie e o código do Contas a Pagar existente em sua aplicação."},"codigo_status":{"type":"string","description":"Código do Status de Processamento. Quando retornar 0 (zero) indica que o processamento foi executado com sucesso. Qualquer outro valor maior que 0 (zero) indica que ocorreu uma falha durante o processo de validação dos dados."},"descricao_status":{"type":"string","description":"Descrição do Status de Processamento. Descreve o resultado do processando, de acordo com o código de status retornado."}},"title":"AlterarContaPagar (retorno)"},"financas_contapagar_CancelarPagamento":{"type":"object","title":"CancelarPagamento","description":"Cancela um pagamento realizado no Contas a Pagar","required":["call","param"],"properties":{"call":{"type":"string","enum":["CancelarPagamento"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_baixa":{"type":"integer","maxLength":15,"description":"Código para identificar a baixa do título no Contas a Pagar."},"codigo_baixa_integracao":{"type":"string","maxLength":20,"description":"Código da baixa do integrador para identificar a baixa de um título do contas a pagar."}}}}},"example":{"call":"CancelarPagamento","param":[{"codigo_baixa":0}]}},"financas_contapagar_CancelarPagamento_retorno":{"type":"object","properties":{"codigo_baixa":{"type":"integer","description":"Código para identificar a baixa do título no Contas a Pagar."},"codigo_baixa_integracao":{"type":"string","description":"Código da baixa do integrador para identificar a baixa de um título do contas a pagar."},"codigo_status":{"type":"string","description":"Código do Status da baixa do contas a pagar."},"descricao_status":{"type":"string","description":"Descrição do Status da baixa do contas a pagar."}},"title":"CancelarPagamento (retorno)"},"financas_contapagar_ConsultarContaPagar":{"type":"object","title":"ConsultarContaPagar","description":"Consulta uma conta a pagar","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarContaPagar"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_lancamento_omie":{"type":"integer","maxLength":15,"description":"Código do Lançamento de Contas a Pagar.\nInforme esse campo somente para pesquisa.\n\nEsse campo não é exibido na tela do Contas a Pagar mas é a chave de integração via API.\nÉ uma informação interna, utilizada apenas nas APIs."},"codigo_lancamento_integracao":{"type":"string","maxLength":60,"description":"Código de Integração do Lançamento de Contas a Pagar.\n\nPreencha esse campo com o código do lançamento do Contas a Pagar no aplicativo que você está integração com o Omie.\nA função dele é servir como uma mapa de relacionamento entre as aplicações.\nAo realizar uma consulta/listagem de Contas a Pagar você conseguirá ver a relação entre o id do Contas a Pagar gerado no Omie e o código do Contas a Pagar existente em sua aplicação."}}}}},"example":{"call":"ConsultarContaPagar","param":[{"codigo_lancamento_omie":0,"codigo_lancamento_integracao":""}]}},"financas_contapagar_ConsultarContaPagar_retorno":{"type":"object","properties":{"codigo_lancamento_omie":{"type":"integer","description":"Código do Lançamento de Contas a Pagar. Informe esse campo somente para pesquisa. Esse campo não é exibido na tela do Contas a Pagar mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs."},"codigo_lancamento_integracao":{"type":"string","description":"Código de Integração do Lançamento de Contas a Pagar. Preencha esse campo com o código do lançamento do Contas a Pagar no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de Contas a Pagar você conseguirá ver a relação entre o id do Contas a Pagar gerado no Omie e o código do Contas a Pagar existente em sua aplicação."},"codigo_cliente_fornecedor":{"type":"integer","description":"Código do Favorecido / Fornecedor. Utilize a tag \"codigo_cliente_omie\" do método \"ListarClientes\" da API http://app.omie.com.br/api/v1/geral/clientes/ para obter essa informação."},"codigo_cliente_fornecedor_integracao":{"type":"string","description":"Código de Integração do Favorecido / Fornecedor. Esse campo deve ser informado apenas se você incluiu o cliente via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag \"codigo_cliente_omie\"."},"data_vencimento":{"type":"string","description":"Data de Vencimento. Utilize o formato \"dd/mm/aaaa\". Esse campo indica a data da vencimento do título e deve ser informado com uma data igual ou superior a data corrente."},"valor_documento":{"type":"decimal","description":"Valor da Conta."},"codigo_categoria":{"type":"string","description":"Código da Categoria. Caso não preenchido, assumirá a categoria padrão para o fornecedor informado. Caso não hajá um específico, retornará erro até que um código de categoria válido seja informado. Utilize a tag \"codigo\" do método \"ListarCategorias\" da API http://app.omie.com.br/api/v1/geral/categorias/ para obter essa informação."},"categorias":{"type":"array","items":{"type":"object","properties":{"codigo_categoria":{"type":"string"},"valor":{"type":"decimal"},"percentual":{"type":"decimal","description":"Percentual da categoria"}}}},"data_previsao":{"type":"string","description":"Data da Previsão de Pagamento. Utilize o formato \"dd/mm/aaaa\". Caso não informado, assumirá a data de vencimento informada. Esse campo indica a data da previsão do título e deve ser informado com uma data igual ou superior a data corrente."},"id_conta_corrente":{"type":"integer","description":"Código da Conta Corrente. Caso não informado, assumirá o padrão para o fornecedor. Caso não haja um padrão definido, retornará erro até que uma Conta Corrente válida seja informada. Utilize a tag \"codigo\" do método \"PesquisarContaCorrente\" da API http://app.omie.com.br/api/v1/geral/contacorrente/ para obter essa informação."},"numero_documento_fiscal":{"type":"string","description":"Número da Nota Fiscal associada ao lançamento de Contas a Pagar. Informação localizada na Aba \"Detalhes\" do Contas a Pagar."},"data_emissao":{"type":"string","description":"Data de Emissão. Caso não informado, assumirá a data corrente. Informação localizada na Aba \"Detalhes\" do Contas a Pagar."},"data_entrada":{"type":"string","description":"Data de Registro. Caso não informado, assumirá a data corrente. Informação localizada na Aba \"Detalhes\" do Contas a Pagar."},"codigo_projeto":{"type":"integer","description":"Código do Projeto. Informação localizada na Aba \"Detalhes\" do Contas a Pagar. Utilize a tag \"codigo\" do método \"ListarProjetos\" da API http://app.omie.com.br/api/v1/geral/projetos/ para obter essa informação."},"observacao":{"type":"string","description":"Observações. Utilize o carater ( | ) pipe como separador de linhas. Informação localizada na Aba \"Detalhes\" do Contas a Pagar."},"valor_pis":{"type":"decimal","description":"Valor PIS. Informação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_pis":{"type":"string","description":"Reter PIS. Informar \"S\" ou \"N\". Se não informado, será assumido \"N\" por padrão. Informação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_cofins":{"type":"decimal","description":"Valor COFINS. Informação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_cofins":{"type":"string","description":"Reter COFINS. Informar \"S\" ou \"N\". Se não informado, será assumido \"N\" por padrão. Informação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_csll":{"type":"decimal","description":"Valor CSLL. Informação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_csll":{"type":"string","description":"Reter CSLL. Informar \"S\" ou \"N\". Se não informado, será assumido \"N\" por padrão. Informação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_ir":{"type":"decimal","description":"Valor IR. Informação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_ir":{"type":"string","description":"Reter IR. Informar \"S\" ou \"N\". Se não informado, será assumido \"N\" por padrão. Informação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_iss":{"type":"decimal","description":"Valor ISS. Informação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_iss":{"type":"string","description":"Reter ISS. Informar \"S\" ou \"N\". Se não informado, será assumido \"N\" por padrão. Informação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_inss":{"type":"decimal","description":"Valor INSS. Informação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_inss":{"type":"string","description":"Reter INSS. Informar \"S\" ou \"N\". Se não informado, será assumido \"N\" por padrão. Informação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"distribuicao":{"type":"array","items":{"type":"object","properties":{"cCodDep":{"type":"string","description":"Código do Departamento"},"cDesDep":{"type":"string","description":"Descrição do Departamento"},"nValDep":{"type":"decimal","description":"Valor do rateio"},"nPerDep":{"type":"decimal","description":"Percentual do rateio"}}},"description":"Distribuição por Departamentos."},"numero_pedido":{"type":"string","description":"Número do Pedido. Informação localizada na Aba \"Diversos\" do Contas a Pagar."},"codigo_tipo_documento":{"type":"string","description":"Código do Tipo de Documento. Informação localizada na Aba \"Diversos\" do Contas a Pagar."},"numero_documento":{"type":"string","description":"Número do Documento. Informação localizada na Aba \"Diversos\" do Contas a Pagar."},"numero_parcela":{"type":"string","description":"Número da parcela. Utilizar o formato \"999/999\". Para 1 parcela utilize \"001/001\" Se não informado assumirá o valor \"001/001\". Informação localizada na Aba \"Diversos\" do Contas a Pagar."},"chave_nfe":{"type":"string","description":"Chave da NF.e. Informação localizada na Aba \"Diversos\" do Contas a Pagar."},"codigo_barras_ficha_compensacao":{"type":"string","description":"Código de Barras Informação localizada na Aba \"Diversos\" do Contas a Pagar."},"codigo_vendedor":{"type":"integer","description":"Código do Vendedor. Informação localizada na Aba \"Diversos\" do Contas a Pagar. Utilize a tag \"codigo\" do método \"ListarVendedores\" da API http://app.omie.com.br/api/v1/geral/vendedores/ para obter essa informação."},"id_origem":{"type":"string","description":"Código da Origem. Informação localizada na Aba \"Diversos\" do Contas a Pagar. Os valores disponíveis são: \"APIP\" - Integração de Conta a Pagar \"BARP\" - Conta a Pagar Importada por Código de Barras \"COMP\" - Parcela a Pagar de Compras \"CTEP\" - Parcela a Pagar de um CT-e \"DEVP\" - Conta a Pagar da Devolução de Venda \"IMPP\" - Parcela a Pagar de uma Nota de Importação \"MANP\" - Lançamento Manual de Conta a Pagar \"NFEP\" - Conta a Pagar Importada de uma NF-e \"RPTP\" - Repetição de Contas a Pagar \"XMLP\" - Conta a Pagar Importada de um arquivo XML"},"info":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração."},"hInc":{"type":"string","description":"Hora da Inclusão. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração."},"uInc":{"type":"string","description":"Usuário da Inclusão. Não deve ser informado na Inclusão/Alteração."},"dAlt":{"type":"string","description":"Data da Alteração. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração."},"hAlt":{"type":"string","description":"Hora da Alteração. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração."},"uAlt":{"type":"string","description":"Usuário da Alteração. Não deve ser informado na Inclusão/Alteração."},"cImpAPI":{"type":"string","description":"Importado pela API (S/N). Não deve ser informado na Inclusão/Alteração."}},"description":"Informações complemetares do cadastro do produto."},"operacao":{"type":"string","description":"Código da Operação. . Esse campo indica qual tipo de operação está associada ao lançamento de Contas a Pagar. Os valores disponíveis são: \"01\" - Venda de Serviço \"11\" - Venda de Produto \"12\" - Venda de Produto pelo PDV \"13\" - Devolução de Venda \"14\" - Remessa de Produto \"16\" - Nota Complementar de Saída"},"status_titulo":{"type":"string","description":"Status do Título. Essa informação é retornada na consulta/pesquisa dos lançamentos de Contas a Pagar."},"nsu":{"type":"string","description":"DEPRECATED."},"acao":{"type":"string","description":"DEPRECATED"},"id_conta_corrente_integracao":{"type":"string","description":"DEPRECATED"},"bloqueado":{"type":"string","description":"DEPRECATED"},"baixa_bloqueada":{"type":"string","description":"DEPRECATED"},"codigo_cmc7_cheque":{"type":"string","description":"DEPRECATED"},"importado_api":{"type":"string","description":"DEPRECATED"},"bloquear_exclusao":{"type":"string","description":"Bloqueia a exclusão do registro. (S/N)"},"cnab_integracao_bancaria":{"type":"object","properties":{"codigo_forma_pagamento":{"type":"string","description":"Código da Forma de Pagamento. Pode ser: TRA - Transferência Bancária. BOL - Pagamento de Boleto. PIX - Transferência via PIX por QR Code."},"banco_transferencia":{"type":"string","description":"Código do Banco para Transferência Bancária."},"agencia_transferencia":{"type":"string","description":"Número da Agência para Transferência Bancária."},"conta_corrente_transferencia":{"type":"string","description":"Número da Conta Corrente para Transferência Bancária."},"finalidade_transferencia":{"type":"string","description":"Finalidade da transferência. Verificar código da Finalidade de acordo com o banco vinculado ao cadastro da conta corrente informada na tag [\"id_conta_corrente\"] Pode ser: 00001 - Pagamento de Impostos, Tributos e Taxas 00002 - Pagamento a Concessionárias de Serviço Público 00003 - Pagamento de Dividendos 00004 - Pagamento de Salários 00005 - Pagamento de Fornecedores 00006 - Pagamento de Honorários 00007 - Pagamento de Aluguéis e Taxas e Condomínio 00008 - Pagamento de Duplicatas e Títulos 00009 - Pagamento de Honorários 00010 - Crédito em Conta 00011 - Pagamento a Corretoras 00016 - Crédito em Conta Investimento 00100 - Depósito Judicial 00101 - Pensão Alimentícia 00200 - Transferência Internacional de Reais 00201 - Ajuste Posição Mercado Futuro 00202 - Repasse de valores do BNDES 00203 - Liquidação de compromisso com BNDES 00204 - Compra/Venda de Ações - Bolsas de Valores e Mercado de Balcão 00205 - Contrato referenciado em Ações/Índices de Ações - BV/BMF 00300 - Restituição de Imposto de Renda 00500 - Restitiuição de Prêmio de Seguros 00501 - Pagamento de indenização de Sinistro de Seguro 00502 - Pagamento de Prêmio de Co-seguro 00503 - Restituição de prêmio de Co-seguro 00504 - Pagamento de indenização de Co-seguro 00505 - Pagamento de prêmio de Resseguro 00506 - Restituição de prêmio de Resseguro 00507 - Pagamento de Indenização de Sinistro de Resseguro 00508 - Restituição de Indenização de Sinistro de Resseguro 00509 - Pagamento de Despesas com Sinistros 00510 - Pagamento de Inspeções/Vistorias Prévias 00511 - Pagamento de Resgate de Título de Capitalização 00512 - Pagamento de Sorteio de Título de Capitalização 00513 - Pagamento de Devolução de Mensalidade de Título de Capitalização 00514 - Restituição de Contribuição de Plano Previdenciário 00515 - Pagamento de Benefício Previdenciário de Pecúlio 00516 - Pagamento de Benefício Previdenciário de Pensão 00517 - Pagamento de Benefício Previdenciário de Aposentadoria 00518 - Pagamento de Resgate Previdenciário 00519 - Pagamento de Comissão de Corretagem 00520 - Pagamento de Transferências/Portabilidade de Reserva de Seguro/Previdência 01 - Crédito em Conta 01 - Crédito em Conta Corrente 01.3 - Transferência por Chave PIX (Obrigatório informar a chave pix na tag \"pix_qrcode\") 02 - Pagamento de Aluguel / Condomínio 03 - Pagamento de Duplicatas e Títulos 04 - Pagamento de Dividendos 05 - Pagamento de Mensalidades Escolares 07 - Pagamento a Fornecedor / Honorários 08 - Pagamento de Câmbio / Fundos / Bolsas 09 - Repasse de Arrecadação / Pagamento de Tributos 11 - DOC / TED para Poupança 12 - DOC / TED para Depósito Judicial 13 - Pensão Alimentícia 14 - Restituição de Imposto de Renda 99 - Outros 99999 - Outros"},"cpf_cnpj_transferencia":{"type":"string","description":"CNPJ ou CPF do Titular."},"nome_transferencia":{"type":"string","description":"Nome do Titular da Conta Corrente."},"codigo_barras_boleto":{"type":"string","description":"Código de Barras (de Cobrança Bancária, de Concessionária ou de Impostos)"},"juros_boleto":{"type":"decimal","description":"Percentual de Juros ao Mês do Boleto."},"multa_boleto":{"type":"decimal","description":"Percentual de Multa por Atraso do Boleto."},"pix_qrcode":{"type":"string","description":"QR Code do PIX."}},"description":"Dados do CNAB e Integração Bancária."},"servico_tomado":{"type":"object","properties":{"numero_nf":{"type":"string","description":"Número da Nota Fiscal."},"serie_nf":{"type":"string","description":"Série da Nota Fiscal."},"codigo_servico":{"type":"string","description":"Código do serviço (LC116)."},"valor_nf":{"type":"decimal","description":"Valor total da Nota Fiscal."},"cst_pis":{"type":"string","description":"CST do PIS (Código da Situação Tributária)."},"base_pis":{"type":"decimal","description":"Base de cálculo do PIS."},"aliquota_pis":{"type":"decimal","description":"Alíquota do PIS (%)."},"valor_pis":{"type":"decimal","description":"Valor do PIS."},"cst_cofins":{"type":"string","description":"CST do COFINS (Código da Situação Tributária)."},"base_cofins":{"type":"decimal","description":"Base de cálculo do COFINS."},"aliquota_cofins":{"type":"decimal","description":"Alíquota do COFINS (%)."},"valor_cofins":{"type":"decimal","description":"Valor do PIS."}}},"valor_pag":{"type":"decimal","description":"Valor a pagar. Disponível apenas para os métodos de consulta e listagem."},"aprendizado_rateio":{"type":"string","description":"Aprendizado de rateio de departamento. Preencher com \"S\" ou \"N\". Default \"N\" Quando essa tag for preenchida com \"S\" será assumido o rateio de departamento para a categoria informada na tag \"codigo_categoria\". Essa tag é utilizada apenas nos métodos de inclusão e alteração."},"baixar_documento":{"type":"string","description":"Efetua a baixa automática do documento."},"conciliar_documento":{"type":"string","description":"Efetua a conciliação do documento automaticamente. Opcional. Preencher com S/N."},"pagamento":{"type":"object","properties":{"codigo_pagamento_integracao":{"type":"string"},"codigo_conta_corrente":{"type":"integer","description":"Código da Conta Corrente."},"valor":{"type":"decimal","description":"Valor a ser baixado."},"desconto":{"type":"decimal","description":"Valor do desconto."},"juros":{"type":"decimal","description":"Valor do Juros."},"multa":{"type":"decimal","description":"Valor da multa."},"data":{"type":"string","description":"Data da Baixa"},"observacao":{"type":"string","description":"Observação da Baixa do Contas a Receber."}},"description":"Detalhes do pagamento(baixa). Informe aqui os detalhes do pagamento do lançamento. Ao preencher esse campo é possível detalhar informações da baixa do documento, como: Valor pago, Desconto, Juros, Multa, etc. Quando essa tag estiver preenchida é obrigatório o preenchimento da tag \"baixar_documento\" com \"S\" Caso essa tag não seja preenchida o lançamento será baixado de forma integral de acordo com os valores do lançamento. Essa tag é utilizada apenas nos métodos de Inclusão e Alteração. Informação localizada na Aba \"Pagamentos\" no cadastro do lançamento."}},"title":"ConsultarContaPagar (retorno)"},"financas_contapagar_ExcluirContaPagar":{"type":"object","title":"ExcluirContaPagar","description":"Exclui uma conta a pagar","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirContaPagar"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_lancamento_omie":{"type":"integer","maxLength":15,"description":"Código do Lançamento de Contas a Pagar.\nInforme esse campo somente para pesquisa.\n\nEsse campo não é exibido na tela do Contas a Pagar mas é a chave de integração via API.\nÉ uma informação interna, utilizada apenas nas APIs."},"codigo_lancamento_integracao":{"type":"string","maxLength":60,"description":"Código de Integração do Lançamento de Contas a Pagar.\n\nPreencha esse campo com o código do lançamento do Contas a Pagar no aplicativo que você está integração com o Omie.\nA função dele é servir como uma mapa de relacionamento entre as aplicações.\nAo realizar uma consulta/listagem de Contas a Pagar você conseguirá ver a relação entre o id do Contas a Pagar gerado no Omie e o código do Contas a Pagar existente em sua aplicação."}}}}},"example":{"call":"ExcluirContaPagar","param":[{"codigo_lancamento_omie":0,"codigo_lancamento_integracao":""}]}},"financas_contapagar_ExcluirContaPagar_retorno":{"type":"object","properties":{"codigo_lancamento_omie":{"type":"integer","description":"Código do Lançamento de Contas a Pagar. Informe esse campo somente para pesquisa. Esse campo não é exibido na tela do Contas a Pagar mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs."},"codigo_lancamento_integracao":{"type":"string","description":"Código de Integração do Lançamento de Contas a Pagar. Preencha esse campo com o código do lançamento do Contas a Pagar no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de Contas a Pagar você conseguirá ver a relação entre o id do Contas a Pagar gerado no Omie e o código do Contas a Pagar existente em sua aplicação."},"codigo_status":{"type":"string","description":"Código do Status de Processamento. Quando retornar 0 (zero) indica que o processamento foi executado com sucesso. Qualquer outro valor maior que 0 (zero) indica que ocorreu uma falha durante o processo de validação dos dados."},"descricao_status":{"type":"string","description":"Descrição do Status de Processamento. Descreve o resultado do processando, de acordo com o código de status retornado."}},"title":"ExcluirContaPagar (retorno)"},"financas_contapagar_IncluirContaPagar":{"type":"object","title":"IncluirContaPagar","description":"Inclui uma conta a Pagar.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirContaPagar"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_lancamento_omie":{"type":"integer","maxLength":15,"description":"Código do Lançamento de Contas a Pagar.\nInforme esse campo somente para pesquisa.\n\nEsse campo não é exibido na tela do Contas a Pagar mas é a chave de integração via API.\nÉ uma informação interna, utilizada apenas nas APIs."},"codigo_lancamento_integracao":{"type":"string","maxLength":60,"description":"Código de Integração do Lançamento de Contas a Pagar.\n\nPreencha esse campo com o código do lançamento do Contas a Pagar no aplicativo que você está integração com o Omie.\nA função dele é servir como uma mapa de relacionamento entre as aplicações.\nAo realizar uma consulta/listagem de Contas a Pagar você conseguirá ver a relação entre o id do Contas a Pagar gerado no Omie e o código do Contas a Pagar existente em sua aplicação."},"codigo_cliente_fornecedor":{"type":"integer","maxLength":15,"description":"Código do Favorecido / Fornecedor.\n\nUtilize a tag \"codigo_cliente_omie\" do método \"ListarClientes\" da API\nhttp://app.omie.com.br/api/v1/geral/clientes/\npara obter essa informação."},"codigo_cliente_fornecedor_integracao":{"type":"string","maxLength":60,"description":"Código de Integração do Favorecido / Fornecedor.\n\nEsse campo deve ser informado apenas se você incluiu o cliente via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag \"codigo_cliente_omie\"."},"data_vencimento":{"type":"string","maxLength":10,"description":"Data de Vencimento.\n\nUtilize o formato \"dd/mm/aaaa\".\n\nEsse campo indica a data da vencimento do título e deve ser informado com uma data igual ou superior a data corrente."},"valor_documento":{"type":"number","maxLength":18,"description":"Valor da Conta."},"codigo_categoria":{"type":"string","maxLength":20,"description":"Código da Categoria.\n\nCaso não preenchido, assumirá a categoria padrão para o fornecedor informado. Caso não hajá um específico, retornará erro até que um código de categoria válido seja informado.\n\nUtilize a tag \"codigo\" do método \"ListarCategorias\" da API\nhttp://app.omie.com.br/api/v1/geral/categorias/\npara obter essa informação."},"categorias":{"type":"array","items":{"type":"object","properties":{"codigo_categoria":{"type":"string","maxLength":20},"valor":{"type":"number","maxLength":18},"percentual":{"type":"number","maxLength":10,"description":"Percentual da categoria"}}}},"data_previsao":{"type":"string","maxLength":10,"description":"Data da Previsão de Pagamento.\n\nUtilize o formato \"dd/mm/aaaa\".\n\nCaso não informado, assumirá a data de vencimento informada.\n\nEsse campo indica a data da previsão do título e deve ser informado com uma data igual ou superior a data corrente."},"id_conta_corrente":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente.\n\nCaso não informado, assumirá o padrão para o fornecedor. Caso não haja um padrão definido, retornará erro até que uma Conta Corrente válida seja informada.\n\nUtilize a tag \"codigo\" do método \"PesquisarContaCorrente\" da API\nhttp://app.omie.com.br/api/v1/geral/contacorrente/\npara obter essa informação."},"numero_documento_fiscal":{"type":"string","maxLength":20,"description":"Número da Nota Fiscal associada ao lançamento de Contas a Pagar.\n\nInformação localizada na Aba \"Detalhes\" do Contas a Pagar."},"data_emissao":{"type":"string","maxLength":10,"description":"Data de Emissão.\n\nCaso não informado, assumirá a data corrente.\n\nInformação localizada na Aba \"Detalhes\" do Contas a Pagar."},"data_entrada":{"type":"string","maxLength":10,"description":"Data de Registro.\n\nCaso não informado, assumirá a data corrente.\n\nInformação localizada na Aba \"Detalhes\" do Contas a Pagar."},"codigo_projeto":{"type":"integer","maxLength":15,"description":"Código do Projeto.\n\nInformação localizada na Aba \"Detalhes\" do Contas a Pagar.\n\nUtilize a tag \"codigo\" do método \"ListarProjetos\" da API\nhttp://app.omie.com.br/api/v1/geral/projetos/\npara obter essa informação."},"observacao":{"type":"string","description":"Observações.\n\nUtilize o carater ( | ) pipe como separador de linhas.\n\nInformação localizada na Aba \"Detalhes\" do Contas a Pagar."},"valor_pis":{"type":"number","maxLength":18,"description":"Valor PIS.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_pis":{"type":"string","maxLength":1,"description":"Reter PIS.\n\nInformar \"S\" ou \"N\".\n\nSe não informado, será assumido \"N\" por padrão.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_cofins":{"type":"number","maxLength":18,"description":"Valor COFINS.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_cofins":{"type":"string","maxLength":1,"description":"Reter COFINS.\n\nInformar \"S\" ou \"N\".\n\nSe não informado, será assumido \"N\" por padrão.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_csll":{"type":"number","maxLength":18,"description":"Valor CSLL.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_csll":{"type":"string","maxLength":1,"description":"Reter CSLL.\n\nInformar \"S\" ou \"N\".\n\nSe não informado, será assumido \"N\" por padrão.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_ir":{"type":"number","maxLength":18,"description":"Valor IR.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_ir":{"type":"string","maxLength":1,"description":"Reter IR.\n\nInformar \"S\" ou \"N\".\n\nSe não informado, será assumido \"N\" por padrão.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_iss":{"type":"number","maxLength":18,"description":"Valor ISS.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_iss":{"type":"string","maxLength":1,"description":"Reter ISS.\n\nInformar \"S\" ou \"N\".\n\nSe não informado, será assumido \"N\" por padrão.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_inss":{"type":"number","maxLength":18,"description":"Valor INSS.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_inss":{"type":"string","maxLength":1,"description":"Reter INSS.\n\nInformar \"S\" ou \"N\".\n\nSe não informado, será assumido \"N\" por padrão.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"distribuicao":{"type":"array","items":{"type":"object","properties":{"cCodDep":{"type":"string","maxLength":40,"description":"Código do Departamento"},"cDesDep":{"type":"string","maxLength":50,"description":"Descrição do Departamento"},"nValDep":{"type":"number","maxLength":18,"description":"Valor do rateio"},"nPerDep":{"type":"number","maxLength":10,"description":"Percentual do rateio"}}},"description":"Distribuição por Departamentos."},"numero_pedido":{"type":"string","maxLength":15,"description":"Número do Pedido.\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar."},"codigo_tipo_documento":{"type":"string","maxLength":5,"description":"Código do Tipo de Documento.\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar."},"numero_documento":{"type":"string","maxLength":20,"description":"Número do Documento.\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar."},"numero_parcela":{"type":"string","maxLength":7,"description":"Número da parcela.\n\nUtilizar o formato \"999/999\".\n\nPara 1 parcela utilize \"001/001\"\n\nSe não informado assumirá o valor \"001/001\".\nInformação localizada na Aba \"Diversos\" do Contas a Pagar."},"chave_nfe":{"type":"string","maxLength":44,"description":"Chave da NF.e.\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar."},"codigo_barras_ficha_compensacao":{"type":"string","maxLength":70,"description":"Código de Barras\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar."},"codigo_vendedor":{"type":"integer","maxLength":15,"description":"Código do Vendedor.\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar.\n\nUtilize a tag \"codigo\" do método \"ListarVendedores\" da API\nhttp://app.omie.com.br/api/v1/geral/vendedores/\npara obter essa informação."},"id_origem":{"type":"string","maxLength":4,"description":"Código da Origem.\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar.\n\nOs valores disponíveis são:\n\n\"APIP\" - Integração de Conta a Pagar\n\"BARP\" - Conta a Pagar Importada por Código de Barras\n\"COMP\" - Parcela a Pagar de Compras\n\"CTEP\" - Parcela a Pagar de um CT-e\n\"DEVP\" - Conta a Pagar da Devolução de Venda\n\"IMPP\" - Parcela a Pagar de uma Nota de Importação\n\"MANP\" - Lançamento Manual de Conta a Pagar\n\"NFEP\" - Conta a Pagar Importada de uma NF-e\n\"RPTP\" - Repetição de Contas a Pagar\n\"XMLP\" - Conta a Pagar Importada de um arquivo XML"},"info":{"type":"object","properties":{"dInc":{"type":"string","maxLength":10,"description":"Data da Inclusão.\nNo formato dd/mm/aaaa.\n\nNão deve ser informado na Inclusão/Alteração."},"hInc":{"type":"string","maxLength":8,"description":"Hora da Inclusão.\nNo formato hh:mm:ss.\n\nNão deve ser informado na Inclusão/Alteração."},"uInc":{"type":"string","maxLength":10,"description":"Usuário da Inclusão.\n\nNão deve ser informado na Inclusão/Alteração."},"dAlt":{"type":"string","maxLength":10,"description":"Data da Alteração.\nNo formato dd/mm/aaaa.\n\nNão deve ser informado na Inclusão/Alteração."},"hAlt":{"type":"string","maxLength":8,"description":"Hora da Alteração.\nNo formato hh:mm:ss.\n\nNão deve ser informado na Inclusão/Alteração."},"uAlt":{"type":"string","maxLength":10,"description":"Usuário da Alteração.\n\nNão deve ser informado na Inclusão/Alteração."},"cImpAPI":{"type":"string","maxLength":1,"description":"Importado pela API (S/N).\n\nNão deve ser informado na Inclusão/Alteração."}},"description":"Informações complemetares do cadastro do produto."},"operacao":{"type":"string","maxLength":2,"description":"Código da Operação. .\n\nEsse campo indica qual tipo de operação está associada ao lançamento de Contas a Pagar.\n\nOs valores disponíveis são:\n\n\"01\" - Venda de Serviço\n\"11\" - Venda de Produto\n\"12\" - Venda de Produto pelo PDV\n\"13\" - Devolução de Venda\n\"14\" - Remessa de Produto\n\"16\" - Nota Complementar de Saída"},"status_titulo":{"type":"string","maxLength":3,"description":"Status do Título.\n\nEssa informação é retornada na consulta/pesquisa dos lançamentos de Contas a Pagar."},"nsu":{"type":"string","maxLength":100,"description":"DEPRECATED."},"acao":{"deprecated":true,"type":"string","description":"DEPRECATED"},"id_conta_corrente_integracao":{"deprecated":true,"type":"string","maxLength":20,"description":"DEPRECATED"},"bloqueado":{"deprecated":true,"type":"string","maxLength":1,"description":"DEPRECATED"},"baixa_bloqueada":{"deprecated":true,"type":"string","maxLength":1,"description":"DEPRECATED"},"codigo_cmc7_cheque":{"deprecated":true,"type":"string","maxLength":40,"description":"DEPRECATED"},"importado_api":{"deprecated":true,"type":"string","maxLength":1,"description":"DEPRECATED"},"bloquear_exclusao":{"type":"string","maxLength":1,"description":"Bloqueia a exclusão do registro. (S/N)"},"cnab_integracao_bancaria":{"type":"object","properties":{"codigo_forma_pagamento":{"type":"string","maxLength":3,"description":"Código da Forma de Pagamento.\n\n\nPode ser:\n\nTRA - Transferência Bancária.\nBOL - Pagamento de Boleto.\nPIX - Transferência via PIX por QR Code."},"banco_transferencia":{"type":"string","maxLength":3,"description":"Código do Banco para Transferência Bancária."},"agencia_transferencia":{"type":"string","maxLength":10,"description":"Número da Agência para Transferência Bancária."},"conta_corrente_transferencia":{"type":"string","maxLength":25,"description":"Número da Conta Corrente para Transferência Bancária."},"finalidade_transferencia":{"type":"string","maxLength":10,"description":"Finalidade da transferência.\n\n\nVerificar código da Finalidade de acordo com o banco vinculado ao cadastro da conta corrente informada na tag [\"id_conta_corrente\"]\n\nPode ser:\n00001 - Pagamento de Impostos, Tributos e Taxas\n00002 - Pagamento a Concessionárias de Serviço Público\n00003 - Pagamento de Dividendos\n00004 - Pagamento de Salários\n00005 - Pagamento de Fornecedores\n00006 - Pagamento de Honorários\n00007 - Pagamento de Aluguéis e Taxas e Condomínio\n00008 - Pagamento de Duplicatas e Títulos\n00009 - Pagamento de Honorários\n00010 - Crédito em Conta\n00011 - Pagamento a Corretoras\n00016 - Crédito em Conta Investimento\n00100 - Depósito Judicial\n00101 - Pensão Alimentícia\n00200 - Transferência Internacional de Reais\n00201 - Ajuste Posição Mercado Futuro\n00202 - Repasse de valores do BNDES\n00203 - Liquidação de compromisso com BNDES\n00204 - Compra/Venda de Ações - Bolsas de Valores e Mercado de Balcão\n00205 - Contrato referenciado em Ações/Índices de Ações - BV/BMF\n00300 - Restituição de Imposto de Renda\n00500 - Restitiuição de Prêmio de Seguros\n00501 - Pagamento de indenização de Sinistro de Seguro\n00502 - Pagamento de Prêmio de Co-seguro\n00503 - Restituição de prêmio de Co-seguro\n00504 - Pagamento de indenização de Co-seguro\n00505 - Pagamento de prêmio de Resseguro\n00506 - Restituição de prêmio de Resseguro\n00507 - Pagamento de Indenização de Sinistro de Resseguro\n00508 - Restituição de Indenização de Sinistro de Resseguro\n00509 - Pagamento de Despesas com Sinistros\n00510 - Pagamento de Inspeções/Vistorias Prévias\n00511 - Pagamento de Resgate de Título de Capitalização\n00512 - Pagamento de Sorteio de Título de Capitalização\n00513 - Pagamento de Devolução de Mensalidade de Título de Capitalização\n00514 - Restituição de Contribuição de Plano Previdenciário\n00515 - Pagamento de Benefício Previdenciário de Pecúlio\n00516 - Pagamento de Benefício Previdenciário de Pensão\n00517 - Pagamento de Benefício Previdenciário de Aposentadoria\n00518 - Pagamento de Resgate Previdenciário\n00519 - Pagamento de Comissão de Corretagem\n00520 - Pagamento de Transferências/Portabilidade de Reserva de Seguro/Previdência\n01 - Crédito em Conta\n01 - Crédito em Conta Corrente\n01.3 - Transferência por Chave PIX (Obrigatório informar a chave pix na tag \"pix_qrcode\")\n02 - Pagamento de Aluguel / Condomínio\n03 - Pagamento de Duplicatas e Títulos\n04 - Pagamento de Dividendos\n05 - Pagamento de Mensalidades Escolares\n07 - Pagamento a Fornecedor / Honorários\n08 - Pagamento de Câmbio / Fundos / Bolsas\n09 - Repasse de Arrecadação / Pagamento de Tributos\n11 - DOC / TED para Poupança\n12 - DOC / TED para Depósito Judicial\n13 - Pensão Alimentícia\n14 - Restituição de Imposto de Renda\n99 - Outros\n99999 - Outros"},"cpf_cnpj_transferencia":{"type":"string","maxLength":20,"description":"CNPJ ou CPF do Titular."},"nome_transferencia":{"type":"string","maxLength":60,"description":"Nome do Titular da Conta Corrente."},"codigo_barras_boleto":{"type":"string","maxLength":70,"description":"Código de Barras (de Cobrança Bancária, de Concessionária ou de Impostos)"},"juros_boleto":{"type":"number","maxLength":10,"description":"Percentual de Juros ao Mês do Boleto."},"multa_boleto":{"type":"number","maxLength":10,"description":"Percentual de Multa por Atraso do Boleto."},"pix_qrcode":{"type":"string","maxLength":300,"description":"QR Code do PIX."}},"required":["finalidade_transferencia"],"description":"Dados do CNAB e Integração Bancária."},"servico_tomado":{"type":"object","properties":{"numero_nf":{"type":"string","maxLength":20,"description":"Número da Nota Fiscal."},"serie_nf":{"type":"string","maxLength":20,"description":"Série da Nota Fiscal."},"codigo_servico":{"type":"string","maxLength":10,"description":"Código do serviço (LC116)."},"valor_nf":{"type":"number","maxLength":18,"description":"Valor total da Nota Fiscal."},"cst_pis":{"type":"string","maxLength":2,"description":"CST do PIS (Código da Situação Tributária)."},"base_pis":{"type":"number","maxLength":18,"description":"Base de cálculo do PIS."},"aliquota_pis":{"type":"number","maxLength":18,"description":"Alíquota do PIS (%)."},"valor_pis":{"type":"number","maxLength":18,"description":"Valor do PIS."},"cst_cofins":{"type":"string","maxLength":2,"description":"CST do COFINS (Código da Situação Tributária)."},"base_cofins":{"type":"number","maxLength":18,"description":"Base de cálculo do COFINS."},"aliquota_cofins":{"type":"number","maxLength":18,"description":"Alíquota do COFINS (%)."},"valor_cofins":{"type":"number","maxLength":18,"description":"Valor do PIS."}}},"valor_pag":{"type":"number","maxLength":18,"description":"Valor a pagar.\n\nDisponível apenas para os métodos de consulta e listagem."},"aprendizado_rateio":{"type":"string","maxLength":1,"description":"Aprendizado de rateio de departamento.\n\nPreencher com \"S\" ou \"N\".\n\nDefault \"N\"\n\nQuando essa tag for preenchida com \"S\" será assumido o rateio de departamento para a categoria informada na tag \"codigo_categoria\".\n\nEssa tag é utilizada apenas nos métodos de inclusão e alteração."},"baixar_documento":{"type":"string","maxLength":1,"description":"Efetua a baixa automática do documento."},"conciliar_documento":{"type":"string","maxLength":1,"description":"Efetua a conciliação do documento automaticamente. Opcional.\n\nPreencher com S/N."},"pagamento":{"type":"object","properties":{"codigo_pagamento_integracao":{"type":"string","maxLength":20},"codigo_conta_corrente":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente."},"valor":{"type":"number","maxLength":18,"description":"Valor a ser baixado."},"desconto":{"type":"number","maxLength":18,"description":"Valor do desconto."},"juros":{"type":"number","maxLength":18,"description":"Valor do Juros."},"multa":{"type":"number","maxLength":18,"description":"Valor da multa."},"data":{"type":"string","maxLength":10,"description":"Data da Baixa"},"observacao":{"type":"string","description":"Observação da Baixa do Contas a Receber."}},"description":"Detalhes do pagamento(baixa).\nInforme aqui os detalhes do pagamento do lançamento.\n\nAo preencher esse campo é possível detalhar informações da baixa do documento, como: Valor pago, Desconto, Juros, Multa, etc.\n\nQuando essa tag estiver preenchida é obrigatório o preenchimento da tag \"baixar_documento\" com \"S\"\n\nCaso essa tag não seja preenchida o lançamento será baixado de forma integral de acordo com os valores do lançamento.\n\nEssa tag é utilizada apenas nos métodos de Inclusão e Alteração.\n\nInformação localizada na Aba \"Pagamentos\" no cadastro do lançamento."}},"required":["codigo_lancamento_integracao","data_vencimento","pagamento","valor_documento"]}}},"example":{"call":"IncluirContaPagar","param":[{"codigo_lancamento_integracao":"1790774898","codigo_cliente_fornecedor":4214850,"data_vencimento":"30/09/2026","valor_documento":100.0,"codigo_categoria":"2.04.01","data_previsao":"30/09/2026","id_conta_corrente":4243124}]}},"financas_contapagar_IncluirContaPagar_retorno":{"type":"object","properties":{"codigo_lancamento_omie":{"type":"integer","description":"Código do Lançamento de Contas a Pagar. Informe esse campo somente para pesquisa. Esse campo não é exibido na tela do Contas a Pagar mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs."},"codigo_lancamento_integracao":{"type":"string","description":"Código de Integração do Lançamento de Contas a Pagar. Preencha esse campo com o código do lançamento do Contas a Pagar no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de Contas a Pagar você conseguirá ver a relação entre o id do Contas a Pagar gerado no Omie e o código do Contas a Pagar existente em sua aplicação."},"codigo_status":{"type":"string","description":"Código do Status de Processamento. Quando retornar 0 (zero) indica que o processamento foi executado com sucesso. Qualquer outro valor maior que 0 (zero) indica que ocorreu uma falha durante o processo de validação dos dados."},"descricao_status":{"type":"string","description":"Descrição do Status de Processamento. Descreve o resultado do processando, de acordo com o código de status retornado."}},"title":"IncluirContaPagar (retorno)"},"financas_contapagar_IncluirContaPagarPorLote":{"type":"object","title":"IncluirContaPagarPorLote","description":"Inclusão do contas a pagar por lote","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirContaPagarPorLote"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"lote":{"type":"integer","maxLength":15,"description":"Número do Lote"},"conta_pagar_cadastro":{"type":"array","items":{"type":"object","properties":{"codigo_lancamento_omie":{"type":"integer","maxLength":15,"description":"Código do Lançamento de Contas a Pagar.\nInforme esse campo somente para pesquisa.\n\nEsse campo não é exibido na tela do Contas a Pagar mas é a chave de integração via API.\nÉ uma informação interna, utilizada apenas nas APIs."},"codigo_lancamento_integracao":{"type":"string","maxLength":60,"description":"Código de Integração do Lançamento de Contas a Pagar.\n\nPreencha esse campo com o código do lançamento do Contas a Pagar no aplicativo que você está integração com o Omie.\nA função dele é servir como uma mapa de relacionamento entre as aplicações.\nAo realizar uma consulta/listagem de Contas a Pagar você conseguirá ver a relação entre o id do Contas a Pagar gerado no Omie e o código do Contas a Pagar existente em sua aplicação."},"codigo_cliente_fornecedor":{"type":"integer","maxLength":15,"description":"Código do Favorecido / Fornecedor.\n\nUtilize a tag \"codigo_cliente_omie\" do método \"ListarClientes\" da API\nhttp://app.omie.com.br/api/v1/geral/clientes/\npara obter essa informação."},"codigo_cliente_fornecedor_integracao":{"type":"string","maxLength":60,"description":"Código de Integração do Favorecido / Fornecedor.\n\nEsse campo deve ser informado apenas se você incluiu o cliente via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag \"codigo_cliente_omie\"."},"data_vencimento":{"type":"string","maxLength":10,"description":"Data de Vencimento.\n\nUtilize o formato \"dd/mm/aaaa\".\n\nEsse campo indica a data da vencimento do título e deve ser informado com uma data igual ou superior a data corrente."},"valor_documento":{"type":"number","maxLength":18,"description":"Valor da Conta."},"codigo_categoria":{"type":"string","maxLength":20,"description":"Código da Categoria.\n\nCaso não preenchido, assumirá a categoria padrão para o fornecedor informado. Caso não hajá um específico, retornará erro até que um código de categoria válido seja informado.\n\nUtilize a tag \"codigo\" do método \"ListarCategorias\" da API\nhttp://app.omie.com.br/api/v1/geral/categorias/\npara obter essa informação."},"categorias":{"type":"array","items":{"type":"object","properties":{"codigo_categoria":{"type":"string","maxLength":20},"valor":{"type":"number","maxLength":18},"percentual":{"type":"number","maxLength":10,"description":"Percentual da categoria"}}}},"data_previsao":{"type":"string","maxLength":10,"description":"Data da Previsão de Pagamento.\n\nUtilize o formato \"dd/mm/aaaa\".\n\nCaso não informado, assumirá a data de vencimento informada.\n\nEsse campo indica a data da previsão do título e deve ser informado com uma data igual ou superior a data corrente."},"id_conta_corrente":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente.\n\nCaso não informado, assumirá o padrão para o fornecedor. Caso não haja um padrão definido, retornará erro até que uma Conta Corrente válida seja informada.\n\nUtilize a tag \"codigo\" do método \"PesquisarContaCorrente\" da API\nhttp://app.omie.com.br/api/v1/geral/contacorrente/\npara obter essa informação."},"numero_documento_fiscal":{"type":"string","maxLength":20,"description":"Número da Nota Fiscal associada ao lançamento de Contas a Pagar.\n\nInformação localizada na Aba \"Detalhes\" do Contas a Pagar."},"data_emissao":{"type":"string","maxLength":10,"description":"Data de Emissão.\n\nCaso não informado, assumirá a data corrente.\n\nInformação localizada na Aba \"Detalhes\" do Contas a Pagar."},"data_entrada":{"type":"string","maxLength":10,"description":"Data de Registro.\n\nCaso não informado, assumirá a data corrente.\n\nInformação localizada na Aba \"Detalhes\" do Contas a Pagar."},"codigo_projeto":{"type":"integer","maxLength":15,"description":"Código do Projeto.\n\nInformação localizada na Aba \"Detalhes\" do Contas a Pagar.\n\nUtilize a tag \"codigo\" do método \"ListarProjetos\" da API\nhttp://app.omie.com.br/api/v1/geral/projetos/\npara obter essa informação."},"observacao":{"type":"string","description":"Observações.\n\nUtilize o carater ( | ) pipe como separador de linhas.\n\nInformação localizada na Aba \"Detalhes\" do Contas a Pagar."},"valor_pis":{"type":"number","maxLength":18,"description":"Valor PIS.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_pis":{"type":"string","maxLength":1,"description":"Reter PIS.\n\nInformar \"S\" ou \"N\".\n\nSe não informado, será assumido \"N\" por padrão.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_cofins":{"type":"number","maxLength":18,"description":"Valor COFINS.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_cofins":{"type":"string","maxLength":1,"description":"Reter COFINS.\n\nInformar \"S\" ou \"N\".\n\nSe não informado, será assumido \"N\" por padrão.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_csll":{"type":"number","maxLength":18,"description":"Valor CSLL.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_csll":{"type":"string","maxLength":1,"description":"Reter CSLL.\n\nInformar \"S\" ou \"N\".\n\nSe não informado, será assumido \"N\" por padrão.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_ir":{"type":"number","maxLength":18,"description":"Valor IR.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_ir":{"type":"string","maxLength":1,"description":"Reter IR.\n\nInformar \"S\" ou \"N\".\n\nSe não informado, será assumido \"N\" por padrão.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_iss":{"type":"number","maxLength":18,"description":"Valor ISS.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_iss":{"type":"string","maxLength":1,"description":"Reter ISS.\n\nInformar \"S\" ou \"N\".\n\nSe não informado, será assumido \"N\" por padrão.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_inss":{"type":"number","maxLength":18,"description":"Valor INSS.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_inss":{"type":"string","maxLength":1,"description":"Reter INSS.\n\nInformar \"S\" ou \"N\".\n\nSe não informado, será assumido \"N\" por padrão.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"distribuicao":{"type":"array","items":{"type":"object","properties":{"cCodDep":{"type":"string","maxLength":40,"description":"Código do Departamento"},"cDesDep":{"type":"string","maxLength":50,"description":"Descrição do Departamento"},"nValDep":{"type":"number","maxLength":18,"description":"Valor do rateio"},"nPerDep":{"type":"number","maxLength":10,"description":"Percentual do rateio"}}},"description":"Distribuição por Departamentos."},"numero_pedido":{"type":"string","maxLength":15,"description":"Número do Pedido.\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar."},"codigo_tipo_documento":{"type":"string","maxLength":5,"description":"Código do Tipo de Documento.\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar."},"numero_documento":{"type":"string","maxLength":20,"description":"Número do Documento.\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar."},"numero_parcela":{"type":"string","maxLength":7,"description":"Número da parcela.\n\nUtilizar o formato \"999/999\".\n\nPara 1 parcela utilize \"001/001\"\n\nSe não informado assumirá o valor \"001/001\".\nInformação localizada na Aba \"Diversos\" do Contas a Pagar."},"chave_nfe":{"type":"string","maxLength":44,"description":"Chave da NF.e.\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar."},"codigo_barras_ficha_compensacao":{"type":"string","maxLength":70,"description":"Código de Barras\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar."},"codigo_vendedor":{"type":"integer","maxLength":15,"description":"Código do Vendedor.\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar.\n\nUtilize a tag \"codigo\" do método \"ListarVendedores\" da API\nhttp://app.omie.com.br/api/v1/geral/vendedores/\npara obter essa informação."},"id_origem":{"type":"string","maxLength":4,"description":"Código da Origem.\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar.\n\nOs valores disponíveis são:\n\n\"APIP\" - Integração de Conta a Pagar\n\"BARP\" - Conta a Pagar Importada por Código de Barras\n\"COMP\" - Parcela a Pagar de Compras\n\"CTEP\" - Parcela a Pagar de um CT-e\n\"DEVP\" - Conta a Pagar da Devolução de Venda\n\"IMPP\" - Parcela a Pagar de uma Nota de Importação\n\"MANP\" - Lançamento Manual de Conta a Pagar\n\"NFEP\" - Conta a Pagar Importada de uma NF-e\n\"RPTP\" - Repetição de Contas a Pagar\n\"XMLP\" - Conta a Pagar Importada de um arquivo XML"},"info":{"type":"object","properties":{"dInc":{"type":"string","maxLength":10,"description":"Data da Inclusão.\nNo formato dd/mm/aaaa.\n\nNão deve ser informado na Inclusão/Alteração."},"hInc":{"type":"string","maxLength":8,"description":"Hora da Inclusão.\nNo formato hh:mm:ss.\n\nNão deve ser informado na Inclusão/Alteração."},"uInc":{"type":"string","maxLength":10,"description":"Usuário da Inclusão.\n\nNão deve ser informado na Inclusão/Alteração."},"dAlt":{"type":"string","maxLength":10,"description":"Data da Alteração.\nNo formato dd/mm/aaaa.\n\nNão deve ser informado na Inclusão/Alteração."},"hAlt":{"type":"string","maxLength":8,"description":"Hora da Alteração.\nNo formato hh:mm:ss.\n\nNão deve ser informado na Inclusão/Alteração."},"uAlt":{"type":"string","maxLength":10,"description":"Usuário da Alteração.\n\nNão deve ser informado na Inclusão/Alteração."},"cImpAPI":{"type":"string","maxLength":1,"description":"Importado pela API (S/N).\n\nNão deve ser informado na Inclusão/Alteração."}},"description":"Informações complemetares do cadastro do produto."},"operacao":{"type":"string","maxLength":2,"description":"Código da Operação. .\n\nEsse campo indica qual tipo de operação está associada ao lançamento de Contas a Pagar.\n\nOs valores disponíveis são:\n\n\"01\" - Venda de Serviço\n\"11\" - Venda de Produto\n\"12\" - Venda de Produto pelo PDV\n\"13\" - Devolução de Venda\n\"14\" - Remessa de Produto\n\"16\" - Nota Complementar de Saída"},"status_titulo":{"type":"string","maxLength":3,"description":"Status do Título.\n\nEssa informação é retornada na consulta/pesquisa dos lançamentos de Contas a Pagar."},"nsu":{"type":"string","maxLength":100,"description":"DEPRECATED."},"acao":{"deprecated":true,"type":"string","description":"DEPRECATED"},"id_conta_corrente_integracao":{"deprecated":true,"type":"string","maxLength":20,"description":"DEPRECATED"},"bloqueado":{"deprecated":true,"type":"string","maxLength":1,"description":"DEPRECATED"},"baixa_bloqueada":{"deprecated":true,"type":"string","maxLength":1,"description":"DEPRECATED"},"codigo_cmc7_cheque":{"deprecated":true,"type":"string","maxLength":40,"description":"DEPRECATED"},"importado_api":{"deprecated":true,"type":"string","maxLength":1,"description":"DEPRECATED"},"bloquear_exclusao":{"type":"string","maxLength":1,"description":"Bloqueia a exclusão do registro. (S/N)"},"cnab_integracao_bancaria":{"type":"object","properties":{"codigo_forma_pagamento":{"type":"string","maxLength":3,"description":"Código da Forma de Pagamento.\n\n\nPode ser:\n\nTRA - Transferência Bancária.\nBOL - Pagamento de Boleto.\nPIX - Transferência via PIX por QR Code."},"banco_transferencia":{"type":"string","maxLength":3,"description":"Código do Banco para Transferência Bancária."},"agencia_transferencia":{"type":"string","maxLength":10,"description":"Número da Agência para Transferência Bancária."},"conta_corrente_transferencia":{"type":"string","maxLength":25,"description":"Número da Conta Corrente para Transferência Bancária."},"finalidade_transferencia":{"type":"string","maxLength":10,"description":"Finalidade da transferência.\n\n\nVerificar código da Finalidade de acordo com o banco vinculado ao cadastro da conta corrente informada na tag [\"id_conta_corrente\"]\n\nPode ser:\n00001 - Pagamento de Impostos, Tributos e Taxas\n00002 - Pagamento a Concessionárias de Serviço Público\n00003 - Pagamento de Dividendos\n00004 - Pagamento de Salários\n00005 - Pagamento de Fornecedores\n00006 - Pagamento de Honorários\n00007 - Pagamento de Aluguéis e Taxas e Condomínio\n00008 - Pagamento de Duplicatas e Títulos\n00009 - Pagamento de Honorários\n00010 - Crédito em Conta\n00011 - Pagamento a Corretoras\n00016 - Crédito em Conta Investimento\n00100 - Depósito Judicial\n00101 - Pensão Alimentícia\n00200 - Transferência Internacional de Reais\n00201 - Ajuste Posição Mercado Futuro\n00202 - Repasse de valores do BNDES\n00203 - Liquidação de compromisso com BNDES\n00204 - Compra/Venda de Ações - Bolsas de Valores e Mercado de Balcão\n00205 - Contrato referenciado em Ações/Índices de Ações - BV/BMF\n00300 - Restituição de Imposto de Renda\n00500 - Restitiuição de Prêmio de Seguros\n00501 - Pagamento de indenização de Sinistro de Seguro\n00502 - Pagamento de Prêmio de Co-seguro\n00503 - Restituição de prêmio de Co-seguro\n00504 - Pagamento de indenização de Co-seguro\n00505 - Pagamento de prêmio de Resseguro\n00506 - Restituição de prêmio de Resseguro\n00507 - Pagamento de Indenização de Sinistro de Resseguro\n00508 - Restituição de Indenização de Sinistro de Resseguro\n00509 - Pagamento de Despesas com Sinistros\n00510 - Pagamento de Inspeções/Vistorias Prévias\n00511 - Pagamento de Resgate de Título de Capitalização\n00512 - Pagamento de Sorteio de Título de Capitalização\n00513 - Pagamento de Devolução de Mensalidade de Título de Capitalização\n00514 - Restituição de Contribuição de Plano Previdenciário\n00515 - Pagamento de Benefício Previdenciário de Pecúlio\n00516 - Pagamento de Benefício Previdenciário de Pensão\n00517 - Pagamento de Benefício Previdenciário de Aposentadoria\n00518 - Pagamento de Resgate Previdenciário\n00519 - Pagamento de Comissão de Corretagem\n00520 - Pagamento de Transferências/Portabilidade de Reserva de Seguro/Previdência\n01 - Crédito em Conta\n01 - Crédito em Conta Corrente\n01.3 - Transferência por Chave PIX (Obrigatório informar a chave pix na tag \"pix_qrcode\")\n02 - Pagamento de Aluguel / Condomínio\n03 - Pagamento de Duplicatas e Títulos\n04 - Pagamento de Dividendos\n05 - Pagamento de Mensalidades Escolares\n07 - Pagamento a Fornecedor / Honorários\n08 - Pagamento de Câmbio / Fundos / Bolsas\n09 - Repasse de Arrecadação / Pagamento de Tributos\n11 - DOC / TED para Poupança\n12 - DOC / TED para Depósito Judicial\n13 - Pensão Alimentícia\n14 - Restituição de Imposto de Renda\n99 - Outros\n99999 - Outros"},"cpf_cnpj_transferencia":{"type":"string","maxLength":20,"description":"CNPJ ou CPF do Titular."},"nome_transferencia":{"type":"string","maxLength":60,"description":"Nome do Titular da Conta Corrente."},"codigo_barras_boleto":{"type":"string","maxLength":70,"description":"Código de Barras (de Cobrança Bancária, de Concessionária ou de Impostos)"},"juros_boleto":{"type":"number","maxLength":10,"description":"Percentual de Juros ao Mês do Boleto."},"multa_boleto":{"type":"number","maxLength":10,"description":"Percentual de Multa por Atraso do Boleto."},"pix_qrcode":{"type":"string","maxLength":300,"description":"QR Code do PIX."}},"required":["finalidade_transferencia"],"description":"Dados do CNAB e Integração Bancária."},"servico_tomado":{"type":"object","properties":{"numero_nf":{"type":"string","maxLength":20,"description":"Número da Nota Fiscal."},"serie_nf":{"type":"string","maxLength":20,"description":"Série da Nota Fiscal."},"codigo_servico":{"type":"string","maxLength":10,"description":"Código do serviço (LC116)."},"valor_nf":{"type":"number","maxLength":18,"description":"Valor total da Nota Fiscal."},"cst_pis":{"type":"string","maxLength":2,"description":"CST do PIS (Código da Situação Tributária)."},"base_pis":{"type":"number","maxLength":18,"description":"Base de cálculo do PIS."},"aliquota_pis":{"type":"number","maxLength":18,"description":"Alíquota do PIS (%)."},"valor_pis":{"type":"number","maxLength":18,"description":"Valor do PIS."},"cst_cofins":{"type":"string","maxLength":2,"description":"CST do COFINS (Código da Situação Tributária)."},"base_cofins":{"type":"number","maxLength":18,"description":"Base de cálculo do COFINS."},"aliquota_cofins":{"type":"number","maxLength":18,"description":"Alíquota do COFINS (%)."},"valor_cofins":{"type":"number","maxLength":18,"description":"Valor do PIS."}}},"valor_pag":{"type":"number","maxLength":18,"description":"Valor a pagar.\n\nDisponível apenas para os métodos de consulta e listagem."},"aprendizado_rateio":{"type":"string","maxLength":1,"description":"Aprendizado de rateio de departamento.\n\nPreencher com \"S\" ou \"N\".\n\nDefault \"N\"\n\nQuando essa tag for preenchida com \"S\" será assumido o rateio de departamento para a categoria informada na tag \"codigo_categoria\".\n\nEssa tag é utilizada apenas nos métodos de inclusão e alteração."},"baixar_documento":{"type":"string","maxLength":1,"description":"Efetua a baixa automática do documento."},"conciliar_documento":{"type":"string","maxLength":1,"description":"Efetua a conciliação do documento automaticamente. Opcional.\n\nPreencher com S/N."},"pagamento":{"type":"object","properties":{"codigo_pagamento_integracao":{"type":"string","maxLength":20},"codigo_conta_corrente":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente."},"valor":{"type":"number","maxLength":18,"description":"Valor a ser baixado."},"desconto":{"type":"number","maxLength":18,"description":"Valor do desconto."},"juros":{"type":"number","maxLength":18,"description":"Valor do Juros."},"multa":{"type":"number","maxLength":18,"description":"Valor da multa."},"data":{"type":"string","maxLength":10,"description":"Data da Baixa"},"observacao":{"type":"string","description":"Observação da Baixa do Contas a Receber."}},"description":"Detalhes do pagamento(baixa).\nInforme aqui os detalhes do pagamento do lançamento.\n\nAo preencher esse campo é possível detalhar informações da baixa do documento, como: Valor pago, Desconto, Juros, Multa, etc.\n\nQuando essa tag estiver preenchida é obrigatório o preenchimento da tag \"baixar_documento\" com \"S\"\n\nCaso essa tag não seja preenchida o lançamento será baixado de forma integral de acordo com os valores do lançamento.\n\nEssa tag é utilizada apenas nos métodos de Inclusão e Alteração.\n\nInformação localizada na Aba \"Pagamentos\" no cadastro do lançamento."}},"required":["pagamento"]}}}}}},"example":{"call":"IncluirContaPagarPorLote","param":[{"lote":100,"conta_pagar_cadastro":[{"codigo_lancamento_integracao":"1790774898","codigo_cliente_fornecedor":4214850,"data_vencimento":"30/09/2026","valor_documento":100.0,"codigo_categoria":"2.04.01","data_previsao":"30/09/2026","id_conta_corrente":4243124},{"codigo_lancamento_integracao":"1790774898","codigo_cliente_fornecedor":4214850,"data_vencimento":"30/09/2026","valor_documento":120.0,"codigo_categoria":"2.04.01","data_previsao":"30/09/2026","id_conta_corrente":4243124}]}]}},"financas_contapagar_IncluirContaPagarPorLote_retorno":{"type":"object","properties":{"lote":{"type":"integer","description":"Número do lote processado"},"codigo_status":{"type":"string","description":"Código do Status do processamento"},"descricao_status":{"type":"string","description":"Descrição do Status do Lote"}},"title":"IncluirContaPagarPorLote (retorno)"},"financas_contapagar_LancarPagamento":{"type":"object","title":"LancarPagamento","description":"Efetua a baixa de um pagamento do contas a pagar.","required":["call","param"],"properties":{"call":{"type":"string","enum":["LancarPagamento"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_lancamento":{"type":"integer","maxLength":15,"description":"codigo do lançamento no Omie"},"codigo_lancamento_integracao":{"type":"string","maxLength":60,"description":"Código do lançamento do integrador."},"codigo_baixa":{"type":"integer","maxLength":15,"description":"Código para identificar a baixa do título no Contas a Pagar."},"codigo_baixa_integracao":{"type":"string","maxLength":20,"description":"Código da baixa do integrador para identificar a baixa de um título do contas a pagar."},"codigo_conta_corrente":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente."},"codigo_conta_corrente_integracao":{"type":"string","maxLength":20,"description":"Código da Conta Corrente do Integrador."},"valor":{"type":"number","maxLength":18,"description":"Valor a ser baixado."},"desconto":{"type":"number","maxLength":18,"description":"Valor do desconto."},"juros":{"type":"number","maxLength":18,"description":"Valor do Juros."},"multa":{"type":"number","maxLength":18,"description":"Valor da multa."},"data":{"type":"string","maxLength":10,"description":"Data da Baixa"},"observacao":{"type":"string","description":"Observação da Baixa do Contas a Receber."},"conciliar_documento":{"type":"string","maxLength":1,"description":"Efetua a conciliação do documento automaticamente."}},"required":["codigo_conta_corrente","data"]}}},"example":{"call":"LancarPagamento","param":[{"codigo_lancamento":0,"codigo_lancamento_integracao":"","codigo_baixa_integracao":"","codigo_conta_corrente":"","valor":100.2,"desconto":0,"juros":0,"multa":0,"data":"30/09/2026","observacao":"Baixa de documento realizada via API."}]}},"financas_contapagar_LancarPagamento_retorno":{"type":"object","properties":{"codigo_lancamento":{"type":"integer","description":"Código do lançamento no contas a pagar."},"codigo_lancamento_integracao":{"type":"string","description":"Código de integração do parceiro para identificar o lançamento no Contas a Receber."},"codigo_baixa":{"type":"integer","description":"Código da baixa do contas a receber no Omie."},"codigo_baixa_integracao":{"type":"string","description":"Código da baixa do integrador para identificar a baixa do título do contas a receber."},"liquidado":{"type":"string","description":"Indica que o recebimento liquidado."},"valor_baixado":{"type":"decimal","description":"Valor baixado"},"codigo_status":{"type":"string","description":"Código do Status da baixa."},"descricao_status":{"type":"string","description":"Descrição do status da baixa do contas a pagar"}},"title":"LancarPagamento (retorno)"},"financas_contapagar_ListarContasPagar":{"type":"object","title":"ListarContasPagar","description":"Listar as Contas a Pagar","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarContasPagar"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página que será retornada.\n\nComo a resposta é paginada, é necessário informada qual página será recuperada na pesquisa.\n\nO valor padrão para esse campo é sempre 1."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros por página.\n\nIndique quando registro você recuperá para cada página solicitada.\n\nO límite máximo permitido para essa API é 50 registro por página.\n\nAssim, se você tiver 1000 lançamentos registrados, será necessário realizar 20 consultas para obter todos os registros."},"apenas_importado_api":{"type":"string","maxLength":1,"description":"Exibir apenas os registros gerados pela API.\n\nInformar \"S\" ou \"N\".\n\nO valor padrão para esse campo é \"N\"."},"ordenar_por":{"type":"string","maxLength":100,"description":"Ordem de exibição dos dados.\n\nO valor padrão para esse campo é \"CODIGO\".\n\nOs valores disponíveis são:\n\"CODIGO\"\n\"CODIGO_INTEGRACAO\""},"ordem_descrescente":{"type":"string","maxLength":1,"description":"Exibir em Ordem Crescente ou Decrescente\n\nInformar \"S\" para exibir os dados em Ordem Descrescente ou \"N\" para exibir os dados em Ordem Crescente.\n\nO valor padrão para esse campo é \"N\"."},"filtrar_por_data_de":{"type":"string","maxLength":10,"description":"Data de Inicio do filtro.\n\nUtilize o formato \"dd/mm/aaaa\".\n\nSerão consideradas as datas de inclusão e alteração do lançamento de Contas a Pagar conforme definido nos campos \"filtrar_apenas_inclusao\" e \"filtrar_apenas_alteracao\"."},"filtrar_por_data_ate":{"type":"string","maxLength":10,"description":"Data de fim do filtro.\n\nUtilize o formato \"dd/mm/aaaa\".\n\nSerão consideradas as datas de inclusão e alteração do lançamento de Contas a Pagar conforme definido nos campos \"filtrar_apenas_inclusao\" e \"filtrar_apenas_alteracao\"."},"filtrar_apenas_inclusao":{"type":"string","maxLength":1,"description":"Filtra os registros exibindos apenas os incluídos.\n\nInformar \"S\" ou \"N\".\n\nO valor padrão para esse campo é \"N\"."},"filtrar_apenas_alteracao":{"type":"string","maxLength":1,"description":"Filtra os registros exibindos apenas os alterados.\n\nInformar \"S\" ou \"N\".\n\nO valor padrão para esse campo é \"N\"."},"filtrar_por_emissao_de":{"type":"string","maxLength":10},"filtrar_por_registro_de":{"type":"string","maxLength":10},"filtrar_por_emissao_ate":{"type":"string","maxLength":10},"filtrar_por_registro_ate":{"type":"string","maxLength":10},"filtrar_conta_corrente":{"type":"integer","maxLength":15,"description":"Filtrar os lançamentos de Contas a Pagar por código da conta corrente.\n\nUtilize a tag \"codigo\" do método \"PesquisarContaCorrente\" da API\nhttp://app.omie.com.br/api/v1/geral/contacorrente/\npara obter essa informação."},"filtrar_cliente":{"type":"integer","maxLength":15,"description":"Filtrar os lançamentos de Contas a Pagar por código do cliente.\n\nUtilize a tag \"codigo_cliente_omie\" do método \"ListarClientes\" da API\nhttp://app.omie.com.br/api/v1/geral/clientes/\npara obter essa informação."},"filtrar_por_cpf_cnpj":{"type":"string","maxLength":20,"description":"Filtrar os títulos por CPF/CNPJ.\n\nInformar apenas números."},"filtrar_por_status":{"type":"string","maxLength":100,"description":"Filtrar por status.\n\nValores disponíveis:\nCANCELADO,\nPAGO,\nLIQUIDADO\nEMABERTO\nPAGTO_PARCIAL\nVENCEHOJE\nAVENCER\nATRASADO"},"filtrar_por_projeto":{"type":"integer","maxLength":15,"description":"Código do Projeto.\n\nInformação localizada na Aba \"Detalhes\" do Contas a Pagar.\n\nUtilize a tag \"codigo\" do método \"ListarProjetos\" da API\nhttp://app.omie.com.br/api/v1/geral/projetos/\npara obter essa informação."},"filtrar_por_vendedor":{"type":"integer","maxLength":15,"description":"Código do Vendedor.\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar.\n\nUtilize a tag \"codigo\" do método \"ListarVendedores\" da API\nhttp://app.omie.com.br/api/v1/geral/vendedores/\npara obter essa informação."},"filtrar_apenas_titulos_em_aberto":{"type":"string","maxLength":1,"description":"DEPRECATED."},"exibir_obs":{"type":"string","maxLength":1,"description":"Exibir as observações do lançamento (S/N).\n\nPreencher com \"S\" ou \"N\".\n\nDefault \"N\""}}}}},"example":{"call":"ListarContasPagar","param":[{"pagina":1,"registros_por_pagina":20,"apenas_importado_api":"N"}]}},"financas_contapagar_ListarContasPagar_retorno":{"type":"object","properties":{"pagina":{"type":"integer"},"total_de_paginas":{"type":"integer"},"registros":{"type":"integer"},"total_de_registros":{"type":"integer"},"conta_pagar_cadastro":{"type":"array","items":{"type":"object","properties":{"codigo_lancamento_omie":{"type":"integer","description":"Código do Lançamento de Contas a Pagar. Informe esse campo somente para pesquisa. Esse campo não é exibido na tela do Contas a Pagar mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs."},"codigo_lancamento_integracao":{"type":"string","description":"Código de Integração do Lançamento de Contas a Pagar. Preencha esse campo com o código do lançamento do Contas a Pagar no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de Contas a Pagar você conseguirá ver a relação entre o id do Contas a Pagar gerado no Omie e o código do Contas a Pagar existente em sua aplicação."},"codigo_cliente_fornecedor":{"type":"integer","description":"Código do Favorecido / Fornecedor. Utilize a tag \"codigo_cliente_omie\" do método \"ListarClientes\" da API http://app.omie.com.br/api/v1/geral/clientes/ para obter essa informação."},"codigo_cliente_fornecedor_integracao":{"type":"string","description":"Código de Integração do Favorecido / Fornecedor. Esse campo deve ser informado apenas se você incluiu o cliente via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag \"codigo_cliente_omie\"."},"data_vencimento":{"type":"string","description":"Data de Vencimento. Utilize o formato \"dd/mm/aaaa\". Esse campo indica a data da vencimento do título e deve ser informado com uma data igual ou superior a data corrente."},"valor_documento":{"type":"decimal","description":"Valor da Conta."},"codigo_categoria":{"type":"string","description":"Código da Categoria. Caso não preenchido, assumirá a categoria padrão para o fornecedor informado. Caso não hajá um específico, retornará erro até que um código de categoria válido seja informado. Utilize a tag \"codigo\" do método \"ListarCategorias\" da API http://app.omie.com.br/api/v1/geral/categorias/ para obter essa informação."},"categorias":{"type":"array","items":{"type":"object","properties":{"codigo_categoria":{"type":"string"},"valor":{"type":"decimal"},"percentual":{"type":"decimal","description":"Percentual da categoria"}}}},"data_previsao":{"type":"string","description":"Data da Previsão de Pagamento. Utilize o formato \"dd/mm/aaaa\". Caso não informado, assumirá a data de vencimento informada. Esse campo indica a data da previsão do título e deve ser informado com uma data igual ou superior a data corrente."},"id_conta_corrente":{"type":"integer","description":"Código da Conta Corrente. Caso não informado, assumirá o padrão para o fornecedor. Caso não haja um padrão definido, retornará erro até que uma Conta Corrente válida seja informada. Utilize a tag \"codigo\" do método \"PesquisarContaCorrente\" da API http://app.omie.com.br/api/v1/geral/contacorrente/ para obter essa informação."},"numero_documento_fiscal":{"type":"string","description":"Número da Nota Fiscal associada ao lançamento de Contas a Pagar. Informação localizada na Aba \"Detalhes\" do Contas a Pagar."},"data_emissao":{"type":"string","description":"Data de Emissão. Caso não informado, assumirá a data corrente. Informação localizada na Aba \"Detalhes\" do Contas a Pagar."},"data_entrada":{"type":"string","description":"Data de Registro. Caso não informado, assumirá a data corrente. Informação localizada na Aba \"Detalhes\" do Contas a Pagar."},"codigo_projeto":{"type":"integer","description":"Código do Projeto. Informação localizada na Aba \"Detalhes\" do Contas a Pagar. Utilize a tag \"codigo\" do método \"ListarProjetos\" da API http://app.omie.com.br/api/v1/geral/projetos/ para obter essa informação."},"observacao":{"type":"string","description":"Observações. Utilize o carater ( | ) pipe como separador de linhas. Informação localizada na Aba \"Detalhes\" do Contas a Pagar."},"valor_pis":{"type":"decimal","description":"Valor PIS. Informação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_pis":{"type":"string","description":"Reter PIS. Informar \"S\" ou \"N\". Se não informado, será assumido \"N\" por padrão. Informação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_cofins":{"type":"decimal","description":"Valor COFINS. Informação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_cofins":{"type":"string","description":"Reter COFINS. Informar \"S\" ou \"N\". Se não informado, será assumido \"N\" por padrão. Informação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_csll":{"type":"decimal","description":"Valor CSLL. Informação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_csll":{"type":"string","description":"Reter CSLL. Informar \"S\" ou \"N\". Se não informado, será assumido \"N\" por padrão. Informação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_ir":{"type":"decimal","description":"Valor IR. Informação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_ir":{"type":"string","description":"Reter IR. Informar \"S\" ou \"N\". Se não informado, será assumido \"N\" por padrão. Informação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_iss":{"type":"decimal","description":"Valor ISS. Informação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_iss":{"type":"string","description":"Reter ISS. Informar \"S\" ou \"N\". Se não informado, será assumido \"N\" por padrão. Informação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_inss":{"type":"decimal","description":"Valor INSS. Informação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_inss":{"type":"string","description":"Reter INSS. Informar \"S\" ou \"N\". Se não informado, será assumido \"N\" por padrão. Informação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"distribuicao":{"type":"array","items":{"type":"object","properties":{"cCodDep":{"type":"string","description":"Código do Departamento"},"cDesDep":{"type":"string","description":"Descrição do Departamento"},"nValDep":{"type":"decimal","description":"Valor do rateio"},"nPerDep":{"type":"decimal","description":"Percentual do rateio"}}},"description":"Distribuição por Departamentos."},"numero_pedido":{"type":"string","description":"Número do Pedido. Informação localizada na Aba \"Diversos\" do Contas a Pagar."},"codigo_tipo_documento":{"type":"string","description":"Código do Tipo de Documento. Informação localizada na Aba \"Diversos\" do Contas a Pagar."},"numero_documento":{"type":"string","description":"Número do Documento. Informação localizada na Aba \"Diversos\" do Contas a Pagar."},"numero_parcela":{"type":"string","description":"Número da parcela. Utilizar o formato \"999/999\". Para 1 parcela utilize \"001/001\" Se não informado assumirá o valor \"001/001\". Informação localizada na Aba \"Diversos\" do Contas a Pagar."},"chave_nfe":{"type":"string","description":"Chave da NF.e. Informação localizada na Aba \"Diversos\" do Contas a Pagar."},"codigo_barras_ficha_compensacao":{"type":"string","description":"Código de Barras Informação localizada na Aba \"Diversos\" do Contas a Pagar."},"codigo_vendedor":{"type":"integer","description":"Código do Vendedor. Informação localizada na Aba \"Diversos\" do Contas a Pagar. Utilize a tag \"codigo\" do método \"ListarVendedores\" da API http://app.omie.com.br/api/v1/geral/vendedores/ para obter essa informação."},"id_origem":{"type":"string","description":"Código da Origem. Informação localizada na Aba \"Diversos\" do Contas a Pagar. Os valores disponíveis são: \"APIP\" - Integração de Conta a Pagar \"BARP\" - Conta a Pagar Importada por Código de Barras \"COMP\" - Parcela a Pagar de Compras \"CTEP\" - Parcela a Pagar de um CT-e \"DEVP\" - Conta a Pagar da Devolução de Venda \"IMPP\" - Parcela a Pagar de uma Nota de Importação \"MANP\" - Lançamento Manual de Conta a Pagar \"NFEP\" - Conta a Pagar Importada de uma NF-e \"RPTP\" - Repetição de Contas a Pagar \"XMLP\" - Conta a Pagar Importada de um arquivo XML"},"info":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração."},"hInc":{"type":"string","description":"Hora da Inclusão. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração."},"uInc":{"type":"string","description":"Usuário da Inclusão. Não deve ser informado na Inclusão/Alteração."},"dAlt":{"type":"string","description":"Data da Alteração. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração."},"hAlt":{"type":"string","description":"Hora da Alteração. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração."},"uAlt":{"type":"string","description":"Usuário da Alteração. Não deve ser informado na Inclusão/Alteração."},"cImpAPI":{"type":"string","description":"Importado pela API (S/N). Não deve ser informado na Inclusão/Alteração."}},"description":"Informações complemetares do cadastro do produto."},"operacao":{"type":"string","description":"Código da Operação. . Esse campo indica qual tipo de operação está associada ao lançamento de Contas a Pagar. Os valores disponíveis são: \"01\" - Venda de Serviço \"11\" - Venda de Produto \"12\" - Venda de Produto pelo PDV \"13\" - Devolução de Venda \"14\" - Remessa de Produto \"16\" - Nota Complementar de Saída"},"status_titulo":{"type":"string","description":"Status do Título. Essa informação é retornada na consulta/pesquisa dos lançamentos de Contas a Pagar."},"nsu":{"type":"string","description":"DEPRECATED."},"acao":{"type":"string","description":"DEPRECATED"},"id_conta_corrente_integracao":{"type":"string","description":"DEPRECATED"},"bloqueado":{"type":"string","description":"DEPRECATED"},"baixa_bloqueada":{"type":"string","description":"DEPRECATED"},"codigo_cmc7_cheque":{"type":"string","description":"DEPRECATED"},"importado_api":{"type":"string","description":"DEPRECATED"},"bloquear_exclusao":{"type":"string","description":"Bloqueia a exclusão do registro. (S/N)"},"cnab_integracao_bancaria":{"type":"object","properties":{"codigo_forma_pagamento":{"type":"string","description":"Código da Forma de Pagamento. Pode ser: TRA - Transferência Bancária. BOL - Pagamento de Boleto. PIX - Transferência via PIX por QR Code."},"banco_transferencia":{"type":"string","description":"Código do Banco para Transferência Bancária."},"agencia_transferencia":{"type":"string","description":"Número da Agência para Transferência Bancária."},"conta_corrente_transferencia":{"type":"string","description":"Número da Conta Corrente para Transferência Bancária."},"finalidade_transferencia":{"type":"string","description":"Finalidade da transferência. Verificar código da Finalidade de acordo com o banco vinculado ao cadastro da conta corrente informada na tag [\"id_conta_corrente\"] Pode ser: 00001 - Pagamento de Impostos, Tributos e Taxas 00002 - Pagamento a Concessionárias de Serviço Público 00003 - Pagamento de Dividendos 00004 - Pagamento de Salários 00005 - Pagamento de Fornecedores 00006 - Pagamento de Honorários 00007 - Pagamento de Aluguéis e Taxas e Condomínio 00008 - Pagamento de Duplicatas e Títulos 00009 - Pagamento de Honorários 00010 - Crédito em Conta 00011 - Pagamento a Corretoras 00016 - Crédito em Conta Investimento 00100 - Depósito Judicial 00101 - Pensão Alimentícia 00200 - Transferência Internacional de Reais 00201 - Ajuste Posição Mercado Futuro 00202 - Repasse de valores do BNDES 00203 - Liquidação de compromisso com BNDES 00204 - Compra/Venda de Ações - Bolsas de Valores e Mercado de Balcão 00205 - Contrato referenciado em Ações/Índices de Ações - BV/BMF 00300 - Restituição de Imposto de Renda 00500 - Restitiuição de Prêmio de Seguros 00501 - Pagamento de indenização de Sinistro de Seguro 00502 - Pagamento de Prêmio de Co-seguro 00503 - Restituição de prêmio de Co-seguro 00504 - Pagamento de indenização de Co-seguro 00505 - Pagamento de prêmio de Resseguro 00506 - Restituição de prêmio de Resseguro 00507 - Pagamento de Indenização de Sinistro de Resseguro 00508 - Restituição de Indenização de Sinistro de Resseguro 00509 - Pagamento de Despesas com Sinistros 00510 - Pagamento de Inspeções/Vistorias Prévias 00511 - Pagamento de Resgate de Título de Capitalização 00512 - Pagamento de Sorteio de Título de Capitalização 00513 - Pagamento de Devolução de Mensalidade de Título de Capitalização 00514 - Restituição de Contribuição de Plano Previdenciário 00515 - Pagamento de Benefício Previdenciário de Pecúlio 00516 - Pagamento de Benefício Previdenciário de Pensão 00517 - Pagamento de Benefício Previdenciário de Aposentadoria 00518 - Pagamento de Resgate Previdenciário 00519 - Pagamento de Comissão de Corretagem 00520 - Pagamento de Transferências/Portabilidade de Reserva de Seguro/Previdência 01 - Crédito em Conta 01 - Crédito em Conta Corrente 01.3 - Transferência por Chave PIX (Obrigatório informar a chave pix na tag \"pix_qrcode\") 02 - Pagamento de Aluguel / Condomínio 03 - Pagamento de Duplicatas e Títulos 04 - Pagamento de Dividendos 05 - Pagamento de Mensalidades Escolares 07 - Pagamento a Fornecedor / Honorários 08 - Pagamento de Câmbio / Fundos / Bolsas 09 - Repasse de Arrecadação / Pagamento de Tributos 11 - DOC / TED para Poupança 12 - DOC / TED para Depósito Judicial 13 - Pensão Alimentícia 14 - Restituição de Imposto de Renda 99 - Outros 99999 - Outros"},"cpf_cnpj_transferencia":{"type":"string","description":"CNPJ ou CPF do Titular."},"nome_transferencia":{"type":"string","description":"Nome do Titular da Conta Corrente."},"codigo_barras_boleto":{"type":"string","description":"Código de Barras (de Cobrança Bancária, de Concessionária ou de Impostos)"},"juros_boleto":{"type":"decimal","description":"Percentual de Juros ao Mês do Boleto."},"multa_boleto":{"type":"decimal","description":"Percentual de Multa por Atraso do Boleto."},"pix_qrcode":{"type":"string","description":"QR Code do PIX."}},"description":"Dados do CNAB e Integração Bancária."},"servico_tomado":{"type":"object","properties":{"numero_nf":{"type":"string","description":"Número da Nota Fiscal."},"serie_nf":{"type":"string","description":"Série da Nota Fiscal."},"codigo_servico":{"type":"string","description":"Código do serviço (LC116)."},"valor_nf":{"type":"decimal","description":"Valor total da Nota Fiscal."},"cst_pis":{"type":"string","description":"CST do PIS (Código da Situação Tributária)."},"base_pis":{"type":"decimal","description":"Base de cálculo do PIS."},"aliquota_pis":{"type":"decimal","description":"Alíquota do PIS (%)."},"valor_pis":{"type":"decimal","description":"Valor do PIS."},"cst_cofins":{"type":"string","description":"CST do COFINS (Código da Situação Tributária)."},"base_cofins":{"type":"decimal","description":"Base de cálculo do COFINS."},"aliquota_cofins":{"type":"decimal","description":"Alíquota do COFINS (%)."},"valor_cofins":{"type":"decimal","description":"Valor do PIS."}}},"valor_pag":{"type":"decimal","description":"Valor a pagar. Disponível apenas para os métodos de consulta e listagem."},"aprendizado_rateio":{"type":"string","description":"Aprendizado de rateio de departamento. Preencher com \"S\" ou \"N\". Default \"N\" Quando essa tag for preenchida com \"S\" será assumido o rateio de departamento para a categoria informada na tag \"codigo_categoria\". Essa tag é utilizada apenas nos métodos de inclusão e alteração."},"baixar_documento":{"type":"string","description":"Efetua a baixa automática do documento."},"conciliar_documento":{"type":"string","description":"Efetua a conciliação do documento automaticamente. Opcional. Preencher com S/N."},"pagamento":{"type":"object","properties":{"codigo_pagamento_integracao":{"type":"string"},"codigo_conta_corrente":{"type":"integer","description":"Código da Conta Corrente."},"valor":{"type":"decimal","description":"Valor a ser baixado."},"desconto":{"type":"decimal","description":"Valor do desconto."},"juros":{"type":"decimal","description":"Valor do Juros."},"multa":{"type":"decimal","description":"Valor da multa."},"data":{"type":"string","description":"Data da Baixa"},"observacao":{"type":"string","description":"Observação da Baixa do Contas a Receber."}},"description":"Detalhes do pagamento(baixa). Informe aqui os detalhes do pagamento do lançamento. Ao preencher esse campo é possível detalhar informações da baixa do documento, como: Valor pago, Desconto, Juros, Multa, etc. Quando essa tag estiver preenchida é obrigatório o preenchimento da tag \"baixar_documento\" com \"S\" Caso essa tag não seja preenchida o lançamento será baixado de forma integral de acordo com os valores do lançamento. Essa tag é utilizada apenas nos métodos de Inclusão e Alteração. Informação localizada na Aba \"Pagamentos\" no cadastro do lançamento."}}}}},"title":"ListarContasPagar (retorno)"},"financas_contapagar_UpsertContaPagar":{"type":"object","title":"UpsertContaPagar","description":"Upsert do Contas a Pagar","required":["call","param"],"properties":{"call":{"type":"string","enum":["UpsertContaPagar"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_lancamento_omie":{"type":"integer","maxLength":15,"description":"Código do Lançamento de Contas a Pagar.\nInforme esse campo somente para pesquisa.\n\nEsse campo não é exibido na tela do Contas a Pagar mas é a chave de integração via API.\nÉ uma informação interna, utilizada apenas nas APIs."},"codigo_lancamento_integracao":{"type":"string","maxLength":60,"description":"Código de Integração do Lançamento de Contas a Pagar.\n\nPreencha esse campo com o código do lançamento do Contas a Pagar no aplicativo que você está integração com o Omie.\nA função dele é servir como uma mapa de relacionamento entre as aplicações.\nAo realizar uma consulta/listagem de Contas a Pagar você conseguirá ver a relação entre o id do Contas a Pagar gerado no Omie e o código do Contas a Pagar existente em sua aplicação."},"codigo_cliente_fornecedor":{"type":"integer","maxLength":15,"description":"Código do Favorecido / Fornecedor.\n\nUtilize a tag \"codigo_cliente_omie\" do método \"ListarClientes\" da API\nhttp://app.omie.com.br/api/v1/geral/clientes/\npara obter essa informação."},"codigo_cliente_fornecedor_integracao":{"type":"string","maxLength":60,"description":"Código de Integração do Favorecido / Fornecedor.\n\nEsse campo deve ser informado apenas se você incluiu o cliente via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag \"codigo_cliente_omie\"."},"data_vencimento":{"type":"string","maxLength":10,"description":"Data de Vencimento.\n\nUtilize o formato \"dd/mm/aaaa\".\n\nEsse campo indica a data da vencimento do título e deve ser informado com uma data igual ou superior a data corrente."},"valor_documento":{"type":"number","maxLength":18,"description":"Valor da Conta."},"codigo_categoria":{"type":"string","maxLength":20,"description":"Código da Categoria.\n\nCaso não preenchido, assumirá a categoria padrão para o fornecedor informado. Caso não hajá um específico, retornará erro até que um código de categoria válido seja informado.\n\nUtilize a tag \"codigo\" do método \"ListarCategorias\" da API\nhttp://app.omie.com.br/api/v1/geral/categorias/\npara obter essa informação."},"categorias":{"type":"array","items":{"type":"object","properties":{"codigo_categoria":{"type":"string","maxLength":20},"valor":{"type":"number","maxLength":18},"percentual":{"type":"number","maxLength":10,"description":"Percentual da categoria"}}}},"data_previsao":{"type":"string","maxLength":10,"description":"Data da Previsão de Pagamento.\n\nUtilize o formato \"dd/mm/aaaa\".\n\nCaso não informado, assumirá a data de vencimento informada.\n\nEsse campo indica a data da previsão do título e deve ser informado com uma data igual ou superior a data corrente."},"id_conta_corrente":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente.\n\nCaso não informado, assumirá o padrão para o fornecedor. Caso não haja um padrão definido, retornará erro até que uma Conta Corrente válida seja informada.\n\nUtilize a tag \"codigo\" do método \"PesquisarContaCorrente\" da API\nhttp://app.omie.com.br/api/v1/geral/contacorrente/\npara obter essa informação."},"numero_documento_fiscal":{"type":"string","maxLength":20,"description":"Número da Nota Fiscal associada ao lançamento de Contas a Pagar.\n\nInformação localizada na Aba \"Detalhes\" do Contas a Pagar."},"data_emissao":{"type":"string","maxLength":10,"description":"Data de Emissão.\n\nCaso não informado, assumirá a data corrente.\n\nInformação localizada na Aba \"Detalhes\" do Contas a Pagar."},"data_entrada":{"type":"string","maxLength":10,"description":"Data de Registro.\n\nCaso não informado, assumirá a data corrente.\n\nInformação localizada na Aba \"Detalhes\" do Contas a Pagar."},"codigo_projeto":{"type":"integer","maxLength":15,"description":"Código do Projeto.\n\nInformação localizada na Aba \"Detalhes\" do Contas a Pagar.\n\nUtilize a tag \"codigo\" do método \"ListarProjetos\" da API\nhttp://app.omie.com.br/api/v1/geral/projetos/\npara obter essa informação."},"observacao":{"type":"string","description":"Observações.\n\nUtilize o carater ( | ) pipe como separador de linhas.\n\nInformação localizada na Aba \"Detalhes\" do Contas a Pagar."},"valor_pis":{"type":"number","maxLength":18,"description":"Valor PIS.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_pis":{"type":"string","maxLength":1,"description":"Reter PIS.\n\nInformar \"S\" ou \"N\".\n\nSe não informado, será assumido \"N\" por padrão.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_cofins":{"type":"number","maxLength":18,"description":"Valor COFINS.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_cofins":{"type":"string","maxLength":1,"description":"Reter COFINS.\n\nInformar \"S\" ou \"N\".\n\nSe não informado, será assumido \"N\" por padrão.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_csll":{"type":"number","maxLength":18,"description":"Valor CSLL.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_csll":{"type":"string","maxLength":1,"description":"Reter CSLL.\n\nInformar \"S\" ou \"N\".\n\nSe não informado, será assumido \"N\" por padrão.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_ir":{"type":"number","maxLength":18,"description":"Valor IR.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_ir":{"type":"string","maxLength":1,"description":"Reter IR.\n\nInformar \"S\" ou \"N\".\n\nSe não informado, será assumido \"N\" por padrão.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_iss":{"type":"number","maxLength":18,"description":"Valor ISS.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_iss":{"type":"string","maxLength":1,"description":"Reter ISS.\n\nInformar \"S\" ou \"N\".\n\nSe não informado, será assumido \"N\" por padrão.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_inss":{"type":"number","maxLength":18,"description":"Valor INSS.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_inss":{"type":"string","maxLength":1,"description":"Reter INSS.\n\nInformar \"S\" ou \"N\".\n\nSe não informado, será assumido \"N\" por padrão.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"distribuicao":{"type":"array","items":{"type":"object","properties":{"cCodDep":{"type":"string","maxLength":40,"description":"Código do Departamento"},"cDesDep":{"type":"string","maxLength":50,"description":"Descrição do Departamento"},"nValDep":{"type":"number","maxLength":18,"description":"Valor do rateio"},"nPerDep":{"type":"number","maxLength":10,"description":"Percentual do rateio"}}},"description":"Distribuição por Departamentos."},"numero_pedido":{"type":"string","maxLength":15,"description":"Número do Pedido.\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar."},"codigo_tipo_documento":{"type":"string","maxLength":5,"description":"Código do Tipo de Documento.\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar."},"numero_documento":{"type":"string","maxLength":20,"description":"Número do Documento.\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar."},"numero_parcela":{"type":"string","maxLength":7,"description":"Número da parcela.\n\nUtilizar o formato \"999/999\".\n\nPara 1 parcela utilize \"001/001\"\n\nSe não informado assumirá o valor \"001/001\".\nInformação localizada na Aba \"Diversos\" do Contas a Pagar."},"chave_nfe":{"type":"string","maxLength":44,"description":"Chave da NF.e.\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar."},"codigo_barras_ficha_compensacao":{"type":"string","maxLength":70,"description":"Código de Barras\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar."},"codigo_vendedor":{"type":"integer","maxLength":15,"description":"Código do Vendedor.\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar.\n\nUtilize a tag \"codigo\" do método \"ListarVendedores\" da API\nhttp://app.omie.com.br/api/v1/geral/vendedores/\npara obter essa informação."},"id_origem":{"type":"string","maxLength":4,"description":"Código da Origem.\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar.\n\nOs valores disponíveis são:\n\n\"APIP\" - Integração de Conta a Pagar\n\"BARP\" - Conta a Pagar Importada por Código de Barras\n\"COMP\" - Parcela a Pagar de Compras\n\"CTEP\" - Parcela a Pagar de um CT-e\n\"DEVP\" - Conta a Pagar da Devolução de Venda\n\"IMPP\" - Parcela a Pagar de uma Nota de Importação\n\"MANP\" - Lançamento Manual de Conta a Pagar\n\"NFEP\" - Conta a Pagar Importada de uma NF-e\n\"RPTP\" - Repetição de Contas a Pagar\n\"XMLP\" - Conta a Pagar Importada de um arquivo XML"},"info":{"type":"object","properties":{"dInc":{"type":"string","maxLength":10,"description":"Data da Inclusão.\nNo formato dd/mm/aaaa.\n\nNão deve ser informado na Inclusão/Alteração."},"hInc":{"type":"string","maxLength":8,"description":"Hora da Inclusão.\nNo formato hh:mm:ss.\n\nNão deve ser informado na Inclusão/Alteração."},"uInc":{"type":"string","maxLength":10,"description":"Usuário da Inclusão.\n\nNão deve ser informado na Inclusão/Alteração."},"dAlt":{"type":"string","maxLength":10,"description":"Data da Alteração.\nNo formato dd/mm/aaaa.\n\nNão deve ser informado na Inclusão/Alteração."},"hAlt":{"type":"string","maxLength":8,"description":"Hora da Alteração.\nNo formato hh:mm:ss.\n\nNão deve ser informado na Inclusão/Alteração."},"uAlt":{"type":"string","maxLength":10,"description":"Usuário da Alteração.\n\nNão deve ser informado na Inclusão/Alteração."},"cImpAPI":{"type":"string","maxLength":1,"description":"Importado pela API (S/N).\n\nNão deve ser informado na Inclusão/Alteração."}},"description":"Informações complemetares do cadastro do produto."},"operacao":{"type":"string","maxLength":2,"description":"Código da Operação. .\n\nEsse campo indica qual tipo de operação está associada ao lançamento de Contas a Pagar.\n\nOs valores disponíveis são:\n\n\"01\" - Venda de Serviço\n\"11\" - Venda de Produto\n\"12\" - Venda de Produto pelo PDV\n\"13\" - Devolução de Venda\n\"14\" - Remessa de Produto\n\"16\" - Nota Complementar de Saída"},"status_titulo":{"type":"string","maxLength":3,"description":"Status do Título.\n\nEssa informação é retornada na consulta/pesquisa dos lançamentos de Contas a Pagar."},"nsu":{"type":"string","maxLength":100,"description":"DEPRECATED."},"acao":{"deprecated":true,"type":"string","description":"DEPRECATED"},"id_conta_corrente_integracao":{"deprecated":true,"type":"string","maxLength":20,"description":"DEPRECATED"},"bloqueado":{"deprecated":true,"type":"string","maxLength":1,"description":"DEPRECATED"},"baixa_bloqueada":{"deprecated":true,"type":"string","maxLength":1,"description":"DEPRECATED"},"codigo_cmc7_cheque":{"deprecated":true,"type":"string","maxLength":40,"description":"DEPRECATED"},"importado_api":{"deprecated":true,"type":"string","maxLength":1,"description":"DEPRECATED"},"bloquear_exclusao":{"type":"string","maxLength":1,"description":"Bloqueia a exclusão do registro. (S/N)"},"cnab_integracao_bancaria":{"type":"object","properties":{"codigo_forma_pagamento":{"type":"string","maxLength":3,"description":"Código da Forma de Pagamento.\n\n\nPode ser:\n\nTRA - Transferência Bancária.\nBOL - Pagamento de Boleto.\nPIX - Transferência via PIX por QR Code."},"banco_transferencia":{"type":"string","maxLength":3,"description":"Código do Banco para Transferência Bancária."},"agencia_transferencia":{"type":"string","maxLength":10,"description":"Número da Agência para Transferência Bancária."},"conta_corrente_transferencia":{"type":"string","maxLength":25,"description":"Número da Conta Corrente para Transferência Bancária."},"finalidade_transferencia":{"type":"string","maxLength":10,"description":"Finalidade da transferência.\n\n\nVerificar código da Finalidade de acordo com o banco vinculado ao cadastro da conta corrente informada na tag [\"id_conta_corrente\"]\n\nPode ser:\n00001 - Pagamento de Impostos, Tributos e Taxas\n00002 - Pagamento a Concessionárias de Serviço Público\n00003 - Pagamento de Dividendos\n00004 - Pagamento de Salários\n00005 - Pagamento de Fornecedores\n00006 - Pagamento de Honorários\n00007 - Pagamento de Aluguéis e Taxas e Condomínio\n00008 - Pagamento de Duplicatas e Títulos\n00009 - Pagamento de Honorários\n00010 - Crédito em Conta\n00011 - Pagamento a Corretoras\n00016 - Crédito em Conta Investimento\n00100 - Depósito Judicial\n00101 - Pensão Alimentícia\n00200 - Transferência Internacional de Reais\n00201 - Ajuste Posição Mercado Futuro\n00202 - Repasse de valores do BNDES\n00203 - Liquidação de compromisso com BNDES\n00204 - Compra/Venda de Ações - Bolsas de Valores e Mercado de Balcão\n00205 - Contrato referenciado em Ações/Índices de Ações - BV/BMF\n00300 - Restituição de Imposto de Renda\n00500 - Restitiuição de Prêmio de Seguros\n00501 - Pagamento de indenização de Sinistro de Seguro\n00502 - Pagamento de Prêmio de Co-seguro\n00503 - Restituição de prêmio de Co-seguro\n00504 - Pagamento de indenização de Co-seguro\n00505 - Pagamento de prêmio de Resseguro\n00506 - Restituição de prêmio de Resseguro\n00507 - Pagamento de Indenização de Sinistro de Resseguro\n00508 - Restituição de Indenização de Sinistro de Resseguro\n00509 - Pagamento de Despesas com Sinistros\n00510 - Pagamento de Inspeções/Vistorias Prévias\n00511 - Pagamento de Resgate de Título de Capitalização\n00512 - Pagamento de Sorteio de Título de Capitalização\n00513 - Pagamento de Devolução de Mensalidade de Título de Capitalização\n00514 - Restituição de Contribuição de Plano Previdenciário\n00515 - Pagamento de Benefício Previdenciário de Pecúlio\n00516 - Pagamento de Benefício Previdenciário de Pensão\n00517 - Pagamento de Benefício Previdenciário de Aposentadoria\n00518 - Pagamento de Resgate Previdenciário\n00519 - Pagamento de Comissão de Corretagem\n00520 - Pagamento de Transferências/Portabilidade de Reserva de Seguro/Previdência\n01 - Crédito em Conta\n01 - Crédito em Conta Corrente\n01.3 - Transferência por Chave PIX (Obrigatório informar a chave pix na tag \"pix_qrcode\")\n02 - Pagamento de Aluguel / Condomínio\n03 - Pagamento de Duplicatas e Títulos\n04 - Pagamento de Dividendos\n05 - Pagamento de Mensalidades Escolares\n07 - Pagamento a Fornecedor / Honorários\n08 - Pagamento de Câmbio / Fundos / Bolsas\n09 - Repasse de Arrecadação / Pagamento de Tributos\n11 - DOC / TED para Poupança\n12 - DOC / TED para Depósito Judicial\n13 - Pensão Alimentícia\n14 - Restituição de Imposto de Renda\n99 - Outros\n99999 - Outros"},"cpf_cnpj_transferencia":{"type":"string","maxLength":20,"description":"CNPJ ou CPF do Titular."},"nome_transferencia":{"type":"string","maxLength":60,"description":"Nome do Titular da Conta Corrente."},"codigo_barras_boleto":{"type":"string","maxLength":70,"description":"Código de Barras (de Cobrança Bancária, de Concessionária ou de Impostos)"},"juros_boleto":{"type":"number","maxLength":10,"description":"Percentual de Juros ao Mês do Boleto."},"multa_boleto":{"type":"number","maxLength":10,"description":"Percentual de Multa por Atraso do Boleto."},"pix_qrcode":{"type":"string","maxLength":300,"description":"QR Code do PIX."}},"required":["finalidade_transferencia"],"description":"Dados do CNAB e Integração Bancária."},"servico_tomado":{"type":"object","properties":{"numero_nf":{"type":"string","maxLength":20,"description":"Número da Nota Fiscal."},"serie_nf":{"type":"string","maxLength":20,"description":"Série da Nota Fiscal."},"codigo_servico":{"type":"string","maxLength":10,"description":"Código do serviço (LC116)."},"valor_nf":{"type":"number","maxLength":18,"description":"Valor total da Nota Fiscal."},"cst_pis":{"type":"string","maxLength":2,"description":"CST do PIS (Código da Situação Tributária)."},"base_pis":{"type":"number","maxLength":18,"description":"Base de cálculo do PIS."},"aliquota_pis":{"type":"number","maxLength":18,"description":"Alíquota do PIS (%)."},"valor_pis":{"type":"number","maxLength":18,"description":"Valor do PIS."},"cst_cofins":{"type":"string","maxLength":2,"description":"CST do COFINS (Código da Situação Tributária)."},"base_cofins":{"type":"number","maxLength":18,"description":"Base de cálculo do COFINS."},"aliquota_cofins":{"type":"number","maxLength":18,"description":"Alíquota do COFINS (%)."},"valor_cofins":{"type":"number","maxLength":18,"description":"Valor do PIS."}}},"valor_pag":{"type":"number","maxLength":18,"description":"Valor a pagar.\n\nDisponível apenas para os métodos de consulta e listagem."},"aprendizado_rateio":{"type":"string","maxLength":1,"description":"Aprendizado de rateio de departamento.\n\nPreencher com \"S\" ou \"N\".\n\nDefault \"N\"\n\nQuando essa tag for preenchida com \"S\" será assumido o rateio de departamento para a categoria informada na tag \"codigo_categoria\".\n\nEssa tag é utilizada apenas nos métodos de inclusão e alteração."},"baixar_documento":{"type":"string","maxLength":1,"description":"Efetua a baixa automática do documento."},"conciliar_documento":{"type":"string","maxLength":1,"description":"Efetua a conciliação do documento automaticamente. Opcional.\n\nPreencher com S/N."},"pagamento":{"type":"object","properties":{"codigo_pagamento_integracao":{"type":"string","maxLength":20},"codigo_conta_corrente":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente."},"valor":{"type":"number","maxLength":18,"description":"Valor a ser baixado."},"desconto":{"type":"number","maxLength":18,"description":"Valor do desconto."},"juros":{"type":"number","maxLength":18,"description":"Valor do Juros."},"multa":{"type":"number","maxLength":18,"description":"Valor da multa."},"data":{"type":"string","maxLength":10,"description":"Data da Baixa"},"observacao":{"type":"string","description":"Observação da Baixa do Contas a Receber."}},"description":"Detalhes do pagamento(baixa).\nInforme aqui os detalhes do pagamento do lançamento.\n\nAo preencher esse campo é possível detalhar informações da baixa do documento, como: Valor pago, Desconto, Juros, Multa, etc.\n\nQuando essa tag estiver preenchida é obrigatório o preenchimento da tag \"baixar_documento\" com \"S\"\n\nCaso essa tag não seja preenchida o lançamento será baixado de forma integral de acordo com os valores do lançamento.\n\nEssa tag é utilizada apenas nos métodos de Inclusão e Alteração.\n\nInformação localizada na Aba \"Pagamentos\" no cadastro do lançamento."}},"required":["pagamento"]}}},"example":{"call":"UpsertContaPagar","param":[{"codigo_lancamento_integracao":"1790774898","codigo_cliente_fornecedor":4214850,"data_vencimento":"30/09/2026","valor_documento":100.0,"codigo_categoria":"2.04.01","data_previsao":"30/09/2026","id_conta_corrente":4243124}]}},"financas_contapagar_UpsertContaPagar_retorno":{"type":"object","properties":{"codigo_lancamento_omie":{"type":"integer","description":"Código do Lançamento de Contas a Pagar. Informe esse campo somente para pesquisa. Esse campo não é exibido na tela do Contas a Pagar mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs."},"codigo_lancamento_integracao":{"type":"string","description":"Código de Integração do Lançamento de Contas a Pagar. Preencha esse campo com o código do lançamento do Contas a Pagar no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de Contas a Pagar você conseguirá ver a relação entre o id do Contas a Pagar gerado no Omie e o código do Contas a Pagar existente em sua aplicação."},"codigo_status":{"type":"string","description":"Código do Status de Processamento. Quando retornar 0 (zero) indica que o processamento foi executado com sucesso. Qualquer outro valor maior que 0 (zero) indica que ocorreu uma falha durante o processo de validação dos dados."},"descricao_status":{"type":"string","description":"Descrição do Status de Processamento. Descreve o resultado do processando, de acordo com o código de status retornado."}},"title":"UpsertContaPagar (retorno)"},"financas_contapagar_UpsertContaPagarPorLote":{"type":"object","title":"UpsertContaPagarPorLote","description":"Efetua o UPSERT do Contas a Pagar por Lote","required":["call","param"],"properties":{"call":{"type":"string","enum":["UpsertContaPagarPorLote"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"lote":{"type":"integer","maxLength":15,"description":"Número do Lote"},"conta_pagar_cadastro":{"type":"array","items":{"type":"object","properties":{"codigo_lancamento_omie":{"type":"integer","maxLength":15,"description":"Código do Lançamento de Contas a Pagar.\nInforme esse campo somente para pesquisa.\n\nEsse campo não é exibido na tela do Contas a Pagar mas é a chave de integração via API.\nÉ uma informação interna, utilizada apenas nas APIs."},"codigo_lancamento_integracao":{"type":"string","maxLength":60,"description":"Código de Integração do Lançamento de Contas a Pagar.\n\nPreencha esse campo com o código do lançamento do Contas a Pagar no aplicativo que você está integração com o Omie.\nA função dele é servir como uma mapa de relacionamento entre as aplicações.\nAo realizar uma consulta/listagem de Contas a Pagar você conseguirá ver a relação entre o id do Contas a Pagar gerado no Omie e o código do Contas a Pagar existente em sua aplicação."},"codigo_cliente_fornecedor":{"type":"integer","maxLength":15,"description":"Código do Favorecido / Fornecedor.\n\nUtilize a tag \"codigo_cliente_omie\" do método \"ListarClientes\" da API\nhttp://app.omie.com.br/api/v1/geral/clientes/\npara obter essa informação."},"codigo_cliente_fornecedor_integracao":{"type":"string","maxLength":60,"description":"Código de Integração do Favorecido / Fornecedor.\n\nEsse campo deve ser informado apenas se você incluiu o cliente via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag \"codigo_cliente_omie\"."},"data_vencimento":{"type":"string","maxLength":10,"description":"Data de Vencimento.\n\nUtilize o formato \"dd/mm/aaaa\".\n\nEsse campo indica a data da vencimento do título e deve ser informado com uma data igual ou superior a data corrente."},"valor_documento":{"type":"number","maxLength":18,"description":"Valor da Conta."},"codigo_categoria":{"type":"string","maxLength":20,"description":"Código da Categoria.\n\nCaso não preenchido, assumirá a categoria padrão para o fornecedor informado. Caso não hajá um específico, retornará erro até que um código de categoria válido seja informado.\n\nUtilize a tag \"codigo\" do método \"ListarCategorias\" da API\nhttp://app.omie.com.br/api/v1/geral/categorias/\npara obter essa informação."},"categorias":{"type":"array","items":{"type":"object","properties":{"codigo_categoria":{"type":"string","maxLength":20},"valor":{"type":"number","maxLength":18},"percentual":{"type":"number","maxLength":10,"description":"Percentual da categoria"}}}},"data_previsao":{"type":"string","maxLength":10,"description":"Data da Previsão de Pagamento.\n\nUtilize o formato \"dd/mm/aaaa\".\n\nCaso não informado, assumirá a data de vencimento informada.\n\nEsse campo indica a data da previsão do título e deve ser informado com uma data igual ou superior a data corrente."},"id_conta_corrente":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente.\n\nCaso não informado, assumirá o padrão para o fornecedor. Caso não haja um padrão definido, retornará erro até que uma Conta Corrente válida seja informada.\n\nUtilize a tag \"codigo\" do método \"PesquisarContaCorrente\" da API\nhttp://app.omie.com.br/api/v1/geral/contacorrente/\npara obter essa informação."},"numero_documento_fiscal":{"type":"string","maxLength":20,"description":"Número da Nota Fiscal associada ao lançamento de Contas a Pagar.\n\nInformação localizada na Aba \"Detalhes\" do Contas a Pagar."},"data_emissao":{"type":"string","maxLength":10,"description":"Data de Emissão.\n\nCaso não informado, assumirá a data corrente.\n\nInformação localizada na Aba \"Detalhes\" do Contas a Pagar."},"data_entrada":{"type":"string","maxLength":10,"description":"Data de Registro.\n\nCaso não informado, assumirá a data corrente.\n\nInformação localizada na Aba \"Detalhes\" do Contas a Pagar."},"codigo_projeto":{"type":"integer","maxLength":15,"description":"Código do Projeto.\n\nInformação localizada na Aba \"Detalhes\" do Contas a Pagar.\n\nUtilize a tag \"codigo\" do método \"ListarProjetos\" da API\nhttp://app.omie.com.br/api/v1/geral/projetos/\npara obter essa informação."},"observacao":{"type":"string","description":"Observações.\n\nUtilize o carater ( | ) pipe como separador de linhas.\n\nInformação localizada na Aba \"Detalhes\" do Contas a Pagar."},"valor_pis":{"type":"number","maxLength":18,"description":"Valor PIS.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_pis":{"type":"string","maxLength":1,"description":"Reter PIS.\n\nInformar \"S\" ou \"N\".\n\nSe não informado, será assumido \"N\" por padrão.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_cofins":{"type":"number","maxLength":18,"description":"Valor COFINS.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_cofins":{"type":"string","maxLength":1,"description":"Reter COFINS.\n\nInformar \"S\" ou \"N\".\n\nSe não informado, será assumido \"N\" por padrão.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_csll":{"type":"number","maxLength":18,"description":"Valor CSLL.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_csll":{"type":"string","maxLength":1,"description":"Reter CSLL.\n\nInformar \"S\" ou \"N\".\n\nSe não informado, será assumido \"N\" por padrão.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_ir":{"type":"number","maxLength":18,"description":"Valor IR.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_ir":{"type":"string","maxLength":1,"description":"Reter IR.\n\nInformar \"S\" ou \"N\".\n\nSe não informado, será assumido \"N\" por padrão.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_iss":{"type":"number","maxLength":18,"description":"Valor ISS.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_iss":{"type":"string","maxLength":1,"description":"Reter ISS.\n\nInformar \"S\" ou \"N\".\n\nSe não informado, será assumido \"N\" por padrão.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"valor_inss":{"type":"number","maxLength":18,"description":"Valor INSS.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"retem_inss":{"type":"string","maxLength":1,"description":"Reter INSS.\n\nInformar \"S\" ou \"N\".\n\nSe não informado, será assumido \"N\" por padrão.\n\nInformação localizada na Aba \"Impostos Retidos\" do Contas a Pagar."},"distribuicao":{"type":"array","items":{"type":"object","properties":{"cCodDep":{"type":"string","maxLength":40,"description":"Código do Departamento"},"cDesDep":{"type":"string","maxLength":50,"description":"Descrição do Departamento"},"nValDep":{"type":"number","maxLength":18,"description":"Valor do rateio"},"nPerDep":{"type":"number","maxLength":10,"description":"Percentual do rateio"}}},"description":"Distribuição por Departamentos."},"numero_pedido":{"type":"string","maxLength":15,"description":"Número do Pedido.\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar."},"codigo_tipo_documento":{"type":"string","maxLength":5,"description":"Código do Tipo de Documento.\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar."},"numero_documento":{"type":"string","maxLength":20,"description":"Número do Documento.\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar."},"numero_parcela":{"type":"string","maxLength":7,"description":"Número da parcela.\n\nUtilizar o formato \"999/999\".\n\nPara 1 parcela utilize \"001/001\"\n\nSe não informado assumirá o valor \"001/001\".\nInformação localizada na Aba \"Diversos\" do Contas a Pagar."},"chave_nfe":{"type":"string","maxLength":44,"description":"Chave da NF.e.\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar."},"codigo_barras_ficha_compensacao":{"type":"string","maxLength":70,"description":"Código de Barras\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar."},"codigo_vendedor":{"type":"integer","maxLength":15,"description":"Código do Vendedor.\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar.\n\nUtilize a tag \"codigo\" do método \"ListarVendedores\" da API\nhttp://app.omie.com.br/api/v1/geral/vendedores/\npara obter essa informação."},"id_origem":{"type":"string","maxLength":4,"description":"Código da Origem.\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar.\n\nOs valores disponíveis são:\n\n\"APIP\" - Integração de Conta a Pagar\n\"BARP\" - Conta a Pagar Importada por Código de Barras\n\"COMP\" - Parcela a Pagar de Compras\n\"CTEP\" - Parcela a Pagar de um CT-e\n\"DEVP\" - Conta a Pagar da Devolução de Venda\n\"IMPP\" - Parcela a Pagar de uma Nota de Importação\n\"MANP\" - Lançamento Manual de Conta a Pagar\n\"NFEP\" - Conta a Pagar Importada de uma NF-e\n\"RPTP\" - Repetição de Contas a Pagar\n\"XMLP\" - Conta a Pagar Importada de um arquivo XML"},"info":{"type":"object","properties":{"dInc":{"type":"string","maxLength":10,"description":"Data da Inclusão.\nNo formato dd/mm/aaaa.\n\nNão deve ser informado na Inclusão/Alteração."},"hInc":{"type":"string","maxLength":8,"description":"Hora da Inclusão.\nNo formato hh:mm:ss.\n\nNão deve ser informado na Inclusão/Alteração."},"uInc":{"type":"string","maxLength":10,"description":"Usuário da Inclusão.\n\nNão deve ser informado na Inclusão/Alteração."},"dAlt":{"type":"string","maxLength":10,"description":"Data da Alteração.\nNo formato dd/mm/aaaa.\n\nNão deve ser informado na Inclusão/Alteração."},"hAlt":{"type":"string","maxLength":8,"description":"Hora da Alteração.\nNo formato hh:mm:ss.\n\nNão deve ser informado na Inclusão/Alteração."},"uAlt":{"type":"string","maxLength":10,"description":"Usuário da Alteração.\n\nNão deve ser informado na Inclusão/Alteração."},"cImpAPI":{"type":"string","maxLength":1,"description":"Importado pela API (S/N).\n\nNão deve ser informado na Inclusão/Alteração."}},"description":"Informações complemetares do cadastro do produto."},"operacao":{"type":"string","maxLength":2,"description":"Código da Operação. .\n\nEsse campo indica qual tipo de operação está associada ao lançamento de Contas a Pagar.\n\nOs valores disponíveis são:\n\n\"01\" - Venda de Serviço\n\"11\" - Venda de Produto\n\"12\" - Venda de Produto pelo PDV\n\"13\" - Devolução de Venda\n\"14\" - Remessa de Produto\n\"16\" - Nota Complementar de Saída"},"status_titulo":{"type":"string","maxLength":3,"description":"Status do Título.\n\nEssa informação é retornada na consulta/pesquisa dos lançamentos de Contas a Pagar."},"nsu":{"type":"string","maxLength":100,"description":"DEPRECATED."},"acao":{"deprecated":true,"type":"string","description":"DEPRECATED"},"id_conta_corrente_integracao":{"deprecated":true,"type":"string","maxLength":20,"description":"DEPRECATED"},"bloqueado":{"deprecated":true,"type":"string","maxLength":1,"description":"DEPRECATED"},"baixa_bloqueada":{"deprecated":true,"type":"string","maxLength":1,"description":"DEPRECATED"},"codigo_cmc7_cheque":{"deprecated":true,"type":"string","maxLength":40,"description":"DEPRECATED"},"importado_api":{"deprecated":true,"type":"string","maxLength":1,"description":"DEPRECATED"},"bloquear_exclusao":{"type":"string","maxLength":1,"description":"Bloqueia a exclusão do registro. (S/N)"},"cnab_integracao_bancaria":{"type":"object","properties":{"codigo_forma_pagamento":{"type":"string","maxLength":3,"description":"Código da Forma de Pagamento.\n\n\nPode ser:\n\nTRA - Transferência Bancária.\nBOL - Pagamento de Boleto.\nPIX - Transferência via PIX por QR Code."},"banco_transferencia":{"type":"string","maxLength":3,"description":"Código do Banco para Transferência Bancária."},"agencia_transferencia":{"type":"string","maxLength":10,"description":"Número da Agência para Transferência Bancária."},"conta_corrente_transferencia":{"type":"string","maxLength":25,"description":"Número da Conta Corrente para Transferência Bancária."},"finalidade_transferencia":{"type":"string","maxLength":10,"description":"Finalidade da transferência.\n\n\nVerificar código da Finalidade de acordo com o banco vinculado ao cadastro da conta corrente informada na tag [\"id_conta_corrente\"]\n\nPode ser:\n00001 - Pagamento de Impostos, Tributos e Taxas\n00002 - Pagamento a Concessionárias de Serviço Público\n00003 - Pagamento de Dividendos\n00004 - Pagamento de Salários\n00005 - Pagamento de Fornecedores\n00006 - Pagamento de Honorários\n00007 - Pagamento de Aluguéis e Taxas e Condomínio\n00008 - Pagamento de Duplicatas e Títulos\n00009 - Pagamento de Honorários\n00010 - Crédito em Conta\n00011 - Pagamento a Corretoras\n00016 - Crédito em Conta Investimento\n00100 - Depósito Judicial\n00101 - Pensão Alimentícia\n00200 - Transferência Internacional de Reais\n00201 - Ajuste Posição Mercado Futuro\n00202 - Repasse de valores do BNDES\n00203 - Liquidação de compromisso com BNDES\n00204 - Compra/Venda de Ações - Bolsas de Valores e Mercado de Balcão\n00205 - Contrato referenciado em Ações/Índices de Ações - BV/BMF\n00300 - Restituição de Imposto de Renda\n00500 - Restitiuição de Prêmio de Seguros\n00501 - Pagamento de indenização de Sinistro de Seguro\n00502 - Pagamento de Prêmio de Co-seguro\n00503 - Restituição de prêmio de Co-seguro\n00504 - Pagamento de indenização de Co-seguro\n00505 - Pagamento de prêmio de Resseguro\n00506 - Restituição de prêmio de Resseguro\n00507 - Pagamento de Indenização de Sinistro de Resseguro\n00508 - Restituição de Indenização de Sinistro de Resseguro\n00509 - Pagamento de Despesas com Sinistros\n00510 - Pagamento de Inspeções/Vistorias Prévias\n00511 - Pagamento de Resgate de Título de Capitalização\n00512 - Pagamento de Sorteio de Título de Capitalização\n00513 - Pagamento de Devolução de Mensalidade de Título de Capitalização\n00514 - Restituição de Contribuição de Plano Previdenciário\n00515 - Pagamento de Benefício Previdenciário de Pecúlio\n00516 - Pagamento de Benefício Previdenciário de Pensão\n00517 - Pagamento de Benefício Previdenciário de Aposentadoria\n00518 - Pagamento de Resgate Previdenciário\n00519 - Pagamento de Comissão de Corretagem\n00520 - Pagamento de Transferências/Portabilidade de Reserva de Seguro/Previdência\n01 - Crédito em Conta\n01 - Crédito em Conta Corrente\n01.3 - Transferência por Chave PIX (Obrigatório informar a chave pix na tag \"pix_qrcode\")\n02 - Pagamento de Aluguel / Condomínio\n03 - Pagamento de Duplicatas e Títulos\n04 - Pagamento de Dividendos\n05 - Pagamento de Mensalidades Escolares\n07 - Pagamento a Fornecedor / Honorários\n08 - Pagamento de Câmbio / Fundos / Bolsas\n09 - Repasse de Arrecadação / Pagamento de Tributos\n11 - DOC / TED para Poupança\n12 - DOC / TED para Depósito Judicial\n13 - Pensão Alimentícia\n14 - Restituição de Imposto de Renda\n99 - Outros\n99999 - Outros"},"cpf_cnpj_transferencia":{"type":"string","maxLength":20,"description":"CNPJ ou CPF do Titular."},"nome_transferencia":{"type":"string","maxLength":60,"description":"Nome do Titular da Conta Corrente."},"codigo_barras_boleto":{"type":"string","maxLength":70,"description":"Código de Barras (de Cobrança Bancária, de Concessionária ou de Impostos)"},"juros_boleto":{"type":"number","maxLength":10,"description":"Percentual de Juros ao Mês do Boleto."},"multa_boleto":{"type":"number","maxLength":10,"description":"Percentual de Multa por Atraso do Boleto."},"pix_qrcode":{"type":"string","maxLength":300,"description":"QR Code do PIX."}},"required":["finalidade_transferencia"],"description":"Dados do CNAB e Integração Bancária."},"servico_tomado":{"type":"object","properties":{"numero_nf":{"type":"string","maxLength":20,"description":"Número da Nota Fiscal."},"serie_nf":{"type":"string","maxLength":20,"description":"Série da Nota Fiscal."},"codigo_servico":{"type":"string","maxLength":10,"description":"Código do serviço (LC116)."},"valor_nf":{"type":"number","maxLength":18,"description":"Valor total da Nota Fiscal."},"cst_pis":{"type":"string","maxLength":2,"description":"CST do PIS (Código da Situação Tributária)."},"base_pis":{"type":"number","maxLength":18,"description":"Base de cálculo do PIS."},"aliquota_pis":{"type":"number","maxLength":18,"description":"Alíquota do PIS (%)."},"valor_pis":{"type":"number","maxLength":18,"description":"Valor do PIS."},"cst_cofins":{"type":"string","maxLength":2,"description":"CST do COFINS (Código da Situação Tributária)."},"base_cofins":{"type":"number","maxLength":18,"description":"Base de cálculo do COFINS."},"aliquota_cofins":{"type":"number","maxLength":18,"description":"Alíquota do COFINS (%)."},"valor_cofins":{"type":"number","maxLength":18,"description":"Valor do PIS."}}},"valor_pag":{"type":"number","maxLength":18,"description":"Valor a pagar.\n\nDisponível apenas para os métodos de consulta e listagem."},"aprendizado_rateio":{"type":"string","maxLength":1,"description":"Aprendizado de rateio de departamento.\n\nPreencher com \"S\" ou \"N\".\n\nDefault \"N\"\n\nQuando essa tag for preenchida com \"S\" será assumido o rateio de departamento para a categoria informada na tag \"codigo_categoria\".\n\nEssa tag é utilizada apenas nos métodos de inclusão e alteração."},"baixar_documento":{"type":"string","maxLength":1,"description":"Efetua a baixa automática do documento."},"conciliar_documento":{"type":"string","maxLength":1,"description":"Efetua a conciliação do documento automaticamente. Opcional.\n\nPreencher com S/N."},"pagamento":{"type":"object","properties":{"codigo_pagamento_integracao":{"type":"string","maxLength":20},"codigo_conta_corrente":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente."},"valor":{"type":"number","maxLength":18,"description":"Valor a ser baixado."},"desconto":{"type":"number","maxLength":18,"description":"Valor do desconto."},"juros":{"type":"number","maxLength":18,"description":"Valor do Juros."},"multa":{"type":"number","maxLength":18,"description":"Valor da multa."},"data":{"type":"string","maxLength":10,"description":"Data da Baixa"},"observacao":{"type":"string","description":"Observação da Baixa do Contas a Receber."}},"description":"Detalhes do pagamento(baixa).\nInforme aqui os detalhes do pagamento do lançamento.\n\nAo preencher esse campo é possível detalhar informações da baixa do documento, como: Valor pago, Desconto, Juros, Multa, etc.\n\nQuando essa tag estiver preenchida é obrigatório o preenchimento da tag \"baixar_documento\" com \"S\"\n\nCaso essa tag não seja preenchida o lançamento será baixado de forma integral de acordo com os valores do lançamento.\n\nEssa tag é utilizada apenas nos métodos de Inclusão e Alteração.\n\nInformação localizada na Aba \"Pagamentos\" no cadastro do lançamento."}},"required":["pagamento"]}}}}}},"example":{"call":"UpsertContaPagarPorLote","param":[{"lote":100,"conta_pagar_cadastro":[{"codigo_lancamento_integracao":"1790774898","codigo_cliente_fornecedor":4214850,"data_vencimento":"30/09/2026","valor_documento":100.0,"codigo_categoria":"2.04.01","data_previsao":"30/09/2026","id_conta_corrente":4243124},{"codigo_lancamento_integracao":"1790774898","codigo_cliente_fornecedor":4214850,"data_vencimento":"30/09/2026","valor_documento":120.0,"codigo_categoria":"2.04.01","data_previsao":"30/09/2026","id_conta_corrente":4243124}]}]}},"financas_contapagar_UpsertContaPagarPorLote_retorno":{"type":"object","properties":{"lote":{"type":"integer","description":"Número do lote processado"},"codigo_status":{"type":"string","description":"Código do Status do processamento"},"descricao_status":{"type":"string","description":"Descrição do Status do Lote"}},"title":"UpsertContaPagarPorLote (retorno)"},"financas_contapagaranexos_lcpConsultarAnexo":{"type":"object","title":"lcpConsultarAnexo","description":"Consulta um anexo de um título do Contas a Pagar.","required":["call","param"],"properties":{"call":{"type":"string","enum":["lcpConsultarAnexo"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodTitulo":{"type":"integer","maxLength":15,"description":"Código do título do Contas a Pagar.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno do título do contas a pagar gerado pelo Omie."},"cCodIntTitulo":{"type":"string","maxLength":60,"description":"Código de integração do título do Contas a Pagar.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código do título utilizado no seu aplicativo quando incluir um título no Omie.\nAssim, poderá utilizar esse campo para resgatar as informações do título desejado.\nCaso informe esse campo, não informe a tag nCodInt. Caso isso aconteça, o conteúdo dessa tag seja desconsiderada."},"cCodIntAnexo":{"type":"string","maxLength":20,"description":"Código de integração do anexo.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nUtilize esse campo para informar o código do anexo utilizado no seu aplicativo quando incluir o anexo no Omie.\nAssim, poderá utilizar esse campo para resgatar o anexo desejado."},"cNomeArq":{"type":"string","maxLength":100,"description":"Nome do arquivo que foi adicionado.\nPreencha essa tag, apenas se você não tiver ou souber qual é o código de integração do anexo (tag cCodIntAnexo).\nCaso a tag cCodIntAnexo esteja preenchida, o conteúdo dessa tag será desconsiderado."}}}}},"example":{"call":"lcpConsultarAnexo","param":[{"nCodTitulo":0,"cCodIntTitulo":"","cCodIntAnexo":"","cNomeArq":""}]}},"financas_contapagaranexos_lcpConsultarAnexo_retorno":{"type":"object","properties":{"nCodTitulo":{"type":"integer","description":"Código do título do Contas a Pagar. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do título do contas a receber gerado pelo Omie."},"cCodIntTitulo":{"type":"string","description":"Código de integração do título do Contas a Pagar. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código do título utilizado no seu aplicativo quando incluir um título no Omie. Assim, poderá utilizar esse campo para resgatar as informações do título desejado. Caso informe esse campo, não informe a tag nCodInt. Caso isso aconteça, o conteúdo dessa tag seja desconsiderada."},"cCodIntAnexo":{"type":"string","description":"Código de integração do anexo. (Interno, utilizado apenas na integração via API, não é exibido na tela). Utilize esse campo para informar o código do anexo utilizado no seu aplicativo quando incluir o anexo no Omie. Assim, poderá utilizar esse campo para resgatar o anexo desejado."},"cNomeArq":{"type":"string","description":"Nome do arquivo que foi adicionado. Preencha essa tag, apenas se você não tiver ou souber qual é o código de integração do anexo (tag cCodIntAnexo). Caso a tag cCodIntAnexo esteja preenchida, o conteúdo dessa tag será desconsiderado."},"info":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão. No formato dd/mm/aaaa."},"hInc":{"type":"string","description":"Hora da Inclusão. No formato hh:mm:ss."},"uInc":{"type":"string","description":"Usuário da Inclusão."},"dAlt":{"type":"string","description":"Data da Alteração. No formato dd/mm/aaaa."},"hAlt":{"type":"string","description":"Hora da Alteração. No formato hh:mm:ss."},"uAlt":{"type":"string","description":"Usuário da Alteração."},"cImpAPI":{"type":"string","description":"Importado pela API (S/N)."}},"description":"Informações complementares do anexo."}},"title":"lcpConsultarAnexo (retorno)"},"financas_contapagaranexos_lcpExcluirAnexo":{"type":"object","title":"lcpExcluirAnexo","description":"Exclui um anexo de um título do Contas a Pagar.","required":["call","param"],"properties":{"call":{"type":"string","enum":["lcpExcluirAnexo"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodTitulo":{"type":"integer","maxLength":15,"description":"Código do título do Contas a Pagar.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno do título do contas a pagar gerado pelo Omie."},"cCodIntTitulo":{"type":"string","maxLength":60,"description":"Código de integração do título do Contas a Pagar.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código do título utilizado no seu aplicativo quando incluir um título no Omie.\nAssim, poderá utilizar esse campo para resgatar as informações do título desejado.\nCaso informe esse campo, não informe a tag nCodInt. Caso isso aconteça, o conteúdo dessa tag seja desconsiderada."},"cCodIntAnexo":{"type":"string","maxLength":20,"description":"Código de integração do anexo.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nUtilize esse campo para informar o código do anexo utilizado no seu aplicativo quando incluir o anexo no Omie.\nAssim, poderá utilizar esse campo para resgatar o anexo desejado."},"cNomeArq":{"type":"string","maxLength":100,"description":"Nome do arquivo que foi adicionado.\nPreencha essa tag, apenas se você não tiver ou souber qual é o código de integração do anexo (tag cCodIntAnexo).\nCaso a tag cCodIntAnexo esteja preenchida, o conteúdo dessa tag será desconsiderado."}}}}},"example":{"call":"lcpExcluirAnexo","param":[{"nCodTitulo":0,"cCodIntTitulo":"","cCodIntAnexo":"","cNomeArq":""}]}},"financas_contapagaranexos_lcpExcluirAnexo_retorno":{"type":"object","properties":{"nCodTitulo":{"type":"integer","description":"Código do título do Contas a Pagar. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do título do contas a pagar gerado pelo Omie."},"cCodIntTitulo":{"type":"string","description":"Código de integração do título do Contas a Pagar. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código do título utilizado no seu aplicativo quando incluir um título no Omie. Assim, poderá utilizar esse campo para resgatar as informações do título desejado. Caso informe esse campo, não informe a tag nCodInt. Caso isso aconteça, o conteúdo dessa tag seja desconsiderada."},"cCodIntAnexo":{"type":"string","description":"Código de integração do anexo. (Interno, utilizado apenas na integração via API, não é exibido na tela). Utilize esse campo para informar o código do anexo utilizado no seu aplicativo quando incluir o anexo no Omie. Assim, poderá utilizar esse campo para resgatar o anexo desejado."},"cNomeArq":{"type":"string","description":"Nome do arquivo que foi adicionado. Preencha essa tag, apenas se você não tiver ou souber qual é o código de integração do anexo (tag cCodIntAnexo). Caso a tag cCodIntAnexo esteja preenchida, o conteúdo dessa tag será desconsiderado."},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro duranteo o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodigoStatus\"."}},"title":"lcpExcluirAnexo (retorno)"},"financas_contapagaranexos_lcpIncluirAnexo":{"type":"object","title":"lcpIncluirAnexo","description":"Inclui um anexo no Contas a Pagar.","required":["call","param"],"properties":{"call":{"type":"string","enum":["lcpIncluirAnexo"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodTitulo":{"type":"integer","maxLength":15,"description":"Código do título do Contas a Pagar.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno do título do contas a pagar gerado pelo Omie."},"cCodIntTitulo":{"type":"string","maxLength":60,"description":"Código de integração do título do Contas a Pagar.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código do título utilizado no seu aplicativo quando incluir um título no Omie.\nAssim, poderá utilizar esse campo para resgatar as informações do título desejado.\nCaso informe esse campo, não informe a tag nCodInt. Caso isso aconteça, o conteúdo dessa tag seja desconsiderada."},"cCodIntAnexo":{"type":"string","maxLength":20,"description":"Código de integração do anexo.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nUtilize esse campo para informar o código do anexo utilizado no seu aplicativo quando incluir o anexo no Omie.\nAssim, poderá utilizar esse campo para resgatar o anexo desejado."},"cNomeArq":{"type":"string","maxLength":100,"description":"Nome do arquivo que foi adicionado.\nPreencha essa tag, apenas se você não tiver ou souber qual é o código de integração do anexo (tag cCodIntAnexo).\nCaso a tag cCodIntAnexo esteja preenchida, o conteúdo dessa tag será desconsiderado."},"cArquivo":{"type":"string","description":"Conteúdo do arquivo a ser anexado, compactado (zip) e convertido   em base 64."},"cMd5":{"type":"string","maxLength":32,"description":"MD5 do arquivo enviado na tag \"cArquivo\"."}},"required":["cArquivo","cMd5","cNomeArq"]}}},"example":{"call":"lcpIncluirAnexo","param":[{"nCodTitulo":0,"cCodIntTitulo":"","cCodIntAnexo":"","cNomeArq":"","cArquivo":"","cMd5":""}]}},"financas_contapagaranexos_lcpIncluirAnexo_retorno":{"type":"object","properties":{"nCodTitulo":{"type":"integer","description":"Código do título do Contas a Pagar. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do título do contas a pagar gerado pelo Omie."},"cCodIntTitulo":{"type":"string","description":"Código de integração do título do Contas a Pagar. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código do título utilizado no seu aplicativo quando incluir um título no Omie. Assim, poderá utilizar esse campo para resgatar as informações do título desejado. Caso informe esse campo, não informe a tag nCodInt. Caso isso aconteça, o conteúdo dessa tag seja desconsiderada."},"cCodIntAnexo":{"type":"string","description":"Código de integração do anexo. (Interno, utilizado apenas na integração via API, não é exibido na tela). Utilize esse campo para informar o código do anexo utilizado no seu aplicativo quando incluir o anexo no Omie. Assim, poderá utilizar esse campo para resgatar o anexo desejado."},"cNomeArq":{"type":"string","description":"Nome do arquivo que foi adicionado. Preencha essa tag, apenas se você não tiver ou souber qual é o código de integração do anexo (tag cCodIntAnexo). Caso a tag cCodIntAnexo esteja preenchida, o conteúdo dessa tag será desconsiderado."},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro duranteo o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodigoStatus\"."}},"title":"lcpIncluirAnexo (retorno)"},"financas_contapagaranexos_lcpListarAnexos":{"type":"object","title":"lcpListarAnexos","description":"Lista os anexos de um título do Contas a Pagar.","required":["call","param"],"properties":{"call":{"type":"string","enum":["lcpListarAnexos"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página que se deseja resgatar.\nO padrão é \"1\"."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Número de registros retornados por página.\nO padrão é 20.\nO limite máximo é 50 por página."},"cOrdenarPor":{"type":"string","maxLength":100,"description":"Ordem os resultados da página por:\nCODIGO - Código do Título.\nCODINT - Código de Integração do Título.\nARQUIVO - Nome do arquivo."},"cOrdemDecrescente":{"type":"string","maxLength":1,"description":"Indica se a ordem de exibição é Decrescente caso seja informado \"S\"."},"dDtIncDe":{"type":"string","maxLength":10,"description":"Data de inclusão inicial.\nNo formato dd/mm/aaaa."},"dDtIncAte":{"type":"string","maxLength":10,"description":"Data de inclusão final.\nNo formato dd/mm/aaaa."},"dDtAltDe":{"type":"string","maxLength":10,"description":"Data de alteração inicial.\nNo formato dd/mm/aaaa."},"dDtAltAte":{"type":"string","maxLength":10,"description":"Data de alteração final.\nNo formato dd/mm/aaaa."},"nCodTitulo":{"type":"integer","maxLength":15,"description":"Código do título do Contas a Receber.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno do título do contas a receber gerado pelo Omie."},"cCodIntTitulo":{"type":"string","maxLength":60,"description":"Código de integração do título do Contas a Receber.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código do título utilizado no seu aplicativo quando incluir um título no Omie.\nAssim, poderá utilizar esse campo para resgatar as informações do título desejado.\nCaso informe esse campo, não informe a tag nCodInt. Caso isso aconteça, o conteúdo dessa tag seja desconsiderada."}}}}},"example":{"call":"lcpListarAnexos","param":[{"nPagina":1,"nRegPorPagina":50,"nCodTitulo":0}]}},"financas_contapagaranexos_lcpListarAnexos_retorno":{"type":"object","properties":{"nPagina":{"type":"integer","description":"Número da página resgatada."},"nTotPaginas":{"type":"integer","description":"Número total de páginas encontradas."},"nRegistros":{"type":"integer","description":"Número de registros retornados na página."},"nTotRegistros":{"type":"integer","description":"Número total de registros encontrados."},"listaAnexos":{"type":"array","items":{"type":"object","properties":{"nCodTitulo":{"type":"integer","description":"Código do título do Contas a Receber. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do título do contas a receber gerado pelo Omie."},"cCodIntTitulo":{"type":"string","description":"Código de integração do título do Contas a Receber. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código do título utilizado no seu aplicativo quando incluir um título no Omie. Assim, poderá utilizar esse campo para resgatar as informações do título desejado. Caso informe esse campo, não informe a tag nCodInt. Caso isso aconteça, o conteúdo dessa tag seja desconsiderada."},"cCodIntAnexo":{"type":"string","description":"Código de integração do anexo. (Interno, utilizado apenas na integração via API, não é exibido na tela). Utilize esse campo para informar o código do anexo utilizado no seu aplicativo quando incluir o anexo no Omie. Assim, poderá utilizar esse campo para resgatar o anexo desejado."},"cNomeArq":{"type":"string","description":"Nome do arquivo que foi adicionado. Preencha essa tag, apenas se você não tiver ou souber qual é o código de integração do anexo (tag cCodIntAnexo). Caso a tag cCodIntAnexo esteja preenchida, o conteúdo dessa tag será desconsiderado."},"info":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão. No formato dd/mm/aaaa."},"hInc":{"type":"string","description":"Hora da Inclusão. No formato hh:mm:ss."},"uInc":{"type":"string","description":"Usuário da Inclusão."},"dAlt":{"type":"string","description":"Data da Alteração. No formato dd/mm/aaaa."},"hAlt":{"type":"string","description":"Hora da Alteração. No formato hh:mm:ss."},"uAlt":{"type":"string","description":"Usuário da Alteração."},"cImpAPI":{"type":"string","description":"Importado pela API (S/N)."}},"description":"Informações complementares do anexo."}}},"description":"Lista de anexos do título do contas a receber encontrados."}},"title":"lcpListarAnexos (retorno)"},"financas_contapagaranexos_lcpObterAnexo":{"type":"object","title":"lcpObterAnexo","description":"Obtém  um anexo de um título do Contas a Pagar.","required":["call","param"],"properties":{"call":{"type":"string","enum":["lcpObterAnexo"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodTitulo":{"type":"integer","maxLength":15,"description":"Código do título do Contas a Pagar.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno do título do contas a pagar gerado pelo Omie."},"cCodIntTitulo":{"type":"string","maxLength":60,"description":"Código de integração do título do Contas a Pagar.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código do título utilizado no seu aplicativo quando incluir um título no Omie.\nAssim, poderá utilizar esse campo para resgatar as informações do título desejado.\nCaso informe esse campo, não informe a tag nCodInt. Caso isso aconteça, o conteúdo dessa tag seja desconsiderada."},"cCodIntAnexo":{"type":"string","maxLength":20,"description":"Código de integração do anexo.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nUtilize esse campo para informar o código do anexo utilizado no seu aplicativo quando incluir o anexo no Omie.\nAssim, poderá utilizar esse campo para resgatar o anexo desejado."},"cNomeArq":{"type":"string","maxLength":100,"description":"Nome do arquivo que foi adicionado.\nPreencha essa tag, apenas se você não tiver ou souber qual é o código de integração do anexo (tag cCodIntAnexo).\nCaso a tag cCodIntAnexo esteja preenchida, o conteúdo dessa tag será desconsiderado."}}}}},"example":{"call":"lcpObterAnexo","param":[{"nCodTitulo":0,"cCodIntTitulo":"","cCodIntAnexo":"","cNomeArq":""}]}},"financas_contapagaranexos_lcpObterAnexo_retorno":{"type":"object","properties":{"nCodTitulo":{"type":"integer","description":"Código do título do Contas a Pagar. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do título do contas a pagar gerado pelo Omie."},"cCodIntTitulo":{"type":"string","description":"Código de integração do título do Contas a Pagar. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código do título utilizado no seu aplicativo quando incluir um título no Omie. Assim, poderá utilizar esse campo para resgatar as informações do título desejado. Caso informe esse campo, não informe a tag nCodInt. Caso isso aconteça, o conteúdo dessa tag seja desconsiderada."},"cCodIntAnexo":{"type":"string","description":"Código de integração do anexo. (Interno, utilizado apenas na integração via API, não é exibido na tela). Utilize esse campo para informar o código do anexo utilizado no seu aplicativo quando incluir o anexo no Omie. Assim, poderá utilizar esse campo para resgatar o anexo desejado."},"cNomeArq":{"type":"string","description":"Nome do arquivo que foi adicionado. Preencha essa tag, apenas se você não tiver ou souber qual é o código de integração do anexo (tag cCodIntAnexo). Caso a tag cCodIntAnexo esteja preenchida, o conteúdo dessa tag será desconsiderado."},"cLinkDownload":{"type":"string","description":"URL para download do anexo solicitado."},"dDtExpiracao":{"type":"string","description":"Data de expiração da url disponibilizada. No formato dd/mm/aaaa."},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro duranteo o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodigoStatus\"."}},"title":"lcpObterAnexo (retorno)"},"financas_contareceberbarras_IncluirContaReceberCodBar":{"type":"object","title":"IncluirContaReceberCodBar","description":"Inclui uma conta a receber a partir de um código de barras.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirContaReceberCodBar"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cCodigoBarras":{"type":"string","maxLength":70,"description":"Código de barras ou linha digitável do boleto."},"nIdCliente":{"type":"integer","maxLength":15,"description":"ID do Cliente.\n\n\nUtilize a tag \"codigo_cliente_omie\" do método \"ListarClientes\" da API\nhttp://app.omie.com.br/api/v1/geral/clientes/\npara obter essa informação."},"cCpfCnpj":{"type":"string","maxLength":60,"description":"CNPJ ou CPF do cliente, usado para localizar o cliente no cadastro.\n\nObrigatório quando nIdCliente não for informado. O cliente precisa estar cadastrado com esse documento."},"dVencimento":{"type":"string","maxLength":10,"description":"Data de vencimento, no formato dd/mm/aaaa.\n\nSe não informada, assume o vencimento lido do código de barras; sem código de barras, é obrigatória."},"dPrevisao":{"type":"string","maxLength":10,"description":"Data da previsão de recebimento, no formato dd/mm/aaaa.\n\nSe não informada, assume a data de hoje."},"vDocumento":{"type":"number","maxLength":18,"description":"Valor da conta.\n\nSe não informado, assume o valor lido do código de barras; sem código de barras, é obrigatório."},"cCodCateg":{"type":"string","maxLength":20,"description":"Código da categoria de receita.\n\nRecomendado informar sempre: se não informado, o padrão é buscado no histórico de contas a pagar do cliente e pode resultar numa categoria de despesa. Sem padrão, a chamada é recusada pedindo a categoria.\n\nUtilize a tag \"codigo\" do método \"ListarCategorias\" da API\nhttp://app.omie.com.br/api/v1/geral/categorias/\npara obter essa informação."},"nIdConta":{"type":"integer","maxLength":15,"description":"Código da conta corrente.\n\nSe não informado, assume a conta padrão do cliente; sem padrão, a chamada é recusada pedindo a conta.\n\nUtilize a tag \"codigo\" do método \"PesquisarContaCorrente\" da API\nhttp://app.omie.com.br/api/v1/geral/contacorrente/\npara obter essa informação."},"cDocumento":{"type":"string","maxLength":20,"description":"Número do documento.\n\nSe não informado, o número do documento fica com o nosso número lido do código de barras.\nInformação localizada na aba \"Diversos\" do Contas a Receber."},"cObservacao":{"type":"string","description":"Observações.\n\nUtilize o caractere ( | ) pipe como separador de linhas. O Omie acrescenta ao final a data, a hora e o usuário da inclusão via integração.\n\nInformação localizada na aba \"Detalhes\" do Contas a Receber."}},"required":["dVencimento","vDocumento"]}}},"example":{"call":"IncluirContaReceberCodBar","param":[{"cCodigoBarras":"","nIdCliente":0,"cCpfCnpj":"","dVencimento":"#TODAY#","dPrevisao":"#TODAY#","vDocumento":0,"cCodCateg":"1.01.02","nIdConta":0,"cDocumento":"","cObservacao":""}]}},"financas_contareceberbarras_IncluirContaReceberCodBar_retorno":{"type":"object","properties":{"nIdTitulo":{"type":"integer","description":"Código do lançamento de contas a receber criado (o mesmo usado nas demais APIs de contas a receber)."},"cCodStatus":{"type":"string","description":"Código do status do processamento. \"0\" indica sucesso."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento."}},"title":"IncluirContaReceberCodBar (retorno)"},"financas_contareceber_AlterarContaReceber":{"type":"object","title":"AlterarContaReceber","description":"Altera um conta a receber","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarContaReceber"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_lancamento_omie":{"type":"integer","maxLength":15,"description":"Chave do Lançamento"},"codigo_lancamento_integracao":{"type":"string","maxLength":60,"description":"Código do lançamento gerado pelo integrador."},"codigo_cliente_fornecedor":{"type":"integer","maxLength":15,"description":"Código de Cliente / Fornecedor"},"codigo_cliente_fornecedor_integracao":{"type":"string","maxLength":60,"description":"Código do cliente informado pelo integrador."},"data_vencimento":{"type":"string","maxLength":10,"description":"Data de Vencimento"},"valor_documento":{"type":"number","maxLength":18,"description":"Valor do Lançamento"},"codigo_categoria":{"type":"string","maxLength":20,"description":"Código da Categoria"},"categorias":{"type":"array","items":{"type":"object","properties":{"codigo_categoria":{"type":"string","maxLength":20},"valor":{"type":"number","maxLength":18},"percentual":{"type":"number","maxLength":10,"description":"Percentual da categoria"}}}},"data_previsao":{"type":"string","maxLength":10,"description":"Data de Previsão de Pagamento/Recebimento"},"id_conta_corrente":{"type":"integer","maxLength":15,"description":"Id da Conta Corrente"},"numero_documento":{"type":"string","maxLength":20,"description":"Número do Documento"},"numero_parcela":{"type":"string","maxLength":7,"description":"Número da parcela \"Formatada\" como 999/999"},"codigo_tipo_documento":{"type":"string","maxLength":5,"description":"Código para o Tipo de Documento"},"numero_documento_fiscal":{"type":"string","maxLength":20,"description":"Número do Documento Fiscal"},"numero_pedido":{"type":"string","maxLength":15,"description":"Número do Pedido"},"chave_nfe":{"type":"string","maxLength":44,"description":"Chave de Acesso da NFE"},"observacao":{"type":"string","description":"Observação"},"codigo_barras_ficha_compensacao":{"type":"string","maxLength":70,"description":"Código de Barras da Ficha de Compensação"},"codigo_cmc7_cheque":{"type":"string","maxLength":40,"description":"Código CMC7 do Cheque"},"data_emissao":{"type":"string","maxLength":10,"description":"Data de Emissão"},"id_origem":{"type":"string","maxLength":4,"description":"Código da Origem.\n\nInformação localizada na Aba \"Diversos\" do Contas a Receber.\n\nOs valores disponíveis são:\n\n\"APIR\" - Integração de Conta a Receber\n\"BARR\" - Conta a Receber Importada por Código de Barras\n\"CTER\" - Parcela a Receber de um CT-e\n\"DEVR\" - Conta a Receber da Devolução ao Fornecedor\n\"MANR\" - Lançamento Manual de Conta a Receber\n\"NFER\" - Conta a Receber Importada de uma NF-e\n\"RPTR\" - Repetição de Contas a Receber\n\"VENR\" - Parcela a Receber de Vendas\n\"XMLR\" - Conta a Receber Importada de um arquivo XML"},"operacao":{"type":"string","maxLength":2,"description":"Operação"},"valor_pis":{"type":"number","maxLength":18,"description":"Valor do PIS"},"retem_pis":{"type":"string","maxLength":1,"description":"Indica que o Valor do PIS informado deve ser retido"},"valor_cofins":{"type":"number","maxLength":18,"description":"Valor do COFINS"},"retem_cofins":{"type":"string","maxLength":1,"description":"Indica que o Valor do COFINS informado deve ser retido"},"valor_csll":{"type":"number","maxLength":18,"description":"Valor do CSLL"},"retem_csll":{"type":"string","maxLength":1,"description":"Indica que o Valor do CSLL informado deve ser retido"},"valor_ir":{"type":"number","maxLength":18,"description":"Valor do Imposto de Renda"},"retem_ir":{"type":"string","maxLength":1,"description":"Indica que o Valor do Imposto de Renda  informado deve ser retido"},"valor_iss":{"type":"number","maxLength":18,"description":"Valor do ISS"},"retem_iss":{"type":"string","maxLength":1,"description":"Indica que o Valor do ISS informado deve ser retido"},"valor_inss":{"type":"number","maxLength":18,"description":"Valor do INSS"},"retem_inss":{"type":"string","maxLength":1,"description":"Indica que o Valor do INSS informado deve ser retido"},"bloqueado":{"type":"string","maxLength":1,"description":"Bloquear lançamento (S/N)"},"bloquear_baixa":{"type":"string","maxLength":1,"description":"bloquear a baixa do lançamento"},"importado_api":{"type":"string","maxLength":1,"description":"Lançamento gerado pela API"},"baixar_documento":{"type":"string","maxLength":1,"description":"Efetua a baixa automática do documento."},"conciliar_documento":{"type":"string","maxLength":1,"description":"Efetua a conciliação do documento automaticamente."},"acao":{"type":"string","description":"A-Adiciona Valor / S-Subtrai valor / L-Lança valor."},"lancamento_detalhe":{"type":"array","items":{"type":"object","properties":{"nCodInt":{"type":"string","maxLength":20,"description":"Código de Integração"},"COO":{"type":"string","maxLength":20},"CCF":{"type":"string","maxLength":20}}}},"distribuicao":{"type":"array","items":{"type":"object","properties":{"cCodDep":{"type":"string","maxLength":40,"description":"Código do Departamento"},"cDesDep":{"type":"string","maxLength":50,"description":"Descrição do Departamento"},"nValDep":{"type":"number","maxLength":18,"description":"Valor do rateio"},"nPerDep":{"type":"number","maxLength":10,"description":"Percentual do rateio"}}},"description":"Distribuição por Departamentos"},"status_titulo":{"type":"string","maxLength":100,"description":"Status do Título"},"codigo_vendedor":{"type":"integer","maxLength":15,"description":"Código do Vendedor"},"codigo_projeto":{"type":"integer","maxLength":15,"description":"Código do Projeto"},"nsu":{"type":"string","maxLength":100,"description":"Número Sequencial Único - Comprovante de pagamento."},"data_registro":{"type":"string","maxLength":10,"description":"Data de Registro"},"tipo_agrupamento":{"type":"string","maxLength":1,"description":"Tipo de agrupamento dos lançamentos.\n\nPode ser:\nC-Consolidado (sintético).\nI-Individual (analítico).\n\nNão deve ser preenchido na Inclusão/alteração pois é de preenchimento automático para lançamentos recebidos do PDV."},"info":{"type":"object","properties":{"dInc":{"type":"string","maxLength":10,"description":"Data da Inclusão.\nNo formato dd/mm/aaaa."},"hInc":{"type":"string","maxLength":8,"description":"Hora da Inclusão.\nNo formato hh:mm:ss."},"uInc":{"type":"string","maxLength":10,"description":"Usuário da Inclusão."},"dAlt":{"type":"string","maxLength":10,"description":"Data da Alteração.\nNo formato dd/mm/aaaa."},"hAlt":{"type":"string","maxLength":8,"description":"Hora da Alteração.\nNo formato hh:mm:ss."},"uAlt":{"type":"string","maxLength":10,"description":"Usuário da Alteração."},"cImpAPI":{"type":"string","maxLength":1,"description":"Importado pela API (S/N)."}},"description":"Informações complementares do anexo."},"boleto":{"type":"object","properties":{"cGerado":{"type":"string","maxLength":1,"description":"Gerou boleto (S/N)?"},"dDtEmBol":{"type":"string","maxLength":10,"description":"Data de emissão do boleto."},"cNumBoleto":{"type":"string","maxLength":30,"description":"Número do boleto."},"cNumBancario":{"type":"string","maxLength":30,"description":"Número bancário do boleto."},"nPerJuros":{"type":"number","maxLength":10,"description":"Percentual de juros."},"nPerMulta":{"type":"number","maxLength":10,"description":"Percentual de multa."}},"description":"Informações do boleto."},"bloquear_exclusao":{"type":"string","maxLength":1,"description":"Bloqueia a exclusão do registro. (S/N)"},"nCodPedido":{"type":"integer","maxLength":15,"description":"ID do Pedido de Venda.\n\n\nQuando informado na inclusão do título associa o documento a um Pedido de Venda já existente no Omie."},"nCodOS":{"type":"integer","maxLength":15,"description":"ID da Ordem de Serviço.\n\nQuando informado na inclusão do título, preenche o campo numero_pedido para a conta a receber.\n\nObs. O campo nCodOS não é alterado internamente."},"cPedidoCliente":{"type":"string","maxLength":30,"description":"Número do pedido do cliente."},"cNumeroContrato":{"type":"string","maxLength":20,"description":"Número do contrato do cliente."},"recebimento":{"type":"object","properties":{"codigo_recebimento_integracao":{"type":"string","maxLength":20},"codigo_conta_corrente":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente."},"valor":{"type":"number","maxLength":18,"description":"Valor a ser baixado."},"desconto":{"type":"number","maxLength":18,"description":"Valor do desconto."},"juros":{"type":"number","maxLength":18,"description":"Valor do Juros."},"multa":{"type":"number","maxLength":18,"description":"Valor da multa."},"data":{"type":"string","maxLength":10,"description":"Data da Baixa"},"observacao":{"type":"string","description":"Observação da Baixa do Contas a Receber."}},"description":"Detalhes do recebimento (baixa).\nInforme aqui os detalhes do recebimento do lançamento.\n\nAo preencher esse campo é possível detalhar informações da baixa do documento, como: Valor Recebido, Desconto, Juros, Multa, etc.\n\nQuando essa tag estiver preenchida é obrigatório o preenchimento da tag \"baixar_documento\" com \"S\"\n\nCaso essa tag não seja preenchida o lançamento será baixado de forma integral de acordo com os valores do lançamento.\n\nEssa tag é utilizada apenas nos métodos de Inclusão e Alteração.\n\nInformação localizada na Aba \"Recebimentos\" no cadastro do lançamento."},"repeticao":{"type":"object","properties":{"antecipar":{"type":"string","maxLength":1,"description":"Antecipar data de vencimento.\n\nIndica que a data de vencimento será antecipada aos Sábados, Domingos e Feriados Nacionais.\n\nPreencher com \"S\" ou \"N\".\n\nPreencher com \"S\" somente umas das tags:\nantecipar\npostergar"},"postergar":{"type":"string","maxLength":1,"description":"Postergar data de vencimento.\n\nIndica que a data de vencimento será postergada aos Sábados, Domingos e Feriados Nacionais.\n\nPreencher com \"S\" ou \"N\".\n\nPreencher com \"S\" somente umas das tags:\nantecipar\npostergar"},"mensal":{"type":"object","properties":{"repetir_todo_dia":{"type":"integer","maxLength":6,"description":"Informe aqui o dia do mês em que cadá lançamento irá vencer .\n\nExemplo:\nCaso informe dia 30, será cadastrado um lançamento com vencimento para o dia 30 de cada mês."},"repetir_por":{"type":"integer","maxLength":6,"description":"Informe aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições."}},"description":"Repetição mensal.\nInforme aqui os detalhes da repetição mensal do lançamento.\n\nÉ obrigatório o preenchimento de apenas umas das tags:\nmensal\nsemanal\nespecifico"},"semanal":{"type":"object","properties":{"repetir_dia_semana":{"type":"string","maxLength":10,"description":"Informe o dia da semana que será o vencimento do lançamento.\n\nPode ser:\n\ndomingo\nsegunda\nterca\nquarta\nquinta\nsexta\nsabado"},"repetir_por":{"type":"integer","maxLength":6,"description":"Informe aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições."}},"description":"Repetição semanal.\nInforme aqui os detalhes da repetição semanal do lançamento.\n\nÉ obrigatório o preenchimento de apenas umas das tags:\nmensal\nsemanal\nespecifico"},"especifico":{"type":"object","properties":{"repetir_a_cada":{"type":"integer","maxLength":6,"description":"Informe aqui o intervalo em dias entre cada vencimento do lançamento que será cadastrado.\n\nExemplo:\nCaso informe uma quantidade de 10 dias, será cadastrado um lançamento com vencimento a cada 10 dias."},"repetir_por":{"type":"integer","maxLength":6,"description":"Informe aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições."}},"description":"Repetição específica.\nInforme aqui os detalhes da repetição específica do lançamento.\n\nÉ obrigatório o preenchimento de apenas umas das tags:\nmensal\nsemanal\nespecifico"}},"required":["especifico","mensal","semanal"],"description":"Repetição do lançamento.\n\nUtilize essa estrutura para cadastrar várias parcela na mesma requisição.\nEscolha entre as tags \"mensal\", \"semanal\" ou \"especifico\" para definir as datas de vencimento e quantidade de parcelas.\n\nInformação localizada na Aba \"Repetição\" do cadastro do título.\n\nEssa tag é utilizada apenas nos métodos de Inclusão e Alteração."},"aprendizado_rateio":{"type":"string","maxLength":1,"description":"Aprendizado de rateio de departamento.\n\nPreencher com \"S\" ou \"N\".\n\nDefault \"N\"\n\nQuando essa tag for preenchida com \"S\" será assumido o rateio de departamento para a categoria informada na tag \"codigo_categoria\".\n\nEssa tag é utilizada apenas nos métodos de inclusão e alteração."}},"required":["recebimento"]}}},"example":{"call":"AlterarContaReceber","param":[{"codigo_lancamento_integracao":"1790774979","codigo_cliente_fornecedor":4214850,"data_vencimento":"30/09/2026","valor_documento":100.0,"codigo_categoria":"1.01.02","data_previsao":"30/09/2026","id_conta_corrente":4243124}]}},"financas_contareceber_AlterarContaReceber_retorno":{"type":"object","properties":{"codigo_lancamento_omie":{"type":"integer"},"codigo_lancamento_integracao":{"type":"string","description":"Código do lançamento gerado pelo integrador."},"codigo_status":{"type":"string"},"descricao_status":{"type":"string"}},"title":"AlterarContaReceber (retorno)"},"financas_contareceber_CancelarContaReceber":{"type":"object","title":"CancelarContaReceber","description":"Cancelamento do boleto gerado de uma conta a receber","required":["call","param"],"properties":{"call":{"type":"string","enum":["CancelarContaReceber"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"chave_lancamento":{"type":"integer","maxLength":15,"description":"Código do lançamento no Omie.\nÉ o codigo_lancamento_omie que IncluirContaReceber e ListarContasReceber devolvem."},"codigo_lancamento_integracao":{"type":"string","maxLength":60,"description":"Código do lançamento gerado pelo integrador."}}}}},"example":{"call":"CancelarContaReceber","param":[{"chave_lancamento":0}]}},"financas_contareceber_CancelarContaReceber_retorno":{"type":"object","properties":{"codigo_lancamento_omie":{"type":"integer"},"codigo_lancamento_integracao":{"type":"string","description":"Código do lançamento gerado pelo integrador."},"codigo_status":{"type":"string"},"descricao_status":{"type":"string"}},"title":"CancelarContaReceber (retorno)"},"financas_contareceber_CancelarRecebimento":{"type":"object","title":"CancelarRecebimento","description":"Efetua o cancelamento de um recebimento de Contas a Receber.","required":["call","param"],"properties":{"call":{"type":"string","enum":["CancelarRecebimento"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_baixa":{"type":"integer","maxLength":15,"description":"Código para identificar a baixa do título no Contas a Receber."},"codigo_baixa_integracao":{"type":"string","maxLength":20,"description":"Código da baixa do integrador para identificar a baixa de um título do contas a receber."}}}}},"example":{"call":"CancelarRecebimento","param":[{"codigo_baixa":0}]}},"financas_contareceber_CancelarRecebimento_retorno":{"type":"object","properties":{"codigo_baixa":{"type":"integer","description":"Código da baixa do contas a receber no Omie."},"codigo_baixa_integracao":{"type":"string","description":"Código da baixa do integrador para identificar a baixa do título do contas a receber."},"codigo_status":{"type":"string","description":"Código do Status da baixa."},"descricao_status":{"type":"string","description":"Descrição do status da baixa do contas a receber."}},"title":"CancelarRecebimento (retorno)"},"financas_contareceber_ConciliarRecebimento":{"type":"object","title":"ConciliarRecebimento","description":"Efetua a conciliação da baixa","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConciliarRecebimento"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_baixa":{"type":"integer","maxLength":15,"description":"Código da Baixa"},"codigo_baixa_integracao":{"type":"string","maxLength":20,"description":"Código de Integração da Baixa"}}}}},"example":{"call":"ConciliarRecebimento","param":[{"codigo_baixa":0}]}},"financas_contareceber_ConciliarRecebimento_retorno":{"type":"object","properties":{"codigo_baixa":{"type":"integer","description":"Código da Baixa"},"codigo_baixa_integracao":{"type":"string","description":"Código de Integração da Baixa"},"codigo_status":{"type":"string"},"descricao_status":{"type":"string"}},"title":"ConciliarRecebimento (retorno)"},"financas_contareceber_ConsultarContaReceber":{"type":"object","title":"ConsultarContaReceber","description":"Consulta uma Conta a Receber","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarContaReceber"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_lancamento_omie":{"type":"integer","maxLength":15},"codigo_lancamento_integracao":{"type":"string","maxLength":60,"description":"Código de integração do Lançamento."}}}}},"example":{"call":"ConsultarContaReceber","param":[{"codigo_lancamento_omie":0,"codigo_lancamento_integracao":""}]}},"financas_contareceber_ConsultarContaReceber_retorno":{"type":"object","properties":{"codigo_lancamento_omie":{"type":"integer","description":"Chave do Lançamento"},"codigo_lancamento_integracao":{"type":"string","description":"Código do lançamento gerado pelo integrador."},"codigo_cliente_fornecedor":{"type":"integer","description":"Código de Cliente / Fornecedor"},"codigo_cliente_fornecedor_integracao":{"type":"string","description":"Código do cliente informado pelo integrador."},"data_vencimento":{"type":"string","description":"Data de Vencimento"},"valor_documento":{"type":"decimal","description":"Valor do Lançamento"},"codigo_categoria":{"type":"string","description":"Código da Categoria"},"categorias":{"type":"array","items":{"type":"object","properties":{"codigo_categoria":{"type":"string"},"valor":{"type":"decimal"},"percentual":{"type":"decimal","description":"Percentual da categoria"}}}},"data_previsao":{"type":"string","description":"Data de Previsão de Pagamento/Recebimento"},"id_conta_corrente":{"type":"integer","description":"Id da Conta Corrente"},"numero_documento":{"type":"string","description":"Número do Documento"},"numero_parcela":{"type":"string","description":"Número da parcela \"Formatada\" como 999/999"},"codigo_tipo_documento":{"type":"string","description":"Código para o Tipo de Documento"},"numero_documento_fiscal":{"type":"string","description":"Número do Documento Fiscal"},"numero_pedido":{"type":"string","description":"Número do Pedido"},"chave_nfe":{"type":"string","description":"Chave de Acesso da NFE"},"observacao":{"type":"string","description":"Observação"},"codigo_barras_ficha_compensacao":{"type":"string","description":"Código de Barras da Ficha de Compensação"},"codigo_cmc7_cheque":{"type":"string","description":"Código CMC7 do Cheque"},"data_emissao":{"type":"string","description":"Data de Emissão"},"id_origem":{"type":"string","description":"Código da Origem. Informação localizada na Aba \"Diversos\" do Contas a Receber. Os valores disponíveis são: \"APIR\" - Integração de Conta a Receber \"BARR\" - Conta a Receber Importada por Código de Barras \"CTER\" - Parcela a Receber de um CT-e \"DEVR\" - Conta a Receber da Devolução ao Fornecedor \"MANR\" - Lançamento Manual de Conta a Receber \"NFER\" - Conta a Receber Importada de uma NF-e \"RPTR\" - Repetição de Contas a Receber \"VENR\" - Parcela a Receber de Vendas \"XMLR\" - Conta a Receber Importada de um arquivo XML"},"operacao":{"type":"string","description":"Operação"},"valor_pis":{"type":"decimal","description":"Valor do PIS"},"retem_pis":{"type":"string","description":"Indica que o Valor do PIS informado deve ser retido"},"valor_cofins":{"type":"decimal","description":"Valor do COFINS"},"retem_cofins":{"type":"string","description":"Indica que o Valor do COFINS informado deve ser retido"},"valor_csll":{"type":"decimal","description":"Valor do CSLL"},"retem_csll":{"type":"string","description":"Indica que o Valor do CSLL informado deve ser retido"},"valor_ir":{"type":"decimal","description":"Valor do Imposto de Renda"},"retem_ir":{"type":"string","description":"Indica que o Valor do Imposto de Renda informado deve ser retido"},"valor_iss":{"type":"decimal","description":"Valor do ISS"},"retem_iss":{"type":"string","description":"Indica que o Valor do ISS informado deve ser retido"},"valor_inss":{"type":"decimal","description":"Valor do INSS"},"retem_inss":{"type":"string","description":"Indica que o Valor do INSS informado deve ser retido"},"bloqueado":{"type":"string","description":"Bloquear lançamento (S/N)"},"bloquear_baixa":{"type":"string","description":"bloquear a baixa do lançamento"},"importado_api":{"type":"string","description":"Lançamento gerado pela API"},"baixar_documento":{"type":"string","description":"Efetua a baixa automática do documento."},"conciliar_documento":{"type":"string","description":"Efetua a conciliação do documento automaticamente."},"acao":{"type":"string","description":"A-Adiciona Valor / S-Subtrai valor / L-Lança valor."},"lancamento_detalhe":{"type":"array","items":{"type":"object","properties":{"nCodInt":{"type":"string","description":"Código de Integração"},"COO":{"type":"string"},"CCF":{"type":"string"}}}},"distribuicao":{"type":"array","items":{"type":"object","properties":{"cCodDep":{"type":"string","description":"Código do Departamento"},"cDesDep":{"type":"string","description":"Descrição do Departamento"},"nValDep":{"type":"decimal","description":"Valor do rateio"},"nPerDep":{"type":"decimal","description":"Percentual do rateio"}}},"description":"Distribuição por Departamentos"},"status_titulo":{"type":"string","description":"Status do Título"},"codigo_vendedor":{"type":"integer","description":"Código do Vendedor"},"codigo_projeto":{"type":"integer","description":"Código do Projeto"},"nsu":{"type":"string","description":"Número Sequencial Único - Comprovante de pagamento."},"data_registro":{"type":"string","description":"Data de Registro"},"tipo_agrupamento":{"type":"string","description":"Tipo de agrupamento dos lançamentos. Pode ser: C-Consolidado (sintético). I-Individual (analítico). Não deve ser preenchido na Inclusão/alteração pois é de preenchimento automático para lançamentos recebidos do PDV."},"info":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão. No formato dd/mm/aaaa."},"hInc":{"type":"string","description":"Hora da Inclusão. No formato hh:mm:ss."},"uInc":{"type":"string","description":"Usuário da Inclusão."},"dAlt":{"type":"string","description":"Data da Alteração. No formato dd/mm/aaaa."},"hAlt":{"type":"string","description":"Hora da Alteração. No formato hh:mm:ss."},"uAlt":{"type":"string","description":"Usuário da Alteração."},"cImpAPI":{"type":"string","description":"Importado pela API (S/N)."}},"description":"Informações complementares do anexo."},"boleto":{"type":"object","properties":{"cGerado":{"type":"string","description":"Gerou boleto (S/N)?"},"dDtEmBol":{"type":"string","description":"Data de emissão do boleto."},"cNumBoleto":{"type":"string","description":"Número do boleto."},"cNumBancario":{"type":"string","description":"Número bancário do boleto."},"nPerJuros":{"type":"decimal","description":"Percentual de juros."},"nPerMulta":{"type":"decimal","description":"Percentual de multa."}},"description":"Informações do boleto."},"bloquear_exclusao":{"type":"string","description":"Bloqueia a exclusão do registro. (S/N)"},"nCodPedido":{"type":"integer","description":"ID do Pedido de Venda. Quando informado na inclusão do título associa o documento a um Pedido de Venda já existente no Omie."},"nCodOS":{"type":"integer","description":"ID da Ordem de Serviço. Quando informado na inclusão do título, preenche o campo numero_pedido para a conta a receber. Obs. O campo nCodOS não é alterado internamente."},"cPedidoCliente":{"type":"string","description":"Número do pedido do cliente."},"cNumeroContrato":{"type":"string","description":"Número do contrato do cliente."},"recebimento":{"type":"object","properties":{"codigo_recebimento_integracao":{"type":"string"},"codigo_conta_corrente":{"type":"integer","description":"Código da Conta Corrente."},"valor":{"type":"decimal","description":"Valor a ser baixado."},"desconto":{"type":"decimal","description":"Valor do desconto."},"juros":{"type":"decimal","description":"Valor do Juros."},"multa":{"type":"decimal","description":"Valor da multa."},"data":{"type":"string","description":"Data da Baixa"},"observacao":{"type":"string","description":"Observação da Baixa do Contas a Receber."}},"description":"Detalhes do recebimento (baixa). Informe aqui os detalhes do recebimento do lançamento. Ao preencher esse campo é possível detalhar informações da baixa do documento, como: Valor Recebido, Desconto, Juros, Multa, etc. Quando essa tag estiver preenchida é obrigatório o preenchimento da tag \"baixar_documento\" com \"S\" Caso essa tag não seja preenchida o lançamento será baixado de forma integral de acordo com os valores do lançamento. Essa tag é utilizada apenas nos métodos de Inclusão e Alteração. Informação localizada na Aba \"Recebimentos\" no cadastro do lançamento."},"repeticao":{"type":"object","properties":{"antecipar":{"type":"string","description":"Antecipar data de vencimento. Indica que a data de vencimento será antecipada aos Sábados, Domingos e Feriados Nacionais. Preencher com \"S\" ou \"N\". Preencher com \"S\" somente umas das tags: antecipar postergar"},"postergar":{"type":"string","description":"Postergar data de vencimento. Indica que a data de vencimento será postergada aos Sábados, Domingos e Feriados Nacionais. Preencher com \"S\" ou \"N\". Preencher com \"S\" somente umas das tags: antecipar postergar"},"mensal":{"type":"object","properties":{"repetir_todo_dia":{"type":"integer","description":"Informe aqui o dia do mês em que cadá lançamento irá vencer . Exemplo: Caso informe dia 30, será cadastrado um lançamento com vencimento para o dia 30 de cada mês."},"repetir_por":{"type":"integer","description":"Informe aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições."}},"description":"Repetição mensal. Informe aqui os detalhes da repetição mensal do lançamento. É obrigatório o preenchimento de apenas umas das tags: mensal semanal especifico"},"semanal":{"type":"object","properties":{"repetir_dia_semana":{"type":"string","description":"Informe o dia da semana que será o vencimento do lançamento. Pode ser: domingo segunda terca quarta quinta sexta sabado"},"repetir_por":{"type":"integer","description":"Informe aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições."}},"description":"Repetição semanal. Informe aqui os detalhes da repetição semanal do lançamento. É obrigatório o preenchimento de apenas umas das tags: mensal semanal especifico"},"especifico":{"type":"object","properties":{"repetir_a_cada":{"type":"integer","description":"Informe aqui o intervalo em dias entre cada vencimento do lançamento que será cadastrado. Exemplo: Caso informe uma quantidade de 10 dias, será cadastrado um lançamento com vencimento a cada 10 dias."},"repetir_por":{"type":"integer","description":"Informe aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições."}},"description":"Repetição específica. Informe aqui os detalhes da repetição específica do lançamento. É obrigatório o preenchimento de apenas umas das tags: mensal semanal especifico"}},"description":"Repetição do lançamento. Utilize essa estrutura para cadastrar várias parcela na mesma requisição. Escolha entre as tags \"mensal\", \"semanal\" ou \"especifico\" para definir as datas de vencimento e quantidade de parcelas. Informação localizada na Aba \"Repetição\" do cadastro do título. Essa tag é utilizada apenas nos métodos de Inclusão e Alteração."},"aprendizado_rateio":{"type":"string","description":"Aprendizado de rateio de departamento. Preencher com \"S\" ou \"N\". Default \"N\" Quando essa tag for preenchida com \"S\" será assumido o rateio de departamento para a categoria informada na tag \"codigo_categoria\". Essa tag é utilizada apenas nos métodos de inclusão e alteração."}},"title":"ConsultarContaReceber (retorno)"},"financas_contareceber_DesconciliarRecebimento":{"type":"object","title":"DesconciliarRecebimento","description":"Desconciliar o Recebimento","required":["call","param"],"properties":{"call":{"type":"string","enum":["DesconciliarRecebimento"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_baixa":{"type":"integer","maxLength":15,"description":"Código da Baixa"},"codigo_baixa_integracao":{"type":"string","maxLength":20,"description":"Código de Integração da Baixa"}}}}},"example":{"call":"DesconciliarRecebimento","param":[{"codigo_baixa":0}]}},"financas_contareceber_DesconciliarRecebimento_retorno":{"type":"object","properties":{"codigo_baixa":{"type":"integer","description":"Código da Baixa"},"codigo_baixa_integracao":{"type":"string","description":"Código de Integração da Baixa"},"codigo_status":{"type":"string"},"descricao_status":{"type":"string"}},"title":"DesconciliarRecebimento (retorno)"},"financas_contareceber_ExcluirContaReceber":{"type":"object","title":"ExcluirContaReceber","description":"Exclui uma conta a receber","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirContaReceber"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"chave_lancamento":{"type":"integer","maxLength":15,"description":"Código do lançamento no Omie.\nÉ o codigo_lancamento_omie que IncluirContaReceber e ListarContasReceber devolvem."},"codigo_lancamento_integracao":{"type":"string","maxLength":60,"description":"Código do lançamento gerado pelo integrador."}}}}},"example":{"call":"ExcluirContaReceber","param":[{"chave_lancamento":0}]}},"financas_contareceber_ExcluirContaReceber_retorno":{"type":"object","properties":{"codigo_lancamento_omie":{"type":"integer"},"codigo_lancamento_integracao":{"type":"string","description":"Código do lançamento gerado pelo integrador."},"codigo_status":{"type":"string"},"descricao_status":{"type":"string"}},"title":"ExcluirContaReceber (retorno)"},"financas_contareceber_IncluirContaReceber":{"type":"object","title":"IncluirContaReceber","description":"Inclui uma conta a Receber","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirContaReceber"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_lancamento_omie":{"type":"integer","maxLength":15,"description":"Chave do Lançamento"},"codigo_lancamento_integracao":{"type":"string","maxLength":60,"description":"Código do lançamento gerado pelo integrador."},"codigo_cliente_fornecedor":{"type":"integer","maxLength":15,"description":"Código de Cliente / Fornecedor"},"codigo_cliente_fornecedor_integracao":{"type":"string","maxLength":60,"description":"Código do cliente informado pelo integrador."},"data_vencimento":{"type":"string","maxLength":10,"description":"Data de Vencimento"},"valor_documento":{"type":"number","maxLength":18,"description":"Valor do Lançamento"},"codigo_categoria":{"type":"string","maxLength":20,"description":"Código da Categoria"},"categorias":{"type":"array","items":{"type":"object","properties":{"codigo_categoria":{"type":"string","maxLength":20},"valor":{"type":"number","maxLength":18},"percentual":{"type":"number","maxLength":10,"description":"Percentual da categoria"}}}},"data_previsao":{"type":"string","maxLength":10,"description":"Data de Previsão de Pagamento/Recebimento"},"id_conta_corrente":{"type":"integer","maxLength":15,"description":"Id da Conta Corrente"},"numero_documento":{"type":"string","maxLength":20,"description":"Número do Documento"},"numero_parcela":{"type":"string","maxLength":7,"description":"Número da parcela \"Formatada\" como 999/999"},"codigo_tipo_documento":{"type":"string","maxLength":5,"description":"Código para o Tipo de Documento"},"numero_documento_fiscal":{"type":"string","maxLength":20,"description":"Número do Documento Fiscal"},"numero_pedido":{"type":"string","maxLength":15,"description":"Número do Pedido"},"chave_nfe":{"type":"string","maxLength":44,"description":"Chave de Acesso da NFE"},"observacao":{"type":"string","description":"Observação"},"codigo_barras_ficha_compensacao":{"type":"string","maxLength":70,"description":"Código de Barras da Ficha de Compensação"},"codigo_cmc7_cheque":{"type":"string","maxLength":40,"description":"Código CMC7 do Cheque"},"data_emissao":{"type":"string","maxLength":10,"description":"Data de Emissão"},"id_origem":{"type":"string","maxLength":4,"description":"Código da Origem.\n\nInformação localizada na Aba \"Diversos\" do Contas a Receber.\n\nOs valores disponíveis são:\n\n\"APIR\" - Integração de Conta a Receber\n\"BARR\" - Conta a Receber Importada por Código de Barras\n\"CTER\" - Parcela a Receber de um CT-e\n\"DEVR\" - Conta a Receber da Devolução ao Fornecedor\n\"MANR\" - Lançamento Manual de Conta a Receber\n\"NFER\" - Conta a Receber Importada de uma NF-e\n\"RPTR\" - Repetição de Contas a Receber\n\"VENR\" - Parcela a Receber de Vendas\n\"XMLR\" - Conta a Receber Importada de um arquivo XML"},"operacao":{"type":"string","maxLength":2,"description":"Operação"},"valor_pis":{"type":"number","maxLength":18,"description":"Valor do PIS"},"retem_pis":{"type":"string","maxLength":1,"description":"Indica que o Valor do PIS informado deve ser retido"},"valor_cofins":{"type":"number","maxLength":18,"description":"Valor do COFINS"},"retem_cofins":{"type":"string","maxLength":1,"description":"Indica que o Valor do COFINS informado deve ser retido"},"valor_csll":{"type":"number","maxLength":18,"description":"Valor do CSLL"},"retem_csll":{"type":"string","maxLength":1,"description":"Indica que o Valor do CSLL informado deve ser retido"},"valor_ir":{"type":"number","maxLength":18,"description":"Valor do Imposto de Renda"},"retem_ir":{"type":"string","maxLength":1,"description":"Indica que o Valor do Imposto de Renda  informado deve ser retido"},"valor_iss":{"type":"number","maxLength":18,"description":"Valor do ISS"},"retem_iss":{"type":"string","maxLength":1,"description":"Indica que o Valor do ISS informado deve ser retido"},"valor_inss":{"type":"number","maxLength":18,"description":"Valor do INSS"},"retem_inss":{"type":"string","maxLength":1,"description":"Indica que o Valor do INSS informado deve ser retido"},"bloqueado":{"type":"string","maxLength":1,"description":"Bloquear lançamento (S/N)"},"bloquear_baixa":{"type":"string","maxLength":1,"description":"bloquear a baixa do lançamento"},"importado_api":{"type":"string","maxLength":1,"description":"Lançamento gerado pela API"},"baixar_documento":{"type":"string","maxLength":1,"description":"Efetua a baixa automática do documento."},"conciliar_documento":{"type":"string","maxLength":1,"description":"Efetua a conciliação do documento automaticamente."},"acao":{"type":"string","description":"A-Adiciona Valor / S-Subtrai valor / L-Lança valor."},"lancamento_detalhe":{"type":"array","items":{"type":"object","properties":{"nCodInt":{"type":"string","maxLength":20,"description":"Código de Integração"},"COO":{"type":"string","maxLength":20},"CCF":{"type":"string","maxLength":20}}}},"distribuicao":{"type":"array","items":{"type":"object","properties":{"cCodDep":{"type":"string","maxLength":40,"description":"Código do Departamento"},"cDesDep":{"type":"string","maxLength":50,"description":"Descrição do Departamento"},"nValDep":{"type":"number","maxLength":18,"description":"Valor do rateio"},"nPerDep":{"type":"number","maxLength":10,"description":"Percentual do rateio"}}},"description":"Distribuição por Departamentos"},"status_titulo":{"type":"string","maxLength":100,"description":"Status do Título"},"codigo_vendedor":{"type":"integer","maxLength":15,"description":"Código do Vendedor"},"codigo_projeto":{"type":"integer","maxLength":15,"description":"Código do Projeto"},"nsu":{"type":"string","maxLength":100,"description":"Número Sequencial Único - Comprovante de pagamento."},"data_registro":{"type":"string","maxLength":10,"description":"Data de Registro"},"tipo_agrupamento":{"type":"string","maxLength":1,"description":"Tipo de agrupamento dos lançamentos.\n\nPode ser:\nC-Consolidado (sintético).\nI-Individual (analítico).\n\nNão deve ser preenchido na Inclusão/alteração pois é de preenchimento automático para lançamentos recebidos do PDV."},"info":{"type":"object","properties":{"dInc":{"type":"string","maxLength":10,"description":"Data da Inclusão.\nNo formato dd/mm/aaaa."},"hInc":{"type":"string","maxLength":8,"description":"Hora da Inclusão.\nNo formato hh:mm:ss."},"uInc":{"type":"string","maxLength":10,"description":"Usuário da Inclusão."},"dAlt":{"type":"string","maxLength":10,"description":"Data da Alteração.\nNo formato dd/mm/aaaa."},"hAlt":{"type":"string","maxLength":8,"description":"Hora da Alteração.\nNo formato hh:mm:ss."},"uAlt":{"type":"string","maxLength":10,"description":"Usuário da Alteração."},"cImpAPI":{"type":"string","maxLength":1,"description":"Importado pela API (S/N)."}},"description":"Informações complementares do anexo."},"boleto":{"type":"object","properties":{"cGerado":{"type":"string","maxLength":1,"description":"Gerou boleto (S/N)?"},"dDtEmBol":{"type":"string","maxLength":10,"description":"Data de emissão do boleto."},"cNumBoleto":{"type":"string","maxLength":30,"description":"Número do boleto."},"cNumBancario":{"type":"string","maxLength":30,"description":"Número bancário do boleto."},"nPerJuros":{"type":"number","maxLength":10,"description":"Percentual de juros."},"nPerMulta":{"type":"number","maxLength":10,"description":"Percentual de multa."}},"description":"Informações do boleto."},"bloquear_exclusao":{"type":"string","maxLength":1,"description":"Bloqueia a exclusão do registro. (S/N)"},"nCodPedido":{"type":"integer","maxLength":15,"description":"ID do Pedido de Venda.\n\n\nQuando informado na inclusão do título associa o documento a um Pedido de Venda já existente no Omie."},"nCodOS":{"type":"integer","maxLength":15,"description":"ID da Ordem de Serviço.\n\nQuando informado na inclusão do título, preenche o campo numero_pedido para a conta a receber.\n\nObs. O campo nCodOS não é alterado internamente."},"cPedidoCliente":{"type":"string","maxLength":30,"description":"Número do pedido do cliente."},"cNumeroContrato":{"type":"string","maxLength":20,"description":"Número do contrato do cliente."},"recebimento":{"type":"object","properties":{"codigo_recebimento_integracao":{"type":"string","maxLength":20},"codigo_conta_corrente":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente."},"valor":{"type":"number","maxLength":18,"description":"Valor a ser baixado."},"desconto":{"type":"number","maxLength":18,"description":"Valor do desconto."},"juros":{"type":"number","maxLength":18,"description":"Valor do Juros."},"multa":{"type":"number","maxLength":18,"description":"Valor da multa."},"data":{"type":"string","maxLength":10,"description":"Data da Baixa"},"observacao":{"type":"string","description":"Observação da Baixa do Contas a Receber."}},"description":"Detalhes do recebimento (baixa).\nInforme aqui os detalhes do recebimento do lançamento.\n\nAo preencher esse campo é possível detalhar informações da baixa do documento, como: Valor Recebido, Desconto, Juros, Multa, etc.\n\nQuando essa tag estiver preenchida é obrigatório o preenchimento da tag \"baixar_documento\" com \"S\"\n\nCaso essa tag não seja preenchida o lançamento será baixado de forma integral de acordo com os valores do lançamento.\n\nEssa tag é utilizada apenas nos métodos de Inclusão e Alteração.\n\nInformação localizada na Aba \"Recebimentos\" no cadastro do lançamento."},"repeticao":{"type":"object","properties":{"antecipar":{"type":"string","maxLength":1,"description":"Antecipar data de vencimento.\n\nIndica que a data de vencimento será antecipada aos Sábados, Domingos e Feriados Nacionais.\n\nPreencher com \"S\" ou \"N\".\n\nPreencher com \"S\" somente umas das tags:\nantecipar\npostergar"},"postergar":{"type":"string","maxLength":1,"description":"Postergar data de vencimento.\n\nIndica que a data de vencimento será postergada aos Sábados, Domingos e Feriados Nacionais.\n\nPreencher com \"S\" ou \"N\".\n\nPreencher com \"S\" somente umas das tags:\nantecipar\npostergar"},"mensal":{"type":"object","properties":{"repetir_todo_dia":{"type":"integer","maxLength":6,"description":"Informe aqui o dia do mês em que cadá lançamento irá vencer .\n\nExemplo:\nCaso informe dia 30, será cadastrado um lançamento com vencimento para o dia 30 de cada mês."},"repetir_por":{"type":"integer","maxLength":6,"description":"Informe aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições."}},"description":"Repetição mensal.\nInforme aqui os detalhes da repetição mensal do lançamento.\n\nÉ obrigatório o preenchimento de apenas umas das tags:\nmensal\nsemanal\nespecifico"},"semanal":{"type":"object","properties":{"repetir_dia_semana":{"type":"string","maxLength":10,"description":"Informe o dia da semana que será o vencimento do lançamento.\n\nPode ser:\n\ndomingo\nsegunda\nterca\nquarta\nquinta\nsexta\nsabado"},"repetir_por":{"type":"integer","maxLength":6,"description":"Informe aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições."}},"description":"Repetição semanal.\nInforme aqui os detalhes da repetição semanal do lançamento.\n\nÉ obrigatório o preenchimento de apenas umas das tags:\nmensal\nsemanal\nespecifico"},"especifico":{"type":"object","properties":{"repetir_a_cada":{"type":"integer","maxLength":6,"description":"Informe aqui o intervalo em dias entre cada vencimento do lançamento que será cadastrado.\n\nExemplo:\nCaso informe uma quantidade de 10 dias, será cadastrado um lançamento com vencimento a cada 10 dias."},"repetir_por":{"type":"integer","maxLength":6,"description":"Informe aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições."}},"description":"Repetição específica.\nInforme aqui os detalhes da repetição específica do lançamento.\n\nÉ obrigatório o preenchimento de apenas umas das tags:\nmensal\nsemanal\nespecifico"}},"required":["especifico","mensal","semanal"],"description":"Repetição do lançamento.\n\nUtilize essa estrutura para cadastrar várias parcela na mesma requisição.\nEscolha entre as tags \"mensal\", \"semanal\" ou \"especifico\" para definir as datas de vencimento e quantidade de parcelas.\n\nInformação localizada na Aba \"Repetição\" do cadastro do título.\n\nEssa tag é utilizada apenas nos métodos de Inclusão e Alteração."},"aprendizado_rateio":{"type":"string","maxLength":1,"description":"Aprendizado de rateio de departamento.\n\nPreencher com \"S\" ou \"N\".\n\nDefault \"N\"\n\nQuando essa tag for preenchida com \"S\" será assumido o rateio de departamento para a categoria informada na tag \"codigo_categoria\".\n\nEssa tag é utilizada apenas nos métodos de inclusão e alteração."}},"required":["codigo_lancamento_integracao","data_vencimento","recebimento","valor_documento"]}}},"example":{"call":"IncluirContaReceber","param":[{"codigo_lancamento_integracao":"1790774979","codigo_cliente_fornecedor":4214850,"data_vencimento":"30/09/2026","valor_documento":100.0,"codigo_categoria":"1.01.02","data_previsao":"30/09/2026","id_conta_corrente":4243124}]}},"financas_contareceber_IncluirContaReceber_retorno":{"type":"object","properties":{"codigo_lancamento_omie":{"type":"integer"},"codigo_lancamento_integracao":{"type":"string","description":"Código do lançamento gerado pelo integrador."},"codigo_status":{"type":"string"},"descricao_status":{"type":"string"}},"title":"IncluirContaReceber (retorno)"},"financas_contareceber_IncluirContaReceberPorLote":{"type":"object","title":"IncluirContaReceberPorLote","description":"Incluir Lançamentos de contas a receber por lote.\n(Máximo de 50).","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirContaReceberPorLote"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"lote":{"type":"integer","maxLength":15,"description":"Número do lote de lançamentos de contas a receber."},"conta_receber_cadastro":{"type":"array","items":{"type":"object","properties":{"codigo_lancamento_omie":{"type":"integer","maxLength":15,"description":"Chave do Lançamento"},"codigo_lancamento_integracao":{"type":"string","maxLength":60,"description":"Código do lançamento gerado pelo integrador."},"codigo_cliente_fornecedor":{"type":"integer","maxLength":15,"description":"Código de Cliente / Fornecedor"},"codigo_cliente_fornecedor_integracao":{"type":"string","maxLength":60,"description":"Código do cliente informado pelo integrador."},"data_vencimento":{"type":"string","maxLength":10,"description":"Data de Vencimento"},"valor_documento":{"type":"number","maxLength":18,"description":"Valor do Lançamento"},"codigo_categoria":{"type":"string","maxLength":20,"description":"Código da Categoria"},"data_previsao":{"type":"string","maxLength":10,"description":"Data de Previsão de Pagamento/Recebimento"},"categorias":{"type":"array","items":{"type":"object","properties":{"codigo_categoria":{"type":"string","maxLength":20},"valor":{"type":"number","maxLength":18},"percentual":{"type":"number","maxLength":10,"description":"Percentual da categoria"}}}},"id_conta_corrente":{"type":"integer","maxLength":15,"description":"Id da Conta Corrente"},"numero_documento":{"type":"string","maxLength":20,"description":"Número do Documento"},"numero_parcela":{"type":"string","maxLength":7,"description":"Número da parcela \"Formatada\" como 999/999"},"codigo_tipo_documento":{"type":"string","maxLength":5,"description":"Código para o Tipo de Documento"},"numero_documento_fiscal":{"type":"string","maxLength":20,"description":"Número do Documento Fiscal"},"numero_pedido":{"type":"string","maxLength":15,"description":"Número do Pedido"},"chave_nfe":{"type":"string","maxLength":44,"description":"Chave de Acesso da NFE"},"observacao":{"type":"string","description":"Observação"},"codigo_barras_ficha_compensacao":{"type":"string","maxLength":70,"description":"Código de Barras da Ficha de Compensação"},"codigo_cmc7_cheque":{"type":"string","maxLength":40,"description":"Código CMC7 do Cheque"},"data_emissao":{"type":"string","maxLength":10,"description":"Data de Emissão"},"id_origem":{"type":"string","maxLength":4,"description":"Código da Origem.\n\nInformação localizada na Aba \"Diversos\" do Contas a Receber.\n\nOs valores disponíveis são:\n\n\"APIR\" - Integração de Conta a Receber\n\"BARR\" - Conta a Receber Importada por Código de Barras\n\"CTER\" - Parcela a Receber de um CT-e\n\"DEVR\" - Conta a Receber da Devolução ao Fornecedor\n\"MANR\" - Lançamento Manual de Conta a Receber\n\"NFER\" - Conta a Receber Importada de uma NF-e\n\"RPTR\" - Repetição de Contas a Receber\n\"VENR\" - Parcela a Receber de Vendas\n\"XMLR\" - Conta a Receber Importada de um arquivo XML"},"operacao":{"type":"string","maxLength":2,"description":"Operação"},"valor_pis":{"type":"number","maxLength":18,"description":"Valor do PIS"},"retem_pis":{"type":"string","maxLength":1,"description":"Indica que o Valor do PIS informado deve ser retido"},"valor_cofins":{"type":"number","maxLength":18,"description":"Valor do COFINS"},"retem_cofins":{"type":"string","maxLength":1,"description":"Indica que o Valor do COFINS informado deve ser retido"},"valor_csll":{"type":"number","maxLength":18,"description":"Valor do CSLL"},"retem_csll":{"type":"string","maxLength":1,"description":"Indica que o Valor do CSLL informado deve ser retido"},"valor_ir":{"type":"number","maxLength":18,"description":"Valor do Imposto de Renda"},"retem_ir":{"type":"string","maxLength":1,"description":"Indica que o Valor do Imposto de Renda  informado deve ser retido"},"valor_iss":{"type":"number","maxLength":18,"description":"Valor do ISS"},"retem_iss":{"type":"string","maxLength":1,"description":"Indica que o Valor do ISS informado deve ser retido"},"valor_inss":{"type":"number","maxLength":18,"description":"Valor do INSS"},"retem_inss":{"type":"string","maxLength":1,"description":"Indica que o Valor do INSS informado deve ser retido"},"bloqueado":{"type":"string","maxLength":1,"description":"Bloquear lançamento (S/N)"},"bloquear_baixa":{"type":"string","maxLength":1,"description":"bloquear a baixa do lançamento"},"importado_api":{"type":"string","maxLength":1,"description":"Lançamento gerado pela API"},"baixar_documento":{"type":"string","maxLength":1,"description":"Efetua a baixa automática do documento."},"conciliar_documento":{"type":"string","maxLength":1,"description":"Efetua a conciliação do documento automaticamente."},"acao":{"type":"string","description":"A-Adiciona Valor / S-Subtrai valor / L-Lança valor."},"lancamento_detalhe":{"type":"array","items":{"type":"object","properties":{"nCodInt":{"type":"string","maxLength":20,"description":"Código de Integração"},"COO":{"type":"string","maxLength":20},"CCF":{"type":"string","maxLength":20}}}},"distribuicao":{"type":"array","items":{"type":"object","properties":{"cCodDep":{"type":"string","maxLength":40,"description":"Código do Departamento"},"cDesDep":{"type":"string","maxLength":50,"description":"Descrição do Departamento"},"nValDep":{"type":"number","maxLength":18,"description":"Valor do rateio"},"nPerDep":{"type":"number","maxLength":10,"description":"Percentual do rateio"}}},"description":"Distribuição por Departamentos"},"status_titulo":{"type":"string","maxLength":100,"description":"Status do Título"},"codigo_vendedor":{"type":"integer","maxLength":15,"description":"Código do Vendedor"},"codigo_projeto":{"type":"integer","maxLength":15,"description":"Código do Projeto"},"nsu":{"type":"string","maxLength":100,"description":"Número Sequencial Único - Comprovante de pagamento."},"data_registro":{"type":"string","maxLength":10,"description":"Data de Registro"},"tipo_agrupamento":{"type":"string","maxLength":1,"description":"Tipo de agrupamento dos lançamentos.\n\nPode ser:\nC-Consolidado (sintético).\nI-Individual (analítico).\n\nNão deve ser preenchido na Inclusão/alteração pois é de preenchimento automático para lançamentos recebidos do PDV."},"info":{"type":"object","properties":{"dInc":{"type":"string","maxLength":10,"description":"Data da Inclusão.\nNo formato dd/mm/aaaa."},"hInc":{"type":"string","maxLength":8,"description":"Hora da Inclusão.\nNo formato hh:mm:ss."},"uInc":{"type":"string","maxLength":10,"description":"Usuário da Inclusão."},"dAlt":{"type":"string","maxLength":10,"description":"Data da Alteração.\nNo formato dd/mm/aaaa."},"hAlt":{"type":"string","maxLength":8,"description":"Hora da Alteração.\nNo formato hh:mm:ss."},"uAlt":{"type":"string","maxLength":10,"description":"Usuário da Alteração."},"cImpAPI":{"type":"string","maxLength":1,"description":"Importado pela API (S/N)."}},"description":"Informações complementares do anexo."},"boleto":{"type":"object","properties":{"cGerado":{"type":"string","maxLength":1,"description":"Gerou boleto (S/N)?"},"dDtEmBol":{"type":"string","maxLength":10,"description":"Data de emissão do boleto."},"cNumBoleto":{"type":"string","maxLength":30,"description":"Número do boleto."},"cNumBancario":{"type":"string","maxLength":30,"description":"Número bancário do boleto."},"nPerJuros":{"type":"number","maxLength":10,"description":"Percentual de juros."},"nPerMulta":{"type":"number","maxLength":10,"description":"Percentual de multa."}},"description":"Informações do boleto."},"bloquear_exclusao":{"type":"string","maxLength":1,"description":"Bloqueia a exclusão do registro. (S/N)"},"nCodPedido":{"type":"integer","maxLength":15,"description":"ID do Pedido de Venda.\n\n\nQuando informado na inclusão do título associa o documento a um Pedido de Venda já existente no Omie."},"nCodOS":{"type":"integer","maxLength":15,"description":"ID da Ordem de Serviço.\n\nQuando informado na inclusão do título, preenche o campo numero_pedido para a conta a receber.\n\nObs. O campo nCodOS não é alterado internamente."},"cPedidoCliente":{"type":"string","maxLength":30,"description":"Número do pedido do cliente."},"cNumeroContrato":{"type":"string","maxLength":20,"description":"Número do contrato do cliente."},"recebimento":{"type":"object","properties":{"codigo_recebimento_integracao":{"type":"string","maxLength":20},"codigo_conta_corrente":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente."},"valor":{"type":"number","maxLength":18,"description":"Valor a ser baixado."},"desconto":{"type":"number","maxLength":18,"description":"Valor do desconto."},"juros":{"type":"number","maxLength":18,"description":"Valor do Juros."},"multa":{"type":"number","maxLength":18,"description":"Valor da multa."},"data":{"type":"string","maxLength":10,"description":"Data da Baixa"},"observacao":{"type":"string","description":"Observação da Baixa do Contas a Receber."}},"description":"Detalhes do recebimento (baixa).\nInforme aqui os detalhes do recebimento do lançamento.\n\nAo preencher esse campo é possível detalhar informações da baixa do documento, como: Valor Recebido, Desconto, Juros, Multa, etc.\n\nQuando essa tag estiver preenchida é obrigatório o preenchimento da tag \"baixar_documento\" com \"S\"\n\nCaso essa tag não seja preenchida o lançamento será baixado de forma integral de acordo com os valores do lançamento.\n\nEssa tag é utilizada apenas nos métodos de Inclusão e Alteração.\n\nInformação localizada na Aba \"Recebimentos\" no cadastro do lançamento."},"repeticao":{"type":"object","properties":{"antecipar":{"type":"string","maxLength":1,"description":"Antecipar data de vencimento.\n\nIndica que a data de vencimento será antecipada aos Sábados, Domingos e Feriados Nacionais.\n\nPreencher com \"S\" ou \"N\".\n\nPreencher com \"S\" somente umas das tags:\nantecipar\npostergar"},"postergar":{"type":"string","maxLength":1,"description":"Postergar data de vencimento.\n\nIndica que a data de vencimento será postergada aos Sábados, Domingos e Feriados Nacionais.\n\nPreencher com \"S\" ou \"N\".\n\nPreencher com \"S\" somente umas das tags:\nantecipar\npostergar"},"mensal":{"type":"object","properties":{"repetir_todo_dia":{"type":"integer","maxLength":6,"description":"Informe aqui o dia do mês em que cadá lançamento irá vencer .\n\nExemplo:\nCaso informe dia 30, será cadastrado um lançamento com vencimento para o dia 30 de cada mês."},"repetir_por":{"type":"integer","maxLength":6,"description":"Informe aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições."}},"description":"Repetição mensal.\nInforme aqui os detalhes da repetição mensal do lançamento.\n\nÉ obrigatório o preenchimento de apenas umas das tags:\nmensal\nsemanal\nespecifico"},"semanal":{"type":"object","properties":{"repetir_dia_semana":{"type":"string","maxLength":10,"description":"Informe o dia da semana que será o vencimento do lançamento.\n\nPode ser:\n\ndomingo\nsegunda\nterca\nquarta\nquinta\nsexta\nsabado"},"repetir_por":{"type":"integer","maxLength":6,"description":"Informe aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições."}},"description":"Repetição semanal.\nInforme aqui os detalhes da repetição semanal do lançamento.\n\nÉ obrigatório o preenchimento de apenas umas das tags:\nmensal\nsemanal\nespecifico"},"especifico":{"type":"object","properties":{"repetir_a_cada":{"type":"integer","maxLength":6,"description":"Informe aqui o intervalo em dias entre cada vencimento do lançamento que será cadastrado.\n\nExemplo:\nCaso informe uma quantidade de 10 dias, será cadastrado um lançamento com vencimento a cada 10 dias."},"repetir_por":{"type":"integer","maxLength":6,"description":"Informe aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições."}},"description":"Repetição específica.\nInforme aqui os detalhes da repetição específica do lançamento.\n\nÉ obrigatório o preenchimento de apenas umas das tags:\nmensal\nsemanal\nespecifico"}},"required":["especifico","mensal","semanal"],"description":"Repetição do lançamento.\n\nUtilize essa estrutura para cadastrar várias parcela na mesma requisição.\nEscolha entre as tags \"mensal\", \"semanal\" ou \"especifico\" para definir as datas de vencimento e quantidade de parcelas.\n\nInformação localizada na Aba \"Repetição\" do cadastro do título.\n\nEssa tag é utilizada apenas nos métodos de Inclusão e Alteração."},"aprendizado_rateio":{"type":"string","maxLength":1,"description":"Aprendizado de rateio de departamento.\n\nPreencher com \"S\" ou \"N\".\n\nDefault \"N\"\n\nQuando essa tag for preenchida com \"S\" será assumido o rateio de departamento para a categoria informada na tag \"codigo_categoria\".\n\nEssa tag é utilizada apenas nos métodos de inclusão e alteração."}},"required":["recebimento"]}}}}}},"example":{"call":"IncluirContaReceberPorLote","param":[{"lote":100,"conta_receber_cadastro":[{"codigo_lancamento_integracao":"1790774979","codigo_cliente_fornecedor":4214850,"data_vencimento":"30/09/2026","valor_documento":100.0,"codigo_categoria":"1.01.02","data_previsao":"30/09/2026","id_conta_corrente":4243124},{"codigo_lancamento_integracao":"1790774979","codigo_cliente_fornecedor":4214850,"data_vencimento":"30/09/2026","valor_documento":120.0,"codigo_categoria":"1.01.02","data_previsao":"30/09/2026","id_conta_corrente":4243124}]}]}},"financas_contareceber_IncluirContaReceberPorLote_retorno":{"type":"object","properties":{"lote":{"type":"integer","description":"Número do lote processado"},"codigo_status":{"type":"string","description":"Código do Status do processamento"},"descricao_status":{"type":"string","description":"Descrição do Status do Lote"},"status_lote":{"type":"array","items":{"type":"object","properties":{"codigo_lancamento_omie":{"type":"integer"},"codigo_lancamento_integracao":{"type":"string","description":"Código do lançamento gerado pelo integrador."},"codigo_status":{"type":"string"},"descricao_status":{"type":"string"}}}}},"title":"IncluirContaReceberPorLote (retorno)"},"financas_contareceber_LancarRecebimento":{"type":"object","title":"LancarRecebimento","description":"Realiza a baixa de um título no conta a receber.","required":["call","param"],"properties":{"call":{"type":"string","enum":["LancarRecebimento"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_lancamento":{"type":"integer","maxLength":15,"description":"codigo do lançamento no Omie"},"codigo_lancamento_integracao":{"type":"string","maxLength":60,"description":"Código do lançamento do integrador."},"codigo_baixa":{"type":"integer","maxLength":15,"description":"Código para identificar a baixa do título no Contas a Receber."},"codigo_baixa_integracao":{"type":"string","maxLength":20,"description":"Código da baixa do integrador para identificar a baixa de um título do contas a receber."},"codigo_conta_corrente":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente."},"codigo_conta_corrente_integracao":{"type":"string","maxLength":20,"description":"Código da Conta Corrente do Integrador."},"valor":{"type":"number","maxLength":18,"description":"Valor a ser baixado."},"desconto":{"type":"number","maxLength":18,"description":"Valor do desconto."},"juros":{"type":"number","maxLength":18,"description":"Valor do Juros."},"multa":{"type":"number","maxLength":18,"description":"Valor da multa."},"data":{"type":"string","maxLength":10,"description":"Data da Baixa"},"observacao":{"type":"string","description":"Observação da Baixa do Contas a Receber."},"bloqueado":{"type":"string","maxLength":1},"conciliar_documento":{"type":"string","maxLength":1},"nsu":{"type":"string","maxLength":100,"description":"Número Sequencial Único - Comprovante de pagamento."}},"required":["codigo_conta_corrente","data"]}}},"example":{"call":"LancarRecebimento","param":[{"codigo_lancamento":0,"codigo_baixa":0,"codigo_conta_corrente":0,"valor":0,"data":"","observacao":""}]}},"financas_contareceber_LancarRecebimento_retorno":{"type":"object","properties":{"codigo_lancamento":{"type":"integer","description":"Código do lançamento no contas a receber,"},"codigo_lancamento_integracao":{"type":"string","description":"Código de integração do parceiro para identificar o lançamento no Contas a Receber."},"codigo_baixa":{"type":"integer","description":"Código da baixa do contas a receber no Omie."},"codigo_baixa_integracao":{"type":"string","description":"Código da baixa do integrador para identificar a baixa do título do contas a receber."},"liquidado":{"type":"string","description":"Indica que o recebimento liquidado."},"valor_baixado":{"type":"decimal","description":"Valor baixado"},"codigo_status":{"type":"string","description":"Código do Status da baixa."},"descricao_status":{"type":"string","description":"Descrição do status da baixa do contas a receber."}},"title":"LancarRecebimento (retorno)"},"financas_contareceber_ListarContasReceber":{"type":"object","title":"ListarContasReceber","description":"Lista as contas a receber cadastradas.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarContasReceber"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15},"registros_por_pagina":{"type":"integer","maxLength":15},"apenas_importado_api":{"type":"string","maxLength":1,"example":"S"},"ordenar_por":{"type":"string","maxLength":100,"example":"CODIGO"},"ordem_descrescente":{"type":"string","maxLength":1,"example":"S"},"filtrar_por_data_de":{"type":"string","maxLength":10},"filtrar_por_data_ate":{"type":"string","maxLength":10},"filtrar_apenas_inclusao":{"type":"string","maxLength":1,"example":"S"},"filtrar_apenas_alteracao":{"type":"string","maxLength":1,"example":"S"},"filtrar_por_emissao_de":{"type":"string","maxLength":10},"filtrar_por_registro_de":{"type":"string","maxLength":10},"filtrar_por_emissao_ate":{"type":"string","maxLength":10},"filtrar_por_registro_ate":{"type":"string","maxLength":10},"filtrar_conta_corrente":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente"},"filtrar_apenas_titulos_em_aberto":{"type":"string","maxLength":1,"example":"S"},"filtrar_cliente":{"type":"integer","maxLength":15},"filtrar_por_status":{"type":"string","maxLength":100,"example":"CANCELADO","description":"Filtrar por Status"},"filtrar_por_cpf_cnpj":{"type":"string","maxLength":20,"description":"Filtrar os títulos por CPF/CNPJ"},"filtrar_por_projeto":{"type":"integer","maxLength":15,"description":"Código do Projeto.\n\nInformação localizada na Aba \"Detalhes\" do Contas a Pagar.\n\nUtilize a tag \"codigo\" do método \"ListarProjetos\" da API\nhttp://app.omie.com.br/api/v1/geral/projetos/\npara obter essa informação."},"filtrar_por_vendedor":{"type":"integer","maxLength":15,"description":"Código do Vendedor.\n\nInformação localizada na Aba \"Diversos\" do Contas a Pagar.\n\nUtilize a tag \"codigo\" do método \"ListarVendedores\" da API\nhttp://app.omie.com.br/api/v1/geral/vendedores/\npara obter essa informação."},"exibir_obs":{"type":"string","maxLength":1,"example":"S","description":"Exibir as observações do lançamento (S/N).\n\nPreencher com \"S\" ou \"N\".\n\nDefault \"N\""}}}}},"example":{"call":"ListarContasReceber","param":[{"pagina":1,"registros_por_pagina":20,"apenas_importado_api":"N"}]}},"financas_contareceber_ListarContasReceber_retorno":{"type":"object","properties":{"pagina":{"type":"integer"},"total_de_paginas":{"type":"integer"},"registros":{"type":"integer"},"total_de_registros":{"type":"integer"},"conta_receber_cadastro":{"type":"array","items":{"type":"object","properties":{"codigo_lancamento_omie":{"type":"integer","description":"Chave do Lançamento"},"codigo_lancamento_integracao":{"type":"string","description":"Código do lançamento gerado pelo integrador."},"codigo_cliente_fornecedor":{"type":"integer","description":"Código de Cliente / Fornecedor"},"codigo_cliente_fornecedor_integracao":{"type":"string","description":"Código do cliente informado pelo integrador."},"data_vencimento":{"type":"string","description":"Data de Vencimento"},"valor_documento":{"type":"decimal","description":"Valor do Lançamento"},"codigo_categoria":{"type":"string","description":"Código da Categoria"},"data_previsao":{"type":"string","description":"Data de Previsão de Pagamento/Recebimento"},"categorias":{"type":"array","items":{"type":"object","properties":{"codigo_categoria":{"type":"string"},"valor":{"type":"decimal"},"percentual":{"type":"decimal","description":"Percentual da categoria"}}}},"id_conta_corrente":{"type":"integer","description":"Id da Conta Corrente"},"numero_documento":{"type":"string","description":"Número do Documento"},"numero_parcela":{"type":"string","description":"Número da parcela \"Formatada\" como 999/999"},"codigo_tipo_documento":{"type":"string","description":"Código para o Tipo de Documento"},"numero_documento_fiscal":{"type":"string","description":"Número do Documento Fiscal"},"numero_pedido":{"type":"string","description":"Número do Pedido"},"chave_nfe":{"type":"string","description":"Chave de Acesso da NFE"},"observacao":{"type":"string","description":"Observação"},"codigo_barras_ficha_compensacao":{"type":"string","description":"Código de Barras da Ficha de Compensação"},"codigo_cmc7_cheque":{"type":"string","description":"Código CMC7 do Cheque"},"data_emissao":{"type":"string","description":"Data de Emissão"},"id_origem":{"type":"string","description":"Código da Origem. Informação localizada na Aba \"Diversos\" do Contas a Receber. Os valores disponíveis são: \"APIR\" - Integração de Conta a Receber \"BARR\" - Conta a Receber Importada por Código de Barras \"CTER\" - Parcela a Receber de um CT-e \"DEVR\" - Conta a Receber da Devolução ao Fornecedor \"MANR\" - Lançamento Manual de Conta a Receber \"NFER\" - Conta a Receber Importada de uma NF-e \"RPTR\" - Repetição de Contas a Receber \"VENR\" - Parcela a Receber de Vendas \"XMLR\" - Conta a Receber Importada de um arquivo XML"},"operacao":{"type":"string","description":"Operação"},"valor_pis":{"type":"decimal","description":"Valor do PIS"},"retem_pis":{"type":"string","description":"Indica que o Valor do PIS informado deve ser retido"},"valor_cofins":{"type":"decimal","description":"Valor do COFINS"},"retem_cofins":{"type":"string","description":"Indica que o Valor do COFINS informado deve ser retido"},"valor_csll":{"type":"decimal","description":"Valor do CSLL"},"retem_csll":{"type":"string","description":"Indica que o Valor do CSLL informado deve ser retido"},"valor_ir":{"type":"decimal","description":"Valor do Imposto de Renda"},"retem_ir":{"type":"string","description":"Indica que o Valor do Imposto de Renda informado deve ser retido"},"valor_iss":{"type":"decimal","description":"Valor do ISS"},"retem_iss":{"type":"string","description":"Indica que o Valor do ISS informado deve ser retido"},"valor_inss":{"type":"decimal","description":"Valor do INSS"},"retem_inss":{"type":"string","description":"Indica que o Valor do INSS informado deve ser retido"},"bloqueado":{"type":"string","description":"Bloquear lançamento (S/N)"},"bloquear_baixa":{"type":"string","description":"bloquear a baixa do lançamento"},"importado_api":{"type":"string","description":"Lançamento gerado pela API"},"baixar_documento":{"type":"string","description":"Efetua a baixa automática do documento."},"conciliar_documento":{"type":"string","description":"Efetua a conciliação do documento automaticamente."},"acao":{"type":"string","description":"A-Adiciona Valor / S-Subtrai valor / L-Lança valor."},"lancamento_detalhe":{"type":"array","items":{"type":"object","properties":{"nCodInt":{"type":"string","description":"Código de Integração"},"COO":{"type":"string"},"CCF":{"type":"string"}}}},"distribuicao":{"type":"array","items":{"type":"object","properties":{"cCodDep":{"type":"string","description":"Código do Departamento"},"cDesDep":{"type":"string","description":"Descrição do Departamento"},"nValDep":{"type":"decimal","description":"Valor do rateio"},"nPerDep":{"type":"decimal","description":"Percentual do rateio"}}},"description":"Distribuição por Departamentos"},"status_titulo":{"type":"string","description":"Status do Título"},"codigo_vendedor":{"type":"integer","description":"Código do Vendedor"},"codigo_projeto":{"type":"integer","description":"Código do Projeto"},"nsu":{"type":"string","description":"Número Sequencial Único - Comprovante de pagamento."},"data_registro":{"type":"string","description":"Data de Registro"},"tipo_agrupamento":{"type":"string","description":"Tipo de agrupamento dos lançamentos. Pode ser: C-Consolidado (sintético). I-Individual (analítico). Não deve ser preenchido na Inclusão/alteração pois é de preenchimento automático para lançamentos recebidos do PDV."},"info":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão. No formato dd/mm/aaaa."},"hInc":{"type":"string","description":"Hora da Inclusão. No formato hh:mm:ss."},"uInc":{"type":"string","description":"Usuário da Inclusão."},"dAlt":{"type":"string","description":"Data da Alteração. No formato dd/mm/aaaa."},"hAlt":{"type":"string","description":"Hora da Alteração. No formato hh:mm:ss."},"uAlt":{"type":"string","description":"Usuário da Alteração."},"cImpAPI":{"type":"string","description":"Importado pela API (S/N)."}},"description":"Informações complementares do anexo."},"boleto":{"type":"object","properties":{"cGerado":{"type":"string","description":"Gerou boleto (S/N)?"},"dDtEmBol":{"type":"string","description":"Data de emissão do boleto."},"cNumBoleto":{"type":"string","description":"Número do boleto."},"cNumBancario":{"type":"string","description":"Número bancário do boleto."},"nPerJuros":{"type":"decimal","description":"Percentual de juros."},"nPerMulta":{"type":"decimal","description":"Percentual de multa."}},"description":"Informações do boleto."},"bloquear_exclusao":{"type":"string","description":"Bloqueia a exclusão do registro. (S/N)"},"nCodPedido":{"type":"integer","description":"ID do Pedido de Venda. Quando informado na inclusão do título associa o documento a um Pedido de Venda já existente no Omie."},"nCodOS":{"type":"integer","description":"ID da Ordem de Serviço. Quando informado na inclusão do título, preenche o campo numero_pedido para a conta a receber. Obs. O campo nCodOS não é alterado internamente."},"cPedidoCliente":{"type":"string","description":"Número do pedido do cliente."},"cNumeroContrato":{"type":"string","description":"Número do contrato do cliente."},"recebimento":{"type":"object","properties":{"codigo_recebimento_integracao":{"type":"string"},"codigo_conta_corrente":{"type":"integer","description":"Código da Conta Corrente."},"valor":{"type":"decimal","description":"Valor a ser baixado."},"desconto":{"type":"decimal","description":"Valor do desconto."},"juros":{"type":"decimal","description":"Valor do Juros."},"multa":{"type":"decimal","description":"Valor da multa."},"data":{"type":"string","description":"Data da Baixa"},"observacao":{"type":"string","description":"Observação da Baixa do Contas a Receber."}},"description":"Detalhes do recebimento (baixa). Informe aqui os detalhes do recebimento do lançamento. Ao preencher esse campo é possível detalhar informações da baixa do documento, como: Valor Recebido, Desconto, Juros, Multa, etc. Quando essa tag estiver preenchida é obrigatório o preenchimento da tag \"baixar_documento\" com \"S\" Caso essa tag não seja preenchida o lançamento será baixado de forma integral de acordo com os valores do lançamento. Essa tag é utilizada apenas nos métodos de Inclusão e Alteração. Informação localizada na Aba \"Recebimentos\" no cadastro do lançamento."},"repeticao":{"type":"object","properties":{"antecipar":{"type":"string","description":"Antecipar data de vencimento. Indica que a data de vencimento será antecipada aos Sábados, Domingos e Feriados Nacionais. Preencher com \"S\" ou \"N\". Preencher com \"S\" somente umas das tags: antecipar postergar"},"postergar":{"type":"string","description":"Postergar data de vencimento. Indica que a data de vencimento será postergada aos Sábados, Domingos e Feriados Nacionais. Preencher com \"S\" ou \"N\". Preencher com \"S\" somente umas das tags: antecipar postergar"},"mensal":{"type":"object","properties":{"repetir_todo_dia":{"type":"integer","description":"Informe aqui o dia do mês em que cadá lançamento irá vencer . Exemplo: Caso informe dia 30, será cadastrado um lançamento com vencimento para o dia 30 de cada mês."},"repetir_por":{"type":"integer","description":"Informe aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições."}},"description":"Repetição mensal. Informe aqui os detalhes da repetição mensal do lançamento. É obrigatório o preenchimento de apenas umas das tags: mensal semanal especifico"},"semanal":{"type":"object","properties":{"repetir_dia_semana":{"type":"string","description":"Informe o dia da semana que será o vencimento do lançamento. Pode ser: domingo segunda terca quarta quinta sexta sabado"},"repetir_por":{"type":"integer","description":"Informe aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições."}},"description":"Repetição semanal. Informe aqui os detalhes da repetição semanal do lançamento. É obrigatório o preenchimento de apenas umas das tags: mensal semanal especifico"},"especifico":{"type":"object","properties":{"repetir_a_cada":{"type":"integer","description":"Informe aqui o intervalo em dias entre cada vencimento do lançamento que será cadastrado. Exemplo: Caso informe uma quantidade de 10 dias, será cadastrado um lançamento com vencimento a cada 10 dias."},"repetir_por":{"type":"integer","description":"Informe aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições."}},"description":"Repetição específica. Informe aqui os detalhes da repetição específica do lançamento. É obrigatório o preenchimento de apenas umas das tags: mensal semanal especifico"}},"description":"Repetição do lançamento. Utilize essa estrutura para cadastrar várias parcela na mesma requisição. Escolha entre as tags \"mensal\", \"semanal\" ou \"especifico\" para definir as datas de vencimento e quantidade de parcelas. Informação localizada na Aba \"Repetição\" do cadastro do título. Essa tag é utilizada apenas nos métodos de Inclusão e Alteração."},"aprendizado_rateio":{"type":"string","description":"Aprendizado de rateio de departamento. Preencher com \"S\" ou \"N\". Default \"N\" Quando essa tag for preenchida com \"S\" será assumido o rateio de departamento para a categoria informada na tag \"codigo_categoria\". Essa tag é utilizada apenas nos métodos de inclusão e alteração."}}}}},"title":"ListarContasReceber (retorno)"},"financas_contareceber_UpsertContaReceber":{"type":"object","title":"UpsertContaReceber","description":"Executa o Upsert do Contas a receber","required":["call","param"],"properties":{"call":{"type":"string","enum":["UpsertContaReceber"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_lancamento_omie":{"type":"integer","maxLength":15,"description":"Chave do Lançamento"},"codigo_lancamento_integracao":{"type":"string","maxLength":60,"description":"Código do lançamento gerado pelo integrador."},"codigo_cliente_fornecedor":{"type":"integer","maxLength":15,"description":"Código de Cliente / Fornecedor"},"codigo_cliente_fornecedor_integracao":{"type":"string","maxLength":60,"description":"Código do cliente informado pelo integrador."},"data_vencimento":{"type":"string","maxLength":10,"description":"Data de Vencimento"},"valor_documento":{"type":"number","maxLength":18,"description":"Valor do Lançamento"},"codigo_categoria":{"type":"string","maxLength":20,"description":"Código da Categoria"},"categorias":{"type":"array","items":{"type":"object","properties":{"codigo_categoria":{"type":"string","maxLength":20},"valor":{"type":"number","maxLength":18},"percentual":{"type":"number","maxLength":10,"description":"Percentual da categoria"}}}},"data_previsao":{"type":"string","maxLength":10,"description":"Data de Previsão de Pagamento/Recebimento"},"id_conta_corrente":{"type":"integer","maxLength":15,"description":"Id da Conta Corrente"},"numero_documento":{"type":"string","maxLength":20,"description":"Número do Documento"},"numero_parcela":{"type":"string","maxLength":7,"description":"Número da parcela \"Formatada\" como 999/999"},"codigo_tipo_documento":{"type":"string","maxLength":5,"description":"Código para o Tipo de Documento"},"numero_documento_fiscal":{"type":"string","maxLength":20,"description":"Número do Documento Fiscal"},"numero_pedido":{"type":"string","maxLength":15,"description":"Número do Pedido"},"chave_nfe":{"type":"string","maxLength":44,"description":"Chave de Acesso da NFE"},"observacao":{"type":"string","description":"Observação"},"codigo_barras_ficha_compensacao":{"type":"string","maxLength":70,"description":"Código de Barras da Ficha de Compensação"},"codigo_cmc7_cheque":{"type":"string","maxLength":40,"description":"Código CMC7 do Cheque"},"data_emissao":{"type":"string","maxLength":10,"description":"Data de Emissão"},"id_origem":{"type":"string","maxLength":4,"description":"Código da Origem.\n\nInformação localizada na Aba \"Diversos\" do Contas a Receber.\n\nOs valores disponíveis são:\n\n\"APIR\" - Integração de Conta a Receber\n\"BARR\" - Conta a Receber Importada por Código de Barras\n\"CTER\" - Parcela a Receber de um CT-e\n\"DEVR\" - Conta a Receber da Devolução ao Fornecedor\n\"MANR\" - Lançamento Manual de Conta a Receber\n\"NFER\" - Conta a Receber Importada de uma NF-e\n\"RPTR\" - Repetição de Contas a Receber\n\"VENR\" - Parcela a Receber de Vendas\n\"XMLR\" - Conta a Receber Importada de um arquivo XML"},"operacao":{"type":"string","maxLength":2,"description":"Operação"},"valor_pis":{"type":"number","maxLength":18,"description":"Valor do PIS"},"retem_pis":{"type":"string","maxLength":1,"description":"Indica que o Valor do PIS informado deve ser retido"},"valor_cofins":{"type":"number","maxLength":18,"description":"Valor do COFINS"},"retem_cofins":{"type":"string","maxLength":1,"description":"Indica que o Valor do COFINS informado deve ser retido"},"valor_csll":{"type":"number","maxLength":18,"description":"Valor do CSLL"},"retem_csll":{"type":"string","maxLength":1,"description":"Indica que o Valor do CSLL informado deve ser retido"},"valor_ir":{"type":"number","maxLength":18,"description":"Valor do Imposto de Renda"},"retem_ir":{"type":"string","maxLength":1,"description":"Indica que o Valor do Imposto de Renda  informado deve ser retido"},"valor_iss":{"type":"number","maxLength":18,"description":"Valor do ISS"},"retem_iss":{"type":"string","maxLength":1,"description":"Indica que o Valor do ISS informado deve ser retido"},"valor_inss":{"type":"number","maxLength":18,"description":"Valor do INSS"},"retem_inss":{"type":"string","maxLength":1,"description":"Indica que o Valor do INSS informado deve ser retido"},"bloqueado":{"type":"string","maxLength":1,"description":"Bloquear lançamento (S/N)"},"bloquear_baixa":{"type":"string","maxLength":1,"description":"bloquear a baixa do lançamento"},"importado_api":{"type":"string","maxLength":1,"description":"Lançamento gerado pela API"},"baixar_documento":{"type":"string","maxLength":1,"description":"Efetua a baixa automática do documento."},"conciliar_documento":{"type":"string","maxLength":1,"description":"Efetua a conciliação do documento automaticamente."},"acao":{"type":"string","description":"A-Adiciona Valor / S-Subtrai valor / L-Lança valor."},"lancamento_detalhe":{"type":"array","items":{"type":"object","properties":{"nCodInt":{"type":"string","maxLength":20,"description":"Código de Integração"},"COO":{"type":"string","maxLength":20},"CCF":{"type":"string","maxLength":20}}}},"distribuicao":{"type":"array","items":{"type":"object","properties":{"cCodDep":{"type":"string","maxLength":40,"description":"Código do Departamento"},"cDesDep":{"type":"string","maxLength":50,"description":"Descrição do Departamento"},"nValDep":{"type":"number","maxLength":18,"description":"Valor do rateio"},"nPerDep":{"type":"number","maxLength":10,"description":"Percentual do rateio"}}},"description":"Distribuição por Departamentos"},"status_titulo":{"type":"string","maxLength":100,"description":"Status do Título"},"codigo_vendedor":{"type":"integer","maxLength":15,"description":"Código do Vendedor"},"codigo_projeto":{"type":"integer","maxLength":15,"description":"Código do Projeto"},"nsu":{"type":"string","maxLength":100,"description":"Número Sequencial Único - Comprovante de pagamento."},"data_registro":{"type":"string","maxLength":10,"description":"Data de Registro"},"tipo_agrupamento":{"type":"string","maxLength":1,"description":"Tipo de agrupamento dos lançamentos.\n\nPode ser:\nC-Consolidado (sintético).\nI-Individual (analítico).\n\nNão deve ser preenchido na Inclusão/alteração pois é de preenchimento automático para lançamentos recebidos do PDV."},"info":{"type":"object","properties":{"dInc":{"type":"string","maxLength":10,"description":"Data da Inclusão.\nNo formato dd/mm/aaaa."},"hInc":{"type":"string","maxLength":8,"description":"Hora da Inclusão.\nNo formato hh:mm:ss."},"uInc":{"type":"string","maxLength":10,"description":"Usuário da Inclusão."},"dAlt":{"type":"string","maxLength":10,"description":"Data da Alteração.\nNo formato dd/mm/aaaa."},"hAlt":{"type":"string","maxLength":8,"description":"Hora da Alteração.\nNo formato hh:mm:ss."},"uAlt":{"type":"string","maxLength":10,"description":"Usuário da Alteração."},"cImpAPI":{"type":"string","maxLength":1,"description":"Importado pela API (S/N)."}},"description":"Informações complementares do anexo."},"boleto":{"type":"object","properties":{"cGerado":{"type":"string","maxLength":1,"description":"Gerou boleto (S/N)?"},"dDtEmBol":{"type":"string","maxLength":10,"description":"Data de emissão do boleto."},"cNumBoleto":{"type":"string","maxLength":30,"description":"Número do boleto."},"cNumBancario":{"type":"string","maxLength":30,"description":"Número bancário do boleto."},"nPerJuros":{"type":"number","maxLength":10,"description":"Percentual de juros."},"nPerMulta":{"type":"number","maxLength":10,"description":"Percentual de multa."}},"description":"Informações do boleto."},"bloquear_exclusao":{"type":"string","maxLength":1,"description":"Bloqueia a exclusão do registro. (S/N)"},"nCodPedido":{"type":"integer","maxLength":15,"description":"ID do Pedido de Venda.\n\n\nQuando informado na inclusão do título associa o documento a um Pedido de Venda já existente no Omie."},"nCodOS":{"type":"integer","maxLength":15,"description":"ID da Ordem de Serviço.\n\nQuando informado na inclusão do título, preenche o campo numero_pedido para a conta a receber.\n\nObs. O campo nCodOS não é alterado internamente."},"cPedidoCliente":{"type":"string","maxLength":30,"description":"Número do pedido do cliente."},"cNumeroContrato":{"type":"string","maxLength":20,"description":"Número do contrato do cliente."},"recebimento":{"type":"object","properties":{"codigo_recebimento_integracao":{"type":"string","maxLength":20},"codigo_conta_corrente":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente."},"valor":{"type":"number","maxLength":18,"description":"Valor a ser baixado."},"desconto":{"type":"number","maxLength":18,"description":"Valor do desconto."},"juros":{"type":"number","maxLength":18,"description":"Valor do Juros."},"multa":{"type":"number","maxLength":18,"description":"Valor da multa."},"data":{"type":"string","maxLength":10,"description":"Data da Baixa"},"observacao":{"type":"string","description":"Observação da Baixa do Contas a Receber."}},"description":"Detalhes do recebimento (baixa).\nInforme aqui os detalhes do recebimento do lançamento.\n\nAo preencher esse campo é possível detalhar informações da baixa do documento, como: Valor Recebido, Desconto, Juros, Multa, etc.\n\nQuando essa tag estiver preenchida é obrigatório o preenchimento da tag \"baixar_documento\" com \"S\"\n\nCaso essa tag não seja preenchida o lançamento será baixado de forma integral de acordo com os valores do lançamento.\n\nEssa tag é utilizada apenas nos métodos de Inclusão e Alteração.\n\nInformação localizada na Aba \"Recebimentos\" no cadastro do lançamento."},"repeticao":{"type":"object","properties":{"antecipar":{"type":"string","maxLength":1,"description":"Antecipar data de vencimento.\n\nIndica que a data de vencimento será antecipada aos Sábados, Domingos e Feriados Nacionais.\n\nPreencher com \"S\" ou \"N\".\n\nPreencher com \"S\" somente umas das tags:\nantecipar\npostergar"},"postergar":{"type":"string","maxLength":1,"description":"Postergar data de vencimento.\n\nIndica que a data de vencimento será postergada aos Sábados, Domingos e Feriados Nacionais.\n\nPreencher com \"S\" ou \"N\".\n\nPreencher com \"S\" somente umas das tags:\nantecipar\npostergar"},"mensal":{"type":"object","properties":{"repetir_todo_dia":{"type":"integer","maxLength":6,"description":"Informe aqui o dia do mês em que cadá lançamento irá vencer .\n\nExemplo:\nCaso informe dia 30, será cadastrado um lançamento com vencimento para o dia 30 de cada mês."},"repetir_por":{"type":"integer","maxLength":6,"description":"Informe aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições."}},"description":"Repetição mensal.\nInforme aqui os detalhes da repetição mensal do lançamento.\n\nÉ obrigatório o preenchimento de apenas umas das tags:\nmensal\nsemanal\nespecifico"},"semanal":{"type":"object","properties":{"repetir_dia_semana":{"type":"string","maxLength":10,"description":"Informe o dia da semana que será o vencimento do lançamento.\n\nPode ser:\n\ndomingo\nsegunda\nterca\nquarta\nquinta\nsexta\nsabado"},"repetir_por":{"type":"integer","maxLength":6,"description":"Informe aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições."}},"description":"Repetição semanal.\nInforme aqui os detalhes da repetição semanal do lançamento.\n\nÉ obrigatório o preenchimento de apenas umas das tags:\nmensal\nsemanal\nespecifico"},"especifico":{"type":"object","properties":{"repetir_a_cada":{"type":"integer","maxLength":6,"description":"Informe aqui o intervalo em dias entre cada vencimento do lançamento que será cadastrado.\n\nExemplo:\nCaso informe uma quantidade de 10 dias, será cadastrado um lançamento com vencimento a cada 10 dias."},"repetir_por":{"type":"integer","maxLength":6,"description":"Informe aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições."}},"description":"Repetição específica.\nInforme aqui os detalhes da repetição específica do lançamento.\n\nÉ obrigatório o preenchimento de apenas umas das tags:\nmensal\nsemanal\nespecifico"}},"required":["especifico","mensal","semanal"],"description":"Repetição do lançamento.\n\nUtilize essa estrutura para cadastrar várias parcela na mesma requisição.\nEscolha entre as tags \"mensal\", \"semanal\" ou \"especifico\" para definir as datas de vencimento e quantidade de parcelas.\n\nInformação localizada na Aba \"Repetição\" do cadastro do título.\n\nEssa tag é utilizada apenas nos métodos de Inclusão e Alteração."},"aprendizado_rateio":{"type":"string","maxLength":1,"description":"Aprendizado de rateio de departamento.\n\nPreencher com \"S\" ou \"N\".\n\nDefault \"N\"\n\nQuando essa tag for preenchida com \"S\" será assumido o rateio de departamento para a categoria informada na tag \"codigo_categoria\".\n\nEssa tag é utilizada apenas nos métodos de inclusão e alteração."}},"required":["recebimento"]}}},"example":{"call":"UpsertContaReceber","param":[{"codigo_lancamento_integracao":"1790774979","codigo_cliente_fornecedor":4214850,"data_vencimento":"30/09/2026","valor_documento":100.0,"codigo_categoria":"1.01.02","data_previsao":"30/09/2026","id_conta_corrente":4243124}]}},"financas_contareceber_UpsertContaReceber_retorno":{"type":"object","properties":{"codigo_lancamento_omie":{"type":"integer"},"codigo_lancamento_integracao":{"type":"string","description":"Código do lançamento gerado pelo integrador."},"codigo_status":{"type":"string"},"descricao_status":{"type":"string"}},"title":"UpsertContaReceber (retorno)"},"financas_contareceber_UpsertContaReceberPorLote":{"type":"object","title":"UpsertContaReceberPorLote","description":"Efetua o UPSERT do Contas a Receber por Lote.","required":["call","param"],"properties":{"call":{"type":"string","enum":["UpsertContaReceberPorLote"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"lote":{"type":"integer","maxLength":15,"description":"Número do lote de lançamentos de contas a receber."},"conta_receber_cadastro":{"type":"array","items":{"type":"object","properties":{"codigo_lancamento_omie":{"type":"integer","maxLength":15,"description":"Chave do Lançamento"},"codigo_lancamento_integracao":{"type":"string","maxLength":60,"description":"Código do lançamento gerado pelo integrador."},"codigo_cliente_fornecedor":{"type":"integer","maxLength":15,"description":"Código de Cliente / Fornecedor"},"codigo_cliente_fornecedor_integracao":{"type":"string","maxLength":60,"description":"Código do cliente informado pelo integrador."},"data_vencimento":{"type":"string","maxLength":10,"description":"Data de Vencimento"},"valor_documento":{"type":"number","maxLength":18,"description":"Valor do Lançamento"},"codigo_categoria":{"type":"string","maxLength":20,"description":"Código da Categoria"},"data_previsao":{"type":"string","maxLength":10,"description":"Data de Previsão de Pagamento/Recebimento"},"categorias":{"type":"array","items":{"type":"object","properties":{"codigo_categoria":{"type":"string","maxLength":20},"valor":{"type":"number","maxLength":18},"percentual":{"type":"number","maxLength":10,"description":"Percentual da categoria"}}}},"id_conta_corrente":{"type":"integer","maxLength":15,"description":"Id da Conta Corrente"},"numero_documento":{"type":"string","maxLength":20,"description":"Número do Documento"},"numero_parcela":{"type":"string","maxLength":7,"description":"Número da parcela \"Formatada\" como 999/999"},"codigo_tipo_documento":{"type":"string","maxLength":5,"description":"Código para o Tipo de Documento"},"numero_documento_fiscal":{"type":"string","maxLength":20,"description":"Número do Documento Fiscal"},"numero_pedido":{"type":"string","maxLength":15,"description":"Número do Pedido"},"chave_nfe":{"type":"string","maxLength":44,"description":"Chave de Acesso da NFE"},"observacao":{"type":"string","description":"Observação"},"codigo_barras_ficha_compensacao":{"type":"string","maxLength":70,"description":"Código de Barras da Ficha de Compensação"},"codigo_cmc7_cheque":{"type":"string","maxLength":40,"description":"Código CMC7 do Cheque"},"data_emissao":{"type":"string","maxLength":10,"description":"Data de Emissão"},"id_origem":{"type":"string","maxLength":4,"description":"Código da Origem.\n\nInformação localizada na Aba \"Diversos\" do Contas a Receber.\n\nOs valores disponíveis são:\n\n\"APIR\" - Integração de Conta a Receber\n\"BARR\" - Conta a Receber Importada por Código de Barras\n\"CTER\" - Parcela a Receber de um CT-e\n\"DEVR\" - Conta a Receber da Devolução ao Fornecedor\n\"MANR\" - Lançamento Manual de Conta a Receber\n\"NFER\" - Conta a Receber Importada de uma NF-e\n\"RPTR\" - Repetição de Contas a Receber\n\"VENR\" - Parcela a Receber de Vendas\n\"XMLR\" - Conta a Receber Importada de um arquivo XML"},"operacao":{"type":"string","maxLength":2,"description":"Operação"},"valor_pis":{"type":"number","maxLength":18,"description":"Valor do PIS"},"retem_pis":{"type":"string","maxLength":1,"description":"Indica que o Valor do PIS informado deve ser retido"},"valor_cofins":{"type":"number","maxLength":18,"description":"Valor do COFINS"},"retem_cofins":{"type":"string","maxLength":1,"description":"Indica que o Valor do COFINS informado deve ser retido"},"valor_csll":{"type":"number","maxLength":18,"description":"Valor do CSLL"},"retem_csll":{"type":"string","maxLength":1,"description":"Indica que o Valor do CSLL informado deve ser retido"},"valor_ir":{"type":"number","maxLength":18,"description":"Valor do Imposto de Renda"},"retem_ir":{"type":"string","maxLength":1,"description":"Indica que o Valor do Imposto de Renda  informado deve ser retido"},"valor_iss":{"type":"number","maxLength":18,"description":"Valor do ISS"},"retem_iss":{"type":"string","maxLength":1,"description":"Indica que o Valor do ISS informado deve ser retido"},"valor_inss":{"type":"number","maxLength":18,"description":"Valor do INSS"},"retem_inss":{"type":"string","maxLength":1,"description":"Indica que o Valor do INSS informado deve ser retido"},"bloqueado":{"type":"string","maxLength":1,"description":"Bloquear lançamento (S/N)"},"bloquear_baixa":{"type":"string","maxLength":1,"description":"bloquear a baixa do lançamento"},"importado_api":{"type":"string","maxLength":1,"description":"Lançamento gerado pela API"},"baixar_documento":{"type":"string","maxLength":1,"description":"Efetua a baixa automática do documento."},"conciliar_documento":{"type":"string","maxLength":1,"description":"Efetua a conciliação do documento automaticamente."},"acao":{"type":"string","description":"A-Adiciona Valor / S-Subtrai valor / L-Lança valor."},"lancamento_detalhe":{"type":"array","items":{"type":"object","properties":{"nCodInt":{"type":"string","maxLength":20,"description":"Código de Integração"},"COO":{"type":"string","maxLength":20},"CCF":{"type":"string","maxLength":20}}}},"distribuicao":{"type":"array","items":{"type":"object","properties":{"cCodDep":{"type":"string","maxLength":40,"description":"Código do Departamento"},"cDesDep":{"type":"string","maxLength":50,"description":"Descrição do Departamento"},"nValDep":{"type":"number","maxLength":18,"description":"Valor do rateio"},"nPerDep":{"type":"number","maxLength":10,"description":"Percentual do rateio"}}},"description":"Distribuição por Departamentos"},"status_titulo":{"type":"string","maxLength":100,"description":"Status do Título"},"codigo_vendedor":{"type":"integer","maxLength":15,"description":"Código do Vendedor"},"codigo_projeto":{"type":"integer","maxLength":15,"description":"Código do Projeto"},"nsu":{"type":"string","maxLength":100,"description":"Número Sequencial Único - Comprovante de pagamento."},"data_registro":{"type":"string","maxLength":10,"description":"Data de Registro"},"tipo_agrupamento":{"type":"string","maxLength":1,"description":"Tipo de agrupamento dos lançamentos.\n\nPode ser:\nC-Consolidado (sintético).\nI-Individual (analítico).\n\nNão deve ser preenchido na Inclusão/alteração pois é de preenchimento automático para lançamentos recebidos do PDV."},"info":{"type":"object","properties":{"dInc":{"type":"string","maxLength":10,"description":"Data da Inclusão.\nNo formato dd/mm/aaaa."},"hInc":{"type":"string","maxLength":8,"description":"Hora da Inclusão.\nNo formato hh:mm:ss."},"uInc":{"type":"string","maxLength":10,"description":"Usuário da Inclusão."},"dAlt":{"type":"string","maxLength":10,"description":"Data da Alteração.\nNo formato dd/mm/aaaa."},"hAlt":{"type":"string","maxLength":8,"description":"Hora da Alteração.\nNo formato hh:mm:ss."},"uAlt":{"type":"string","maxLength":10,"description":"Usuário da Alteração."},"cImpAPI":{"type":"string","maxLength":1,"description":"Importado pela API (S/N)."}},"description":"Informações complementares do anexo."},"boleto":{"type":"object","properties":{"cGerado":{"type":"string","maxLength":1,"description":"Gerou boleto (S/N)?"},"dDtEmBol":{"type":"string","maxLength":10,"description":"Data de emissão do boleto."},"cNumBoleto":{"type":"string","maxLength":30,"description":"Número do boleto."},"cNumBancario":{"type":"string","maxLength":30,"description":"Número bancário do boleto."},"nPerJuros":{"type":"number","maxLength":10,"description":"Percentual de juros."},"nPerMulta":{"type":"number","maxLength":10,"description":"Percentual de multa."}},"description":"Informações do boleto."},"bloquear_exclusao":{"type":"string","maxLength":1,"description":"Bloqueia a exclusão do registro. (S/N)"},"nCodPedido":{"type":"integer","maxLength":15,"description":"ID do Pedido de Venda.\n\n\nQuando informado na inclusão do título associa o documento a um Pedido de Venda já existente no Omie."},"nCodOS":{"type":"integer","maxLength":15,"description":"ID da Ordem de Serviço.\n\nQuando informado na inclusão do título, preenche o campo numero_pedido para a conta a receber.\n\nObs. O campo nCodOS não é alterado internamente."},"cPedidoCliente":{"type":"string","maxLength":30,"description":"Número do pedido do cliente."},"cNumeroContrato":{"type":"string","maxLength":20,"description":"Número do contrato do cliente."},"recebimento":{"type":"object","properties":{"codigo_recebimento_integracao":{"type":"string","maxLength":20},"codigo_conta_corrente":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente."},"valor":{"type":"number","maxLength":18,"description":"Valor a ser baixado."},"desconto":{"type":"number","maxLength":18,"description":"Valor do desconto."},"juros":{"type":"number","maxLength":18,"description":"Valor do Juros."},"multa":{"type":"number","maxLength":18,"description":"Valor da multa."},"data":{"type":"string","maxLength":10,"description":"Data da Baixa"},"observacao":{"type":"string","description":"Observação da Baixa do Contas a Receber."}},"description":"Detalhes do recebimento (baixa).\nInforme aqui os detalhes do recebimento do lançamento.\n\nAo preencher esse campo é possível detalhar informações da baixa do documento, como: Valor Recebido, Desconto, Juros, Multa, etc.\n\nQuando essa tag estiver preenchida é obrigatório o preenchimento da tag \"baixar_documento\" com \"S\"\n\nCaso essa tag não seja preenchida o lançamento será baixado de forma integral de acordo com os valores do lançamento.\n\nEssa tag é utilizada apenas nos métodos de Inclusão e Alteração.\n\nInformação localizada na Aba \"Recebimentos\" no cadastro do lançamento."},"repeticao":{"type":"object","properties":{"antecipar":{"type":"string","maxLength":1,"description":"Antecipar data de vencimento.\n\nIndica que a data de vencimento será antecipada aos Sábados, Domingos e Feriados Nacionais.\n\nPreencher com \"S\" ou \"N\".\n\nPreencher com \"S\" somente umas das tags:\nantecipar\npostergar"},"postergar":{"type":"string","maxLength":1,"description":"Postergar data de vencimento.\n\nIndica que a data de vencimento será postergada aos Sábados, Domingos e Feriados Nacionais.\n\nPreencher com \"S\" ou \"N\".\n\nPreencher com \"S\" somente umas das tags:\nantecipar\npostergar"},"mensal":{"type":"object","properties":{"repetir_todo_dia":{"type":"integer","maxLength":6,"description":"Informe aqui o dia do mês em que cadá lançamento irá vencer .\n\nExemplo:\nCaso informe dia 30, será cadastrado um lançamento com vencimento para o dia 30 de cada mês."},"repetir_por":{"type":"integer","maxLength":6,"description":"Informe aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições."}},"description":"Repetição mensal.\nInforme aqui os detalhes da repetição mensal do lançamento.\n\nÉ obrigatório o preenchimento de apenas umas das tags:\nmensal\nsemanal\nespecifico"},"semanal":{"type":"object","properties":{"repetir_dia_semana":{"type":"string","maxLength":10,"description":"Informe o dia da semana que será o vencimento do lançamento.\n\nPode ser:\n\ndomingo\nsegunda\nterca\nquarta\nquinta\nsexta\nsabado"},"repetir_por":{"type":"integer","maxLength":6,"description":"Informe aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições."}},"description":"Repetição semanal.\nInforme aqui os detalhes da repetição semanal do lançamento.\n\nÉ obrigatório o preenchimento de apenas umas das tags:\nmensal\nsemanal\nespecifico"},"especifico":{"type":"object","properties":{"repetir_a_cada":{"type":"integer","maxLength":6,"description":"Informe aqui o intervalo em dias entre cada vencimento do lançamento que será cadastrado.\n\nExemplo:\nCaso informe uma quantidade de 10 dias, será cadastrado um lançamento com vencimento a cada 10 dias."},"repetir_por":{"type":"integer","maxLength":6,"description":"Informe aqui a quantidade de parcelas que serão cadastradas com um limite de até 120 repetições."}},"description":"Repetição específica.\nInforme aqui os detalhes da repetição específica do lançamento.\n\nÉ obrigatório o preenchimento de apenas umas das tags:\nmensal\nsemanal\nespecifico"}},"required":["especifico","mensal","semanal"],"description":"Repetição do lançamento.\n\nUtilize essa estrutura para cadastrar várias parcela na mesma requisição.\nEscolha entre as tags \"mensal\", \"semanal\" ou \"especifico\" para definir as datas de vencimento e quantidade de parcelas.\n\nInformação localizada na Aba \"Repetição\" do cadastro do título.\n\nEssa tag é utilizada apenas nos métodos de Inclusão e Alteração."},"aprendizado_rateio":{"type":"string","maxLength":1,"description":"Aprendizado de rateio de departamento.\n\nPreencher com \"S\" ou \"N\".\n\nDefault \"N\"\n\nQuando essa tag for preenchida com \"S\" será assumido o rateio de departamento para a categoria informada na tag \"codigo_categoria\".\n\nEssa tag é utilizada apenas nos métodos de inclusão e alteração."}},"required":["recebimento"]}}}}}},"example":{"call":"UpsertContaReceberPorLote","param":[{"lote":100,"conta_receber_cadastro":[{"codigo_lancamento_integracao":"1790774979","codigo_cliente_fornecedor":4214850,"data_vencimento":"30/09/2026","valor_documento":100.0,"codigo_categoria":"1.01.02","data_previsao":"30/09/2026","id_conta_corrente":4243124},{"codigo_lancamento_integracao":"1790774979","codigo_cliente_fornecedor":4214850,"data_vencimento":"30/09/2026","valor_documento":120.0,"codigo_categoria":"1.01.02","data_previsao":"30/09/2026","id_conta_corrente":4243124}]}]}},"financas_contareceber_UpsertContaReceberPorLote_retorno":{"type":"object","properties":{"lote":{"type":"integer","description":"Número do lote processado"},"codigo_status":{"type":"string","description":"Código do Status do processamento"},"descricao_status":{"type":"string","description":"Descrição do Status do Lote"},"status_lote":{"type":"array","items":{"type":"object","properties":{"codigo_lancamento_omie":{"type":"integer"},"codigo_lancamento_integracao":{"type":"string","description":"Código do lançamento gerado pelo integrador."},"codigo_status":{"type":"string"},"descricao_status":{"type":"string"}}}}},"title":"UpsertContaReceberPorLote (retorno)"},"financas_contareceberanexos_lcrConsultarAnexo":{"type":"object","title":"lcrConsultarAnexo","description":"Consulta um anexo de um título do Contas a Receber.","required":["call","param"],"properties":{"call":{"type":"string","enum":["lcrConsultarAnexo"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodTitulo":{"type":"integer","maxLength":15,"description":"Código do título do Contas a Receber.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno do título do contas a receber gerado pelo Omie."},"cCodIntTitulo":{"type":"string","maxLength":60,"description":"Código de integração do título do Contas a Receber.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código do título utilizado no seu aplicativo quando incluir um título no Omie.\nAssim, poderá utilizar esse campo para resgatar as informações do título desejado.\nCaso informe esse campo, não informe a tag nCodInt. Caso isso aconteça, o conteúdo dessa tag seja desconsiderada."},"cCodIntAnexo":{"type":"string","maxLength":20,"description":"Código de integração do anexo.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nUtilize esse campo para informar o código do anexo utilizado no seu aplicativo quando incluir o anexo no Omie.\nAssim, poderá utilizar esse campo para resgatar o anexo desejado."},"cNomeArq":{"type":"string","maxLength":100,"description":"Nome do arquivo que foi adicionado.\nPreencha essa tag, apenas se você não tiver ou souber qual é o código de integração do anexo (tag cCodIntAnexo).\nCaso a tag cCodIntAnexo esteja preenchida, o conteúdo dessa tag será desconsiderado."}}}}},"example":{"call":"lcrConsultarAnexo","param":[{"nCodTitulo":0,"cCodIntTitulo":"","cCodIntAnexo":"","cNomeArq":""}]}},"financas_contareceberanexos_lcrConsultarAnexo_retorno":{"type":"object","properties":{"nCodTitulo":{"type":"integer","description":"Código do título do Contas a Receber. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do título do contas a receber gerado pelo Omie."},"cCodIntTitulo":{"type":"string","description":"Código de integração do título do Contas a Receber. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código do título utilizado no seu aplicativo quando incluir um título no Omie. Assim, poderá utilizar esse campo para resgatar as informações do título desejado. Caso informe esse campo, não informe a tag nCodInt. Caso isso aconteça, o conteúdo dessa tag seja desconsiderada."},"cCodIntAnexo":{"type":"string","description":"Código de integração do anexo. (Interno, utilizado apenas na integração via API, não é exibido na tela). Utilize esse campo para informar o código do anexo utilizado no seu aplicativo quando incluir o anexo no Omie. Assim, poderá utilizar esse campo para resgatar o anexo desejado."},"cNomeArq":{"type":"string","description":"Nome do arquivo que foi adicionado. Preencha essa tag, apenas se você não tiver ou souber qual é o código de integração do anexo (tag cCodIntAnexo). Caso a tag cCodIntAnexo esteja preenchida, o conteúdo dessa tag será desconsiderado."},"info":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão. No formato dd/mm/aaaa."},"hInc":{"type":"string","description":"Hora da Inclusão. No formato hh:mm:ss."},"uInc":{"type":"string","description":"Usuário da Inclusão."},"dAlt":{"type":"string","description":"Data da Alteração. No formato dd/mm/aaaa."},"hAlt":{"type":"string","description":"Hora da Alteração. No formato hh:mm:ss."},"uAlt":{"type":"string","description":"Usuário da Alteração."},"cImpAPI":{"type":"string","description":"Importado pela API (S/N)."}},"description":"Informações complementares do anexo."}},"title":"lcrConsultarAnexo (retorno)"},"financas_contareceberanexos_lcrExcluirAnexo":{"type":"object","title":"lcrExcluirAnexo","description":"Exclui um anexo de um título do Contas a Receber.","required":["call","param"],"properties":{"call":{"type":"string","enum":["lcrExcluirAnexo"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodTitulo":{"type":"integer","maxLength":15,"description":"Código do título do Contas a Receber.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno do título do contas a receber gerado pelo Omie."},"cCodIntTitulo":{"type":"string","maxLength":60,"description":"Código de integração do título do Contas a Receber.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código do título utilizado no seu aplicativo quando incluir um título no Omie.\nAssim, poderá utilizar esse campo para resgatar as informações do título desejado.\nCaso informe esse campo, não informe a tag nCodInt. Caso isso aconteça, o conteúdo dessa tag seja desconsiderada."},"cCodIntAnexo":{"type":"string","maxLength":20,"description":"Código de integração do anexo.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nUtilize esse campo para informar o código do anexo utilizado no seu aplicativo quando incluir o anexo no Omie.\nAssim, poderá utilizar esse campo para resgatar o anexo desejado."},"cNomeArq":{"type":"string","maxLength":100,"description":"Nome do arquivo que foi adicionado.\nPreencha essa tag, apenas se você não tiver ou souber qual é o código de integração do anexo (tag cCodIntAnexo).\nCaso a tag cCodIntAnexo esteja preenchida, o conteúdo dessa tag será desconsiderado."}}}}},"example":{"call":"lcrExcluirAnexo","param":[{"nCodTitulo":0,"cCodIntTitulo":"","cCodIntAnexo":"","cNomeArq":""}]}},"financas_contareceberanexos_lcrExcluirAnexo_retorno":{"type":"object","properties":{"nCodTitulo":{"type":"integer","description":"Código do título do Contas a Receber. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do título do contas a receber gerado pelo Omie."},"cCodIntTitulo":{"type":"string","description":"Código de integração do título do Contas a Receber. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código do título utilizado no seu aplicativo quando incluir um título no Omie. Assim, poderá utilizar esse campo para resgatar as informações do título desejado. Caso informe esse campo, não informe a tag nCodInt. Caso isso aconteça, o conteúdo dessa tag seja desconsiderada."},"cCodIntAnexo":{"type":"string","description":"Código de integração do anexo. (Interno, utilizado apenas na integração via API, não é exibido na tela). Utilize esse campo para informar o código do anexo utilizado no seu aplicativo quando incluir o anexo no Omie. Assim, poderá utilizar esse campo para resgatar o anexo desejado."},"cNomeArq":{"type":"string","description":"Nome do arquivo que foi adicionado. Preencha essa tag, apenas se você não tiver ou souber qual é o código de integração do anexo (tag cCodIntAnexo). Caso a tag cCodIntAnexo esteja preenchida, o conteúdo dessa tag será desconsiderado."},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro duranteo o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodigoStatus\"."}},"title":"lcrExcluirAnexo (retorno)"},"financas_contareceberanexos_lcrIncluirAnexo":{"type":"object","title":"lcrIncluirAnexo","description":"Inclui um anexo no Contas a Receber.","required":["call","param"],"properties":{"call":{"type":"string","enum":["lcrIncluirAnexo"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodTitulo":{"type":"integer","maxLength":15,"description":"Código do título do Contas a Receber.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno do título do contas a receber gerado pelo Omie."},"cCodIntTitulo":{"type":"string","maxLength":60,"description":"Código de integração do título do Contas a Receber.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código do título utilizado no seu aplicativo quando incluir um título no Omie.\nAssim, poderá utilizar esse campo para resgatar as informações do título desejado.\nCaso informe esse campo, não informe a tag nCodInt. Caso isso aconteça, o conteúdo dessa tag seja desconsiderada."},"cCodIntAnexo":{"type":"string","maxLength":20,"description":"Código de integração do anexo.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nUtilize esse campo para informar o código do anexo utilizado no seu aplicativo quando incluir o anexo no Omie.\nAssim, poderá utilizar esse campo para resgatar o anexo desejado."},"cNomeArq":{"type":"string","maxLength":100,"description":"Nome do arquivo que foi adicionado.\nPreencha essa tag, apenas se você não tiver ou souber qual é o código de integração do anexo (tag cCodIntAnexo).\nCaso a tag cCodIntAnexo esteja preenchida, o conteúdo dessa tag será desconsiderado."},"cArquivo":{"type":"string","description":"Conteúdo do arquivo a ser anexado, compactado (zip) e convertido   em base 64."},"cMd5":{"type":"string","maxLength":32,"description":"MD5 do arquivo enviado na tag \"cArquivo\"."}},"required":["cArquivo","cMd5","cNomeArq"]}}},"example":{"call":"lcrIncluirAnexo","param":[{"nCodTitulo":0,"cCodIntTitulo":"","cCodIntAnexo":"","cNomeArq":"","cArquivo":"","cMd5":""}]}},"financas_contareceberanexos_lcrIncluirAnexo_retorno":{"type":"object","properties":{"nCodTitulo":{"type":"integer","description":"Código do título do Contas a Receber. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do título do contas a receber gerado pelo Omie."},"cCodIntTitulo":{"type":"string","description":"Código de integração do título do Contas a Receber. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código do título utilizado no seu aplicativo quando incluir um título no Omie. Assim, poderá utilizar esse campo para resgatar as informações do título desejado. Caso informe esse campo, não informe a tag nCodInt. Caso isso aconteça, o conteúdo dessa tag seja desconsiderada."},"cCodIntAnexo":{"type":"string","description":"Código de integração do anexo. (Interno, utilizado apenas na integração via API, não é exibido na tela). Utilize esse campo para informar o código do anexo utilizado no seu aplicativo quando incluir o anexo no Omie. Assim, poderá utilizar esse campo para resgatar o anexo desejado."},"cNomeArq":{"type":"string","description":"Nome do arquivo que foi adicionado. Preencha essa tag, apenas se você não tiver ou souber qual é o código de integração do anexo (tag cCodIntAnexo). Caso a tag cCodIntAnexo esteja preenchida, o conteúdo dessa tag será desconsiderado."},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro duranteo o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodigoStatus\"."}},"title":"lcrIncluirAnexo (retorno)"},"financas_contareceberanexos_lcrListarAnexos":{"type":"object","title":"lcrListarAnexos","description":"Lista os anexos de um título do Contas a Receber.","required":["call","param"],"properties":{"call":{"type":"string","enum":["lcrListarAnexos"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página que se deseja resgatar.\nO padrão é \"1\"."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Número de registros retornados por página.\nO padrão é 20.\nO limite máximo é 50 por página."},"cOrdenarPor":{"type":"string","maxLength":100,"description":"Ordem os resultados da página por:\nCODIGO - Código do Título.\nCODINT - Código de Integração do Título.\nARQUIVO - Nome do arquivo."},"cOrdemDecrescente":{"type":"string","maxLength":1,"description":"Indica se a ordem de exibição é Decrescente caso seja informado \"S\"."},"dDtIncDe":{"type":"string","maxLength":10,"description":"Data de inclusão inicial.\nNo formato dd/mm/aaaa."},"dDtIncAte":{"type":"string","maxLength":10,"description":"Data de inclusão final.\nNo formato dd/mm/aaaa."},"dDtAltDe":{"type":"string","maxLength":10,"description":"Data de alteração inicial.\nNo formato dd/mm/aaaa."},"dDtAltAte":{"type":"string","maxLength":10,"description":"Data de alteração final.\nNo formato dd/mm/aaaa."},"nCodTitulo":{"type":"integer","maxLength":15,"description":"Código do título do Contas a Receber.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno do título do contas a receber gerado pelo Omie."},"cCodIntTitulo":{"type":"string","maxLength":60,"description":"Código de integração do título do Contas a Receber.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código do título utilizado no seu aplicativo quando incluir um título no Omie.\nAssim, poderá utilizar esse campo para resgatar as informações do título desejado.\nCaso informe esse campo, não informe a tag nCodInt. Caso isso aconteça, o conteúdo dessa tag seja desconsiderada.\n\nc"}},"required":["nPagina","nRegPorPagina"]}}},"example":{"call":"lcrListarAnexos","param":[{"nPagina":1,"nRegPorPagina":50,"nCodTitulo":0}]}},"financas_contareceberanexos_lcrListarAnexos_retorno":{"type":"object","properties":{"nPagina":{"type":"integer","description":"Número da página resgatada."},"nTotPaginas":{"type":"integer","description":"Número total de páginas encontradas."},"nRegistros":{"type":"integer","description":"Número de registros retornados na página."},"nTotRegistros":{"type":"integer","description":"Número total de registros encontrados."},"listaAnexos":{"type":"array","items":{"type":"object","properties":{"nCodTitulo":{"type":"integer","description":"Código do título do Contas a Receber. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do título do contas a receber gerado pelo Omie."},"cCodIntTitulo":{"type":"string","description":"Código de integração do título do Contas a Receber. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código do título utilizado no seu aplicativo quando incluir um título no Omie. Assim, poderá utilizar esse campo para resgatar as informações do título desejado. Caso informe esse campo, não informe a tag nCodInt. Caso isso aconteça, o conteúdo dessa tag seja desconsiderada."},"cCodIntAnexo":{"type":"string","description":"Código de integração do anexo. (Interno, utilizado apenas na integração via API, não é exibido na tela). Utilize esse campo para informar o código do anexo utilizado no seu aplicativo quando incluir o anexo no Omie. Assim, poderá utilizar esse campo para resgatar o anexo desejado."},"cNomeArq":{"type":"string","description":"Nome do arquivo que foi adicionado. Preencha essa tag, apenas se você não tiver ou souber qual é o código de integração do anexo (tag cCodIntAnexo). Caso a tag cCodIntAnexo esteja preenchida, o conteúdo dessa tag será desconsiderado."},"info":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão. No formato dd/mm/aaaa."},"hInc":{"type":"string","description":"Hora da Inclusão. No formato hh:mm:ss."},"uInc":{"type":"string","description":"Usuário da Inclusão."},"dAlt":{"type":"string","description":"Data da Alteração. No formato dd/mm/aaaa."},"hAlt":{"type":"string","description":"Hora da Alteração. No formato hh:mm:ss."},"uAlt":{"type":"string","description":"Usuário da Alteração."},"cImpAPI":{"type":"string","description":"Importado pela API (S/N)."}},"description":"Informações complementares do anexo."}}},"description":"Lista de anexos do título do contas a receber encontrados."}},"title":"lcrListarAnexos (retorno)"},"financas_contareceberanexos_lcrObterAnexo":{"type":"object","title":"lcrObterAnexo","description":"Obtém um anexo de um título do Contas a Receber.","required":["call","param"],"properties":{"call":{"type":"string","enum":["lcrObterAnexo"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodTitulo":{"type":"integer","maxLength":15,"description":"Código do título do Contas a Receber.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno do título do contas a receber gerado pelo Omie."},"cCodIntTitulo":{"type":"string","maxLength":60,"description":"Código de integração do título do Contas a Receber.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código do título utilizado no seu aplicativo quando incluir um título no Omie.\nAssim, poderá utilizar esse campo para resgatar as informações do título desejado.\nCaso informe esse campo, não informe a tag nCodInt. Caso isso aconteça, o conteúdo dessa tag seja desconsiderada."},"cCodIntAnexo":{"type":"string","maxLength":20,"description":"Código de integração do anexo.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nUtilize esse campo para informar o código do anexo utilizado no seu aplicativo quando incluir o anexo no Omie.\nAssim, poderá utilizar esse campo para resgatar o anexo desejado."},"cNomeArq":{"type":"string","maxLength":100,"description":"Nome do arquivo que foi adicionado.\nPreencha essa tag, apenas se você não tiver ou souber qual é o código de integração do anexo (tag cCodIntAnexo).\nCaso a tag cCodIntAnexo esteja preenchida, o conteúdo dessa tag será desconsiderado."}}}}},"example":{"call":"lcrObterAnexo","param":[{"nCodTitulo":0,"cCodIntTitulo":"","cCodIntAnexo":"","cNomeArq":""}]}},"financas_contareceberanexos_lcrObterAnexo_retorno":{"type":"object","properties":{"nCodTitulo":{"type":"integer","description":"Código do título do Contas a Receber. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do título do contas a receber gerado pelo Omie."},"cCodIntTitulo":{"type":"string","description":"Código de integração do título do Contas a Receber. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código do título utilizado no seu aplicativo quando incluir um título no Omie. Assim, poderá utilizar esse campo para resgatar as informações do título desejado. Caso informe esse campo, não informe a tag nCodInt. Caso isso aconteça, o conteúdo dessa tag seja desconsiderada."},"cCodIntAnexo":{"type":"string","description":"Código de integração do anexo. (Interno, utilizado apenas na integração via API, não é exibido na tela). Utilize esse campo para informar o código do anexo utilizado no seu aplicativo quando incluir o anexo no Omie. Assim, poderá utilizar esse campo para resgatar o anexo desejado."},"cNomeArq":{"type":"string","description":"Nome do arquivo que foi adicionado. Preencha essa tag, apenas se você não tiver ou souber qual é o código de integração do anexo (tag cCodIntAnexo). Caso a tag cCodIntAnexo esteja preenchida, o conteúdo dessa tag será desconsiderado."},"cLinkDownload":{"type":"string","description":"URL para download do anexo solicitado."},"dDtExpiracao":{"type":"string","description":"Data de expiração da url disponibilizada. No formato dd/mm/aaaa."},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro duranteo o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodigoStatus\"."}},"title":"lcrObterAnexo (retorno)"},"financas_contareceberboleto_CancelarBoleto":{"type":"object","title":"CancelarBoleto","description":"Cancela o Boleto.\nATENÇÃO: Os boletos gerados e já enviados ao banco estão sujeitos a tarifação (de emissão, cancelamento ou de alteração da data de vencimento do boleto).","required":["call","param"],"properties":{"call":{"type":"string","enum":["CancelarBoleto"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodTitulo":{"type":"integer","maxLength":15,"description":"Código do título\nCódigo Interno do título no Omie.\n\nUtilize a tag \"codigo_lancamento_omie\" do método \"ListarContasReceber\" da API\n/api/v1/financas/contareceber/\npara obter essa informação."},"cCodIntTitulo":{"type":"string","maxLength":60,"description":"Código de Integração do Título.\n\nUtilize a tag \"codigo_lancamento_integracao\" do método \"ListarContasReceber\" da API\n/api/v1/financas/contareceber/\npara obter essa informação."}}}}},"example":{"call":"CancelarBoleto","param":[{"nCodTitulo":0,"cCodIntTitulo":""}]}},"financas_contareceberboleto_CancelarBoleto_retorno":{"type":"object","properties":{"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro durante o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodStatus\"."}},"title":"CancelarBoleto (retorno)"},"financas_contareceberboleto_GerarBoleto":{"type":"object","title":"GerarBoleto","description":"Gera um Boleto referente a um Contas a Receber.","required":["call","param"],"properties":{"call":{"type":"string","enum":["GerarBoleto"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodTitulo":{"type":"integer","maxLength":15,"description":"Código do título\nCódigo Interno do título no Omie.\n\nUtilize a tag \"codigo_lancamento_omie\" do método \"ListarContasReceber\" da API\n/api/v1/financas/contareceber/\npara obter essa informação."},"cCodIntTitulo":{"type":"string","maxLength":60,"description":"Código de Integração do Título.\n\nUtilize a tag \"codigo_lancamento_integracao\" do método \"ListarContasReceber\" da API\n/api/v1/financas/contareceber/\npara obter essa informação."}}}}},"example":{"call":"GerarBoleto","param":[{"nCodTitulo":0,"cCodIntTitulo":""}]}},"financas_contareceberboleto_GerarBoleto_retorno":{"type":"object","properties":{"cLinkBoleto":{"type":"string","description":"Link do Boleto."},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro durante o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodStatus\"."},"dDtEmBol":{"type":"string","description":"Data de emissão do boleto."},"cNumBoleto":{"type":"string","description":"Número do boleto."},"cCodBarras":{"type":"string","description":"Código de barras do Boleto."},"nPerJuros":{"type":"decimal","description":"Percentual de juros."},"nPerMulta":{"type":"decimal","description":"Percentual de multa."},"cNumBancario":{"type":"string","description":"Número bancário do boleto."},"dDescontoCond1":{"type":"string","description":"Data de desconto condicional."},"vDescontoCond1":{"type":"decimal","description":"Valor do desconto condicional."},"dDescontoCond2":{"type":"string","description":"Data do desconto condicional."},"vDescontoCond2":{"type":"decimal","description":"Valor do desconto condicional."},"dDescontoCond3":{"type":"string","description":"Data do desconto condicional."},"vDescontoCond3":{"type":"decimal","description":"Valor do desconto condicional."}},"title":"GerarBoleto (retorno)"},"financas_contareceberboleto_ObterBoleto":{"type":"object","title":"ObterBoleto","description":"Disponibiliza o link de Download do Boleto.\nATENÇÃO: Os boletos gerados e já enviados ao banco estão sujeitos a tarifação (de emissão, cancelamento ou de alteração da data de vencimento do boleto).","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterBoleto"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodTitulo":{"type":"integer","maxLength":15,"description":"Código do título\nCódigo Interno do título no Omie.\n\nUtilize a tag \"codigo_lancamento_omie\" do método \"ListarContasReceber\" da API\n/api/v1/financas/contareceber/\npara obter essa informação."},"cCodIntTitulo":{"type":"string","maxLength":60,"description":"Código de Integração do Título.\n\nUtilize a tag \"codigo_lancamento_integracao\" do método \"ListarContasReceber\" da API\n/api/v1/financas/contareceber/\npara obter essa informação."}}}}},"example":{"call":"ObterBoleto","param":[{"nCodTitulo":0,"cCodIntTitulo":""}]}},"financas_contareceberboleto_ObterBoleto_retorno":{"type":"object","properties":{"cLinkBoleto":{"type":"string","description":"Link do Boleto."},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro durante o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodStatus\"."},"dDtEmBol":{"type":"string","description":"Data de emissão do boleto."},"cNumBoleto":{"type":"string","description":"Número do boleto."},"cCodBarras":{"type":"string","description":"Código de barras do Boleto."},"nPerJuros":{"type":"decimal","description":"Percentual de juros."},"nPerMulta":{"type":"decimal","description":"Percentual de multa."},"cNumBancario":{"type":"string","description":"Número bancário do boleto."},"dDescontoCond1":{"type":"string","description":"Data de desconto condicional."},"vDescontoCond1":{"type":"decimal","description":"Valor do desconto condicional."},"dDescontoCond2":{"type":"string","description":"Data do desconto condicional."},"vDescontoCond2":{"type":"decimal","description":"Valor do desconto condicional."},"dDescontoCond3":{"type":"string","description":"Data do desconto condicional."},"vDescontoCond3":{"type":"decimal","description":"Valor do desconto condicional."}},"title":"ObterBoleto (retorno)"},"financas_contareceberboleto_ProrrogarBoleto":{"type":"object","title":"ProrrogarBoleto","description":"Prorroga o vencimento do Boleto.\nATENÇÃO: Os boletos gerados e já enviados ao banco estão sujeitos a tarifação (de emissão, cancelamento ou de alteração da data de vencimento do boleto).","required":["call","param"],"properties":{"call":{"type":"string","enum":["ProrrogarBoleto"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodTitulo":{"type":"integer","maxLength":15,"description":"Código do título\nCódigo Interno do título no Omie.\n\nUtilize a tag \"codigo_lancamento_omie\" do método \"ListarContasReceber\" da API\n/api/v1/financas/contareceber/\npara obter essa informação."},"cCodIntTitulo":{"type":"string","maxLength":60,"description":"Código de Integração do Título.\n\nUtilize a tag \"codigo_lancamento_integracao\" do método \"ListarContasReceber\" da API\n/api/v1/financas/contareceber/\npara obter essa informação."},"dDtVenc":{"type":"string","maxLength":10,"description":"Data de vencimento."}},"required":["dDtVenc"]}}},"example":{"call":"ProrrogarBoleto","param":[{"nCodTitulo":0,"cCodIntTitulo":"","dDtVenc":"30/09/2026"}]}},"financas_contareceberboleto_ProrrogarBoleto_retorno":{"type":"object","properties":{"cLinkBoleto":{"type":"string","description":"Link do Boleto."},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro durante o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodStatus\"."},"dDtEmBol":{"type":"string","description":"Data de emissão do boleto."},"cNumBoleto":{"type":"string","description":"Número do boleto."},"cCodBarras":{"type":"string","description":"Código de barras do Boleto."},"nPerJuros":{"type":"decimal","description":"Percentual de juros."},"nPerMulta":{"type":"decimal","description":"Percentual de multa."},"cNumBancario":{"type":"string","description":"Número bancário do boleto."},"dDescontoCond1":{"type":"string","description":"Data de desconto condicional."},"vDescontoCond1":{"type":"decimal","description":"Valor do desconto condicional."},"dDescontoCond2":{"type":"string","description":"Data do desconto condicional."},"vDescontoCond2":{"type":"decimal","description":"Valor do desconto condicional."},"dDescontoCond3":{"type":"string","description":"Data do desconto condicional."},"vDescontoCond3":{"type":"decimal","description":"Valor do desconto condicional."}},"title":"ProrrogarBoleto (retorno)"},"financas_extrato_ListarExtrato":{"type":"object","title":"ListarExtrato","description":"Listagem do Extrato","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarExtrato"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodCC":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente.\nInforme nCodCC ou cCodIntCC (um dos dois é obrigatório)."},"cCodIntCC":{"type":"string","maxLength":20,"description":"Código de Integração da Conta Corrente.\nInforme nCodCC ou cCodIntCC (um dos dois é obrigatório)."},"dPeriodoInicial":{"type":"string","maxLength":10,"description":"Período Inicial.\n\nPreecher no formato DD/MM/AAAA."},"dPeriodoFinal":{"type":"string","maxLength":10,"description":"Período final.\n\nPreecher no formato DD/MM/AAAA."},"cExibirApenasSaldo":{"type":"string","maxLength":1,"description":"Exibe apenas os saldos da Conta Corrente."}},"required":["cCodIntCC","nCodCC"]}}},"example":{"call":"ListarExtrato","param":[{"nCodCC":0,"cCodIntCC":"","dPeriodoInicial":"","dPeriodoFinal":""}]}},"financas_extrato_ListarExtrato_retorno":{"type":"object","properties":{"nCodCC":{"type":"integer","description":"Código da Conta Corrente."},"cCodIntCC":{"type":"string","description":"Código de Integração da Conta Corrente."},"nCodAgencia":{"type":"string","description":"Código da Agência."},"nCodBanco":{"type":"string","description":"Código do Banco."},"nNumConta":{"type":"string","description":"Número da Conta Corrente."},"cDescricao":{"type":"string","description":"Descrição da Conta Corrente."},"cCodTipo":{"type":"string","description":"Código do Tipo da Conta Corrente."},"cDesTipo":{"type":"string","description":"Descrição do Tipo da Conta Corrente."},"cFluxoCaixa":{"type":"string","description":"Conta Corrente é visível no Fluxo de Caixa (S/N)."},"cResumoExecutivo":{"type":"string","description":"Conta Corrente é visível no Resumo Executivo (S/N)."},"dPeriodoInicial":{"type":"string","description":"Período Inicial. Preecher no formato DD/MM/AAAA."},"dPeriodoFinal":{"type":"string","description":"Período final. Preecher no formato DD/MM/AAAA."},"nSaldoAnterior":{"type":"decimal","description":"Saldo Anterior Realizado."},"nSaldoAnteriorPrevisto":{"type":"decimal","description":"Saldo Anterior Previsto."},"nSaldoAtual":{"type":"decimal","description":"Saldo Atual Realizado disponível para hoje."},"nSaldoAtualPrevisto":{"type":"decimal","description":"Saldo Atual Previsto."},"nSaldoConciliado":{"type":"decimal","description":"Saldo Conciliado até o momento."},"nSaldoProvisorio":{"type":"decimal","description":"Saldo provisório para hoje."},"nLimiteCreditoTotal":{"type":"decimal","description":"Limite de Crédito Total."},"nSaldoDisponivel":{"type":"decimal","description":"Saldo Disponível para hoje."},"listaMovimentos":{"type":"array","items":{"type":"object","properties":{"nCodLancamento":{"type":"integer","description":"Código do Lançamento."},"nCodLancRelac":{"type":"integer","description":"Código do Lançamento original relacionado (quando houver parcelamento)"},"cSituacao":{"type":"string","description":"Situação do lançamento."},"dDataLancamento":{"type":"string","description":"Data do lançamento."},"cDesCliente":{"type":"string","description":"Cliente ou Fornecedor (Nome Fantasia)."},"cTipoDocumento":{"type":"string","description":"Tipo de Documento."},"cNumero":{"type":"string","description":"Número do Documento."},"nValorDocumento":{"type":"decimal","description":"Valor do documento."},"nSaldo":{"type":"decimal","description":"Saldo realizado em R$."},"nSaldoPrev":{"type":"decimal","description":"Saldo Previsto R$."},"cCodCategoria":{"type":"string","description":"Código da Categoria."},"cDesCategoria":{"type":"string","description":"Descrição da Categoria."},"cDocumentoFiscal":{"type":"string","description":"Número do Documento Fiscal (Nota Fiscal, Cupom Fiscal, CT-e, etc)"},"cParcela":{"type":"string","description":"Número da parcela."},"cNossoNumero":{"type":"string","description":"Nosso Número."},"cOrigem":{"type":"string","description":"Origem do lançamento."},"cVendedor":{"type":"string","description":"Nome do Vendedor."},"cProjeto":{"type":"string","description":"Descrição do Projeto."},"nCodCliente":{"type":"integer","description":"Cliente ou Fornecedor (Código)"},"cRazCliente":{"type":"string","description":"Cliente ou Fornecedor (Razão Social)"},"cDocCliente":{"type":"string","description":"Cliente ou Fornecedor (CNPJ/CPF)"},"cObservacoes":{"type":"string","description":"Observações."},"cDataInclusao":{"type":"string","description":"Data de Inclusão."},"cHoraInclusao":{"type":"string","description":"Hora de Inclusão."},"cNatureza":{"type":"string","description":"Natureza da operação."},"cBloqueado":{"type":"string","description":"Lançamento bloqueado (S/N)."},"dDataConciliacao":{"type":"string","description":"Data da conciliação."}}},"description":"Lista de movimentos do período."}},"title":"ListarExtrato (retorno)"},"financas_mf_ListarMovimentos":{"type":"object","title":"ListarMovimentos","description":"","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarMovimentos"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página a ser recuperada."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Número de registros por página.\n(máximo 50)."},"cOrdenarPor":{"type":"string","maxLength":100,"description":"Ordem de exibição do dados.\nPode ser:\nCODIGO\nCODIGO_INTEGRACAO"},"cOrdemDecrescente":{"type":"string","maxLength":1,"description":"DEPRECATED"},"lDadosCad":{"type":"boolean","description":"Exibir dados cadastrais como Data de Inclusão, Alteração do Título e Observações (S/N)?"},"nCodTitulo":{"type":"integer","maxLength":15,"description":"Código do titulo.\n(Gerado internamente, não é visualizado na tela)"},"cCodIntTitulo":{"type":"string","maxLength":60,"description":"Código de integração do título.\n(Utilizado em títulos criados via API, não é visualizado na tela)"},"cNumTitulo":{"type":"string","maxLength":20,"description":"Número do título.\n(Informado pelo usuário / visualizado na tela)"},"dDtEmisDe":{"type":"string","maxLength":10,"description":"Filtrar os títulos pela data de emissão - a partir de."},"dDtEmisAte":{"type":"string","maxLength":10,"description":"Filtrar os títulos pela data de emissão - até."},"dDtVencDe":{"type":"string","maxLength":10,"description":"Filtrar os títulos pela data de vencimento - a partir de."},"dDtVencAte":{"type":"string","maxLength":10,"description":"Filtrar os títulos pela data de vencimento - até."},"dDtPagtoDe":{"type":"string","maxLength":10,"description":"Filtrar os títulos pela data de pagamento - a partir de."},"dDtPagtoAte":{"type":"string","maxLength":10,"description":"Filtrar os títulos pela data de pagamento - até."},"dDtPrevDe":{"type":"string","maxLength":10,"description":"Data de previsão"},"dDtPrevAte":{"type":"string","maxLength":10,"description":"Data de previsão"},"dDtRegDe":{"type":"string","maxLength":10,"description":"Data de registro"},"dDtRegAte":{"type":"string","maxLength":10,"description":"Data de registro"},"nCodCliente":{"type":"integer","maxLength":15,"description":"Filtrar os títulos pelo código do cliente.\n(Gerado internamente, não é visualizado na tela)"},"cCPFCNPJCliente":{"type":"string","maxLength":20,"description":"Filtrar os títulos por CPF/CNPJ do cliente."},"nCodCtr":{"type":"integer","maxLength":15,"description":"Filtrar os títulos pelo código do contrato.\n(Gerado internamente, não é visualizado na tela)"},"cNumCtr":{"type":"string","maxLength":60,"description":"Filtrar os títulos pelo número do contrato informado pelo usuário."},"nCodOS":{"type":"integer","maxLength":15,"description":"Filtrar os títulos pelo código da Ordem de Serviço.\n(Gerado internamente, não é visualizado na tela)"},"cNumOS":{"type":"string","maxLength":15,"description":"Filtrar os títulos pelo código da Ordem de Serviço.\n(Código visualizado na tela)"},"nCodCC":{"type":"integer","maxLength":15,"description":"Filtrar os títulos pelo código da conta corrente.\n(Gerado internamente, não é visualizado na tela)"},"cStatus":{"type":"string","maxLength":100,"description":"Filtrar os títulos pelo status.\nPode ser:\nCANCELADO\nRECEBIDO\nLIQUIDADO\nEMABERTO\nPAGTO_PARCIAL\nVENCEHOJE\nAVENCER\nATRASADO"},"cNatureza":{"type":"string","maxLength":1,"description":"Filtrar os títulos pela natureza.\nPode ser:\nP - Contas a Pagar.\nR - Contas a Receber."},"cTipo":{"type":"string","maxLength":5,"description":"Tipo de Documento.\nPode ser:\nADI - Adiantamento\nBOL - Boleto\nCRT - Cartão\nCHQ - Cheque\nCON - Convênios\nCRE - Crediário\nDRF - DARF\nDAS - DAS\nDEB - Débito em conta\nDIN - Dinheiro\nDOC - DOC\nGUIA - Guia de Recolhimento\nPROT - Protesto\nREC - Recibo\nRPA - RPA\nTED - TED\nTRA - Transferência\n99999 - Outros\n\nUtilize a tag \"codigo\" do método \"PesquisarTipoDocumento\" da API:\nhttps://app.omie.com.br/api/v1/geral/tiposdoc/\npara obter essa informação."},"cOperacao":{"type":"string","maxLength":2,"description":"Operação do título.\nPode ser:\n01 - Venda de Serviço\n11 - Venda de Produto\n12 - Venda de Produto pelo PDV\n13 - Devolução de Venda\n14 - Remessa de Produto\n16 - Transferência\n21 - Compra de Produto\n23 - Devolução ao Fornecedor\n24 - Retorno de Remessa\n26 - Nota Complementar de Entrada\n22 - Compra de Produto (Importação)\n28 - Ordem de Produção"},"cNumDocFiscal":{"type":"string","maxLength":20,"description":"Número do documento fiscal (NF-e, NFC-e, NFS-e, etc)\n(Informado pelo usuário / visualizado na tela)"},"cCodigoBarras":{"type":"string","maxLength":70,"description":"Código de Barras do título."},"nCodProjeto":{"type":"integer","maxLength":15,"description":"Código do projeto.\n(Gerado internamente, não é visualizado na tela)"},"nCodVendedor":{"type":"integer","maxLength":15,"description":"Código do vendedor.\n(Gerado internamente, não é visualizado na tela)"},"nCodComprador":{"type":"integer","maxLength":15,"description":"Código do comprador.\n(Gerado internamente, não é visualizado na tela)"},"cCodCateg":{"type":"string","maxLength":20,"description":"Código da Categoria."},"dDtIncDe":{"type":"string","maxLength":10,"description":"Data de inclusão"},"dDtIncAte":{"type":"string","maxLength":10,"description":"Data de inclusão"},"dDtAltDe":{"type":"string","maxLength":10,"description":"Data de alteração"},"dDtAltAte":{"type":"string","maxLength":10,"description":"Data de alteração"},"cTpLancamento":{"type":"string","maxLength":10,"description":"Tipo de registro que será exibido.\nPode ser:\nCP - Lançamentos de Contas a Pagar.\nCR - Lançamentos de Contas a Receber.\nCPCR - Lançamentos de Contas a Pagar e Receber.\nBX - Baixas de lançamentos de Contas a Pagar e Receber.\nBXCP - Baixas de lançamentos de Contas a Pagar.\nBXCR - Baixas de lançamentos de Contas a Receber.\nCC - Lançamentos (todos) no Conta Corrente.\nCCE - Lançamentos de entrada no Conta Corrente.\nCCS - Lançamentos de saída no Conta Corrente.\nCCT - Lançamentos de transferência no Conta Corrente.\nPV - Previsão de Contratos de Serviço.\nPOS - Previsão de Ordens de Serviço.\nPPV - Previsão de Pedidos de Venda."},"cExibirDepartamentos":{"type":"string","maxLength":1,"description":"Exibir distribuição por departamentos (S/N)."},"nCodMovCC":{"type":"integer","maxLength":15,"description":"Código do movimento de Conta Corrente."}}}}},"example":{"call":"ListarMovimentos","param":[{"nPagina":1,"nRegPorPagina":500}]}},"financas_mf_ListarMovimentos_retorno":{"type":"object","properties":{"nPagina":{"type":"integer"},"nTotPaginas":{"type":"integer"},"nRegistros":{"type":"integer"},"nTotRegistros":{"type":"integer"},"movimentos":{"type":"array","items":{"type":"object","properties":{"detalhes":{"type":"object","properties":{"nCodTitulo":{"type":"integer","description":"Código do titulo. (Gerado internamente, não é visualizado na tela)"},"cCodIntTitulo":{"type":"string","description":"Código de integração do título. (Utilizado em títulos criados via API, não é visualizado na tela)"},"cNumTitulo":{"type":"string","description":"Número do título. (Informado pelo usuário / visualizado na tela)"},"dDtEmissao":{"type":"string","description":"Data de emissão do título."},"dDtVenc":{"type":"string","description":"Data de vencimento do título."},"dDtPrevisao":{"type":"string","description":"Data de previsão de Pagamento/Recebimento."},"dDtPagamento":{"type":"string","description":"Data de pagamento do título."},"nCodCliente":{"type":"integer","description":"Código de Cliente / Fornecedor. (Gerado internamente, não é visualizado na tela)"},"cCPFCNPJCliente":{"type":"string","description":"Filtrar os títulos por CPF/CNPJ do cliente."},"nCodCtr":{"type":"integer","description":"Código do contrato associado ao título. (Gerado internamente, não é visualizado na tela)"},"cNumCtr":{"type":"string","description":"Número do contrato associado ao título. (Informado pelo usuário / visualizado na tela)"},"nCodOS":{"type":"integer","description":"Código do Pedido de Venda / Ordem de Serviço. (Gerado internamente, não é visualizado na tela)"},"cNumOS":{"type":"string","description":"Número do pedido de venda / Ordem de Serviço. (visualizado na tela)"},"nCodCC":{"type":"integer","description":"Código da conta corrente. (Gerado internamente, não é visualizado na tela)"},"cStatus":{"type":"string","description":"Status do título. Pode ser: CANCELADO RECEBIDO LIQUIDADO EMABERTO PAGTO_PARCIAL VENCEHOJE AVENCER ATRASADO"},"cNatureza":{"type":"string","description":"Natureza do título. Pode ser: P - Contas a Pagar R - Contas a Receber"},"cTipo":{"type":"string","description":"Tipo de documento. Pode ser: ADI - Adiantamento BOL - Boleto CRT - Cartão CHQ - Cheque CON - Convênios CRE - Crediário DRF - DARF DAS - DAS DEB - Débito em conta DIN - Dinheiro DOC - DOC GUIA - Guia de Recolhimento PROT - Protesto REC - Recibo RPA - RPA TED - TED TRA - Transferência 99999 - Outros Utilize a tag \"codigo\" do método \"PesquisarTipoDocumento\" da API: https://app.omie.com.br/api/v1/geral/tiposdoc/ para obter essa informação."},"cOperacao":{"type":"string","description":"Operação do título. Pode ser: 01 - Venda de Serviço 11 - Venda de Produto 12 - Venda de Produto pelo PDV 13 - Devolução de Venda 14 - Remessa de Produto 16 - Transferência 21 - Compra de Produto 23 - Devolução ao Fornecedor 24 - Retorno de Remessa 26 - Nota Complementar de Entrada 22 - Compra de Produto (Importação) 28 - Ordem de Produção"},"cNumDocFiscal":{"type":"string","description":"Número do documento fiscal (NF-e, NFC-e, NFS-e, etc) (Informado pelo usuário / visualizado na tela)"},"cCodCateg":{"type":"string","description":"Código da categoria."},"cNumParcela":{"type":"string","description":"Número da parcela \"Formatada\" como 999/999"},"nValorTitulo":{"type":"decimal","description":"Valor do título."},"nValorPIS":{"type":"decimal","description":"Valor do PIS."},"cRetPIS":{"type":"string","description":"Indica que o Valor do PIS informado deve ser retido."},"nValorCOFINS":{"type":"decimal","description":"Valor do COFINS."},"cRetCOFINS":{"type":"string","description":"Indica que o Valor do COFINS informado deve ser retido."},"nValorCSLL":{"type":"decimal","description":"Valor do CSLL."},"cRetCSLL":{"type":"string","description":"Indica que o Valor do CSLL informado deve ser retido."},"nValorIR":{"type":"decimal","description":"Valor do Imposto de Renda."},"cRetIR":{"type":"string","description":"Indica que o Valor do Imposto de Renda informado deve ser retido."},"nValorISS":{"type":"decimal","description":"Valor do ISS."},"cRetISS":{"type":"string","description":"Indica que o Valor do ISS informado deve ser retido."},"nValorINSS":{"type":"decimal","description":"Valor do INSS."},"cRetINSS":{"type":"string","description":"Indica que o Valor do INSS informado deve ser retido."},"cCodProjeto":{"type":"integer","description":"Código do projeto. (Gerado internamente, não é visualizado na tela)"},"observacao":{"type":"string","description":"Observações do título."},"cCodVendedor":{"type":"integer","description":"Código do vendedor. (Gerado internamente, não é visualizado na tela)"},"nCodComprador":{"type":"integer","description":"Código do comprador. (Gerado internamente, não é visualizado na tela)"},"cCodigoBarras":{"type":"string","description":"Código de Barras do título."},"cNSU":{"type":"string","description":"Número Sequencial Único - Comprovante de pagamento."},"nCodNF":{"type":"integer","description":"Código da Nota Fiscal."},"dDtRegistro":{"type":"string","description":"Data de registro da NF."},"cNumBoleto":{"type":"string","description":"Número do Boleto."},"cChaveNFe":{"type":"string","description":"Chave da NF-e de origem."},"cOrigem":{"type":"string","description":"Origem do lançamento. Pode ser: APBP Integração de Pagamento de Conta APBR Integração de Recebimento de Conta APEP Integração de Lançamento de Despesa APER Integração de Lançamento de Receita APIP Integração de Conta a Pagar APIR Integração de Conta a Receber BARP Conta a Pagar Importada por Código de Barras BARR Conta a Receber Importada por Código de Barras BAXP Pagamento de Conta a Pagar BAXR Recebimento de Conta a Receber COMP Parcela a Pagar de Compras DEVP Conta a Pagar da Devolução de Venda DEVR Conta a Receber da Devolução ao Fornecedor EXTP Lançamento Manual de Despesa EXTR Lançamento Manual de Receita IMPP Parcela a Pagar de uma Nota de Importação MANP Lançamento Manual de Conta a Pagar MANR Lançamento Manual de Conta a Receber NFEP Conta a Pagar Importada de uma NF-e NFER Conta a Receber Importada de uma NF-e OFXP Pagamento Importado de um arquivo OFX OFXR Recebimento Importado de um arquivo OFX RPTP Repetição de Contas a Pagar RPTR Repetição de Contas a Receber TRAP Débito de Transf. entre Contas Correntes TRAR Crédito de Transf. entre Contas Correntes VENR Parcela a Receber de Vendas XMLP Conta a Pagar Importada de um arquivo XML XMLR Conta a Receber Importada de um arquivo XML"},"nCodTitRepet":{"type":"integer","description":"Código do título original que gerou a repetição dos lançamentos."},"cGrupo":{"type":"string","description":"Grupo do lançamento."},"nCodMovCC":{"type":"integer","description":"Código do movimento de Conta Corrente."},"nValorMovCC":{"type":"decimal","description":"Valor do movimento de Conta Corrente."},"nCodMovCCRepet":{"type":"integer","description":"Código do movimento de repetição,"},"nDesconto":{"type":"decimal","description":"Valor do Desconto."},"nJuros":{"type":"decimal","description":"Valor do Juros."},"nMulta":{"type":"decimal","description":"Valor da Multa."},"nCodBaixa":{"type":"integer","description":"Código da baixa."},"dDtCredito":{"type":"string","description":"Data de credito."},"dDtConcilia":{"type":"string","description":"Data da conciliação."},"cHrConcilia":{"type":"string","description":"Hora de conciliação."},"cUsConcilia":{"type":"string"},"dDtInc":{"type":"string","description":"Data de Inclusão."},"cHrInc":{"type":"string","description":"Hora de Inclusão."},"cUsInc":{"type":"string","description":"Usuário da Inclusão."},"dDtAlt":{"type":"string","description":"Data de Alteração."},"cHrAlt":{"type":"string","description":"Hora de Alteração."},"cUsAlt":{"type":"string","description":"Usuário de alteração."}},"description":"Detalhes do movimento financeiro."},"resumo":{"type":"object","properties":{"cLiquidado":{"type":"string","description":"Indica se o título está liquidado. Pode ser: S - Sim, indicado que o título está quitado. N - Não, indicando que o título ainda está em aberto."},"nValPago":{"type":"decimal","description":"Valor total pago para o título."},"nValAberto":{"type":"decimal","description":"Valor total em aberto para o título."},"nDesconto":{"type":"decimal","description":"Valor do Desconto."},"nJuros":{"type":"decimal","description":"Valor do Juros."},"nMulta":{"type":"decimal","description":"Valor da Multa."},"nValLiquido":{"type":"decimal","description":"Valor líquido (nValPago - nDesconto + Juros + nMulta)"}},"description":"Situação do movimento financeiro."},"departamentos":{"type":"array","items":{"type":"object","properties":{"cCodDepartamento":{"type":"string","description":"Código do Departamento."},"nDistrPercentual":{"type":"decimal","description":"Percentual da distribuição."},"nDistrValor":{"type":"decimal","description":"Valor da distribuição."},"nValorFixo":{"type":"string","description":"Indica que o valor foi fixado na distribuição (S/N)."}}},"description":"Distribuição por departamentos."},"categorias":{"type":"array","items":{"type":"object","properties":{"cCodCateg":{"type":"string","description":"Código da Categoria."},"nDistrPercentual":{"type":"decimal","description":"Percentual da distribuição."},"nDistrValor":{"type":"decimal","description":"Valor da distribuição."},"nValorFixo":{"type":"string","description":"Indica que o valor foi fixado na distribuição (S/N)."}}},"description":"Distribuição por Categorias."}}}}},"title":"ListarMovimentos (retorno)"},"financas_pesquisartitulos_PesquisarLancamentos":{"type":"object","title":"PesquisarLancamentos","description":"Pesquisa os lancamentos de títulos de Contas a Pagar e Receber","required":["call","param"],"properties":{"call":{"type":"string","enum":["PesquisarLancamentos"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página a ser recuperada."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Número de registros por página.\n(máximo 50)."},"cOrdenarPor":{"type":"string","maxLength":100,"description":"Ordem de exibição do dados.\nPode ser:\nCODIGO\nCODIGO_INTEGRACAO"},"cOrdemDecrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."},"nCodTitulo":{"type":"integer","maxLength":15,"description":"Código do titulo.\n(Gerado internamente, não é visualizado na tela)"},"cCodIntTitulo":{"type":"string","maxLength":60,"description":"Código de integração do título.\n(Utilizado em títulos criados via API, não é visualizado na tela)"},"cNumTitulo":{"type":"string","maxLength":20,"description":"Número do título.\n(Informado pelo usuário / visualizado na tela)"},"dDtEmisDe":{"type":"string","maxLength":10,"description":"Filtrar os títulos pela data de emissão - a partir de."},"dDtEmisAte":{"type":"string","maxLength":10,"description":"Filtrar os títulos pela data de emissão - até."},"dDtVencDe":{"type":"string","maxLength":10,"description":"Filtrar os títulos pela data de vencimento - a partir de."},"dDtVencAte":{"type":"string","maxLength":10,"description":"Filtrar os títulos pela data de vencimento - até."},"dDtPagtoDe":{"type":"string","maxLength":10,"description":"Filtrar os títulos pela data de pagamento - a partir de."},"dDtPagtoAte":{"type":"string","maxLength":10,"description":"Filtrar os títulos pela data de pagamento - até."},"dDtPrevDe":{"type":"string","maxLength":10,"description":"Data de previsão"},"dDtPrevAte":{"type":"string","maxLength":10,"description":"Data de previsão"},"dDtRegDe":{"type":"string","maxLength":10,"description":"Data de registro"},"dDtRegAte":{"type":"string","maxLength":10,"description":"Data de registro"},"nCodCliente":{"type":"integer","maxLength":15,"description":"Filtrar os títulos pelo código do cliente.\n(Gerado internamente, não é visualizado na tela)"},"cCPFCNPJCliente":{"type":"string","maxLength":20,"description":"Filtrar os títulos por CPF/CNPJ do cliente."},"nCodCtr":{"type":"integer","maxLength":15,"description":"Filtrar os títulos pelo código do contrato.\n(Gerado internamente, não é visualizado na tela)"},"cNumCtr":{"type":"string","maxLength":60,"description":"Filtrar os títulos pelo número do contrato informado pelo usuário."},"nCodOS":{"type":"integer","maxLength":15,"description":"Filtrar os títulos pelo código da Ordem de Serviço.\n(Gerado internamente, não é visualizado na tela)"},"cNumOS":{"type":"string","maxLength":15,"description":"Filtrar os títulos pelo código da Ordem de Serviço.\n(Código visualizado na tela)"},"nCodCC":{"type":"integer","maxLength":15,"description":"Filtrar os títulos pelo código da conta corrente.\n(Gerado internamente, não é visualizado na tela)"},"cStatus":{"type":"string","maxLength":100,"description":"Filtrar os títulos pelo status.\nPode ser:\nCANCELADO\nRECEBIDO\nLIQUIDADO\nEMABERTO\nPAGTO_PARCIAL\nVENCEHOJE\nAVENCER\nATRASADO"},"cNatureza":{"type":"string","maxLength":1,"description":"Filtrar os títulos pela natureza.\nPode ser:\nP - Contas a Pagar.\nR - Contas a Receber."},"cTipo":{"type":"string","maxLength":5,"description":"Tipo de Documento.\nPode ser:\nADI - Adiantamento\nBOL - Boleto\nCRT - Cartão\nCHQ - Cheque\nCON - Convênios\nCRE - Crediário\nDRF - DARF\nDAS - DAS\nDEB - Débito em conta\nDIN - Dinheiro\nDOC - DOC\nGUIA - Guia de Recolhimento\nPROT - Protesto\nREC - Recibo\nRPA - RPA\nTED - TED\nTRA - Transferência\n99999 - Outros"},"cOperacao":{"type":"string","maxLength":2,"description":"Operação do título.\nPode ser:\n01 - Venda de Serviço\n11 - Venda de Produto\n12 - Venda de Produto pelo PDV\n13 - Devolução de Venda\n14 - Remessa de Produto\n16 - Transferência"},"cNumDocFiscal":{"type":"string","maxLength":20,"description":"Número do documento fiscal (NF-e, NFC-e, NFS-e, etc)\n(Informado pelo usuário / visualizado na tela)"},"cCodigoBarras":{"type":"string","maxLength":70,"description":"Código de Barras do título."},"nCodProjeto":{"type":"integer","maxLength":15,"description":"Código do projeto.\n(Gerado internamente, não é visualizado na tela)"},"nCodVendedor":{"type":"integer","maxLength":15,"description":"Código do vendedor.\n(Gerado internamente, não é visualizado na tela)"},"nCodComprador":{"type":"integer","maxLength":15,"description":"Código do comprador.\n(Gerado internamente, não é visualizado na tela)"},"cCodCateg":{"type":"string","maxLength":20,"description":"Código da Categoria."},"dDtIncDe":{"type":"string","maxLength":10,"description":"Data de inclusão"},"dDtIncAte":{"type":"string","maxLength":10,"description":"Data de inclusão"},"dDtAltDe":{"type":"string","maxLength":10,"description":"Data de alteração"},"dDtAltAte":{"type":"string","maxLength":10,"description":"Data de alteração"},"dDtCancDe":{"type":"string","maxLength":10},"dDtCancAte":{"type":"string","maxLength":10},"cChaveNFe":{"type":"string","maxLength":44,"description":"Chave da NF-e, CT-e, NFC-e de origem."},"lDadosCad":{"type":"boolean","description":"Exibir dados cadastrais como Data de Inclusão, Alteração do Título.\n\nPode ser:\n\ntrue\nfalse\n\nDefault false."}}}}},"example":{"call":"PesquisarLancamentos","param":[{"nPagina":1,"nRegPorPagina":20}]}},"financas_pesquisartitulos_PesquisarLancamentos_retorno":{"type":"object","properties":{"nPagina":{"type":"integer"},"nTotPaginas":{"type":"integer"},"nRegistros":{"type":"integer"},"nTotRegistros":{"type":"integer"},"titulosEncontrados":{"type":"array","items":{"type":"object","properties":{"cabecTitulo":{"type":"object","properties":{"nCodTitulo":{"type":"integer","description":"Código do titulo. (Gerado internamente, não é visualizado na tela)"},"cCodIntTitulo":{"type":"string","description":"Código de integração do título. (Utilizado em títulos criados via API, não é visualizado na tela)"},"cNumTitulo":{"type":"string","description":"Número do título. (Informado pelo usuário / visualizado na tela)"},"dDtEmissao":{"type":"string","description":"Data de emissão do título."},"dDtVenc":{"type":"string","description":"Data de vencimento do título."},"dDtPrevisao":{"type":"string","description":"Data de previsão de Pagamento/Recebimento."},"dDtPagamento":{"type":"string","description":"Data de pagamento do título."},"nCodCliente":{"type":"integer","description":"Código de Cliente / Fornecedor. (Gerado internamente, não é visualizado na tela)"},"cCPFCNPJCliente":{"type":"string","description":"Filtrar os títulos por CPF/CNPJ do cliente."},"nCodCtr":{"type":"integer","description":"Código do contrato associado ao título. (Gerado internamente, não é visualizado na tela)"},"cNumCtr":{"type":"string","description":"Número do contrato associado ao título. (Informado pelo usuário / visualizado na tela)"},"nCodOS":{"type":"integer","description":"Código do Pedido de Venda / Ordem de Serviço. (Gerado internamente, não é visualizado na tela)"},"cNumOS":{"type":"string","description":"Número do pedido de venda / Ordem de Serviço. (visualizado na tela)"},"nCodCC":{"type":"integer","description":"Código da conta corrente. (Gerado internamente, não é visualizado na tela)"},"cStatus":{"type":"string","description":"Status do título. Pode ser: CANCELADO RECEBIDO LIQUIDADO EMABERTO PAGTO_PARCIAL VENCEHOJE AVENCER ATRASADO"},"cNatureza":{"type":"string","description":"Natureza do título. Pode ser: P - Contas a Pagar R - Contas a Receber"},"cTipo":{"type":"string","description":"Tipo de documento. Pode ser: ADI - Adiantamento BOL - Boleto CRT - Cartão CHQ - Cheque CON - Convênios CRE - Crediário DRF - DARF DAS - DAS DEB - Débito em conta DIN - Dinheiro DOC - DOC GUIA - Guia de Recolhimento PROT - Protesto REC - Recibo RPA - RPA TED - TED TRA - Transferência 99999 - Outros"},"cOperacao":{"type":"string","description":"Operação do título. Pode ser: 01 - Venda de Serviço 11 - Venda de Produto 12 - Venda de Produto pelo PDV 13 - Devolução de Venda 14 - Remessa de Produto 16 - Nota Complementar de Saída 21 - Compra de Produto 22 - Compra de Produto (Importação) 23 - Devolução ao Fornecedor 24 - Retorno de Remessa 26 - Nota Complementar de Entrada 28 - Ordem de Produção"},"cNumDocFiscal":{"type":"string","description":"Número do documento fiscal (NF-e, NFC-e, NFS-e, etc) (Informado pelo usuário / visualizado na tela)"},"cCodCateg":{"type":"string","description":"Código da categoria."},"aCodCateg":{"type":"array","items":{"type":"object","properties":{"cCodCateg":{"type":"string","description":"Código da categoria"},"nValor":{"type":"decimal","description":"Valor da categoria"},"nPerc":{"type":"decimal","description":"Percentual da categoria"}}}},"cNumParcela":{"type":"string","description":"Número da parcela \"Formatada\" como 999/999"},"nValorTitulo":{"type":"decimal","description":"Valor do título."},"nValorPIS":{"type":"decimal","description":"Valor do PIS."},"cRetPIS":{"type":"string","description":"Indica que o Valor do PIS informado deve ser retido."},"nValorCOFINS":{"type":"decimal","description":"Valor do COFINS."},"cRetCOFINS":{"type":"string","description":"Indica que o Valor do COFINS informado deve ser retido."},"nValorCSLL":{"type":"decimal","description":"Valor do CSLL."},"cRetCSLL":{"type":"string","description":"Indica que o Valor do CSLL informado deve ser retido."},"nValorIR":{"type":"decimal","description":"Valor do Imposto de Renda."},"cRetIR":{"type":"string","description":"Indica que o Valor do Imposto de Renda informado deve ser retido."},"nValorISS":{"type":"decimal","description":"Valor do ISS."},"cRetISS":{"type":"string","description":"Indica que o Valor do ISS informado deve ser retido."},"nValorINSS":{"type":"decimal","description":"Valor do INSS."},"cRetINSS":{"type":"string","description":"Indica que o Valor do INSS informado deve ser retido."},"observacao":{"type":"string","description":"Observações do título."},"cCodProjeto":{"type":"integer","description":"Código do projeto. (Gerado internamente, não é visualizado na tela)"},"cCodVendedor":{"type":"integer","description":"Código do vendedor. (Gerado internamente, não é visualizado na tela)"},"nCodComprador":{"type":"integer","description":"Código do comprador. (Gerado internamente, não é visualizado na tela)"},"cCodigoBarras":{"type":"string","description":"Código de Barras do título."},"cNSU":{"type":"string","description":"Número Sequencial Único - Comprovante de pagamento."},"nCodNF":{"type":"integer","description":"Código da Nota Fiscal."},"dDtRegistro":{"type":"string","description":"Data de registro da NF."},"cNumBoleto":{"type":"string","description":"Número do Boleto."},"cChaveNFe":{"type":"string","description":"Chave da NF-e, CT-e, NFC-e de origem."},"cOrigem":{"type":"string","description":"Origem do lançamento. Pode ser: APBP Integração de Pagamento de Conta APBR Integração de Recebimento de Conta APEP Integração de Lançamento de Despesa APER Integração de Lançamento de Receita APIP Integração de Conta a Pagar APIR Integração de Conta a Receber BARP Conta a Pagar Importada por Código de Barras BARR Conta a Receber Importada por Código de Barras BAXP Pagamento de Conta a Pagar BAXR Recebimento de Conta a Receber COMP Parcela a Pagar de Compras DEVP Conta a Pagar da Devolução de Venda DEVR Conta a Receber da Devolução ao Fornecedor EXTP Lançamento Manual de Despesa EXTR Lançamento Manual de Receita IMPP Parcela a Pagar de uma Nota de Importação MANP Lançamento Manual de Conta a Pagar MANR Lançamento Manual de Conta a Receber NFEP Conta a Pagar Importada de uma NF-e NFER Conta a Receber Importada de uma NF-e OFXP Pagamento Importado de um arquivo OFX OFXR Recebimento Importado de um arquivo OFX RPTP Repetição de Contas a Pagar RPTR Repetição de Contas a Receber TRAP Débito de Transf. entre Contas Correntes TRAR Crédito de Transf. entre Contas Correntes VENR Parcela a Receber de Vendas XMLP Conta a Pagar Importada de um arquivo XML XMLR Conta a Receber Importada de um arquivo XML"},"nCodTitRepet":{"type":"integer","description":"Código do título original que gerou a repetição dos lançamentos."},"dDtCanc":{"type":"string","description":"Data de Cancelamento do título."},"departamentos":{"type":"array","items":{"type":"object","properties":{"cCodDepartamento":{"type":"string","description":"Código do Departamento."},"nDistrPercentual":{"type":"decimal","description":"Percentual da distribuição."},"nDistrValor":{"type":"decimal","description":"Valor da distribuição."},"nValorFixo":{"type":"string","description":"Indica que o valor foi fixado na distribuição (S/N)."}}},"description":"Distribuição por departamentos."},"info":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão. No formato dd/mm/aaaa."},"hInc":{"type":"string","description":"Hora da Inclusão. No formato hh:mm:ss."},"uInc":{"type":"string","description":"Usuário da Inclusão."},"dAlt":{"type":"string","description":"Data da Alteração. No formato dd/mm/aaaa."},"hAlt":{"type":"string","description":"Hora da Alteração. No formato hh:mm:ss."},"uAlt":{"type":"string","description":"Usuário da Alteração."},"cImpAPI":{"type":"string","description":"Importado pela API (S/N)."}},"description":"Informações complemetares."}},"description":"Informações sobre o título encontrado"},"lancamentos":{"type":"array","items":{"type":"object","properties":{"nCodLanc":{"type":"integer","description":"Código do lançamento"},"cCodIntLanc":{"type":"string","description":"Código de Integração do Lançamento"},"nIdLancCC":{"type":"integer","description":"Código do Lançamento na Conta Corrente"},"dDtLanc":{"type":"string","description":"Data do Lançamento"},"nValLanc":{"type":"decimal","description":"Valor do Lançamento"},"nMulta":{"type":"decimal","description":"Multa para o título"},"nJuros":{"type":"decimal","description":"Juros para o título"},"nDesconto":{"type":"decimal","description":"Descontos do título"},"nCodCC":{"type":"integer","description":"Código da Conta Corrente"},"cNatureza":{"type":"string","description":"Natureza do Lançamento. Pode ser: P - Contas a Pagar R - Contas a Receber"},"cObsLanc":{"type":"string","description":"Observação para o lançamento"}}},"description":"Lançamentos realizados para o título"},"resumo":{"type":"object","properties":{"cLiquidado":{"type":"string","description":"Indica se o título está liquidado. Pode ser: S - Sim, indicado que o título está quitado. N - Não, indicando que o título ainda está em aberto."},"nValPago":{"type":"decimal","description":"Valor total pago para o título."},"nValAberto":{"type":"decimal","description":"Valor total em aberto para o título."},"nDesconto":{"type":"decimal","description":"Valor do Desconto."},"nJuros":{"type":"decimal","description":"Valor do Juros."},"nMulta":{"type":"decimal","description":"Valor da Multa."},"nValLiquido":{"type":"decimal","description":"Valor líquido (nValPago - nDesconto + Juros + nMulta)"}},"description":"Resumo dos pagamentos realizados para o título"}}}}},"title":"PesquisarLancamentos (retorno)"},"financas_pix_CancelarPix":{"type":"object","title":"CancelarPix","description":"Efetua o cancelamento de um PIX","required":["call","param"],"properties":{"call":{"type":"string","enum":["CancelarPix"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdPix":{"type":"integer","maxLength":15,"description":"ID do lançamento PIX.\nO conteúdo desse campo é o código interno gerado pelo Omie ao gerar o PIX.\n\nEsse campo não é exibido na tela do Omie, mas é a chave de integração via API.\nÉ uma informação interna, utilizada apenas nas APIs."},"cCodIntPix":{"type":"string","maxLength":60,"description":"Código do lançamento gerado pelo integrador."},"lDel":{"type":"boolean","maxLength":1,"description":"Indica se a conta a receber será excluída\nao efetuar o cancelamento do PIX.\n\nAo ser preenchida com true a conta a receber que gerou o PIX será excluída.\n\nPode ser:\nfalse\ntrue\n\nDefault: true"}}}}},"example":{"call":"CancelarPix","param":[{"nIdPix":0,"cCodIntPix":""}]}},"financas_pix_CancelarPix_retorno":{"type":"object","properties":{"cCodStatus":{"type":"string"},"cDescStatus":{"type":"string"}},"title":"CancelarPix (retorno)"},"financas_pix_GerarPix":{"type":"object","title":"GerarPix","description":"Gera o QrCode de um PIX.","required":["call","param"],"properties":{"call":{"type":"string","enum":["GerarPix"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cCodIntPix":{"type":"string","maxLength":60,"description":"Código do lançamento gerado pelo integrador."},"nCodTitulo":{"type":"integer","maxLength":15,"description":"ID da conta a receber que irá gerar o PIX.\n\nCaso essa tag não seja preenchida uma nova conta a receber será gerada."},"vValor":{"type":"number","maxLength":18,"description":"Valor do PIX."},"nIdConta":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente.\n\nCaso não informado, assumirá a conta omie.CASH\n\nUtilize a tag \"codigo\" do método \"PesquisarContaCorrente\" da API\nhttp://app.omie.com.br/api/v1/geral/contacorrente/\npara obter essa informação.\n\nEssa tag não deve ser preenchida quando a tag \"nCodTitulo\" for informada."},"cUrlNotif":{"type":"string","description":"URL de CallBack que será acionada quando o pagamento for efetuado."},"nIdCliente":{"type":"integer","maxLength":15,"description":"Código do cliente.\nInformação utilizada para identificar o cadastro do Cliente.\n\nUtilize a tag \"codigo_cliente_omie\" do método \"ListarClientes\" da API\n/api/v1/geral/clientes/\npara obter essa informação.\n\n\nQuando as  tags \"cIdCliente\" e cCnpjCpf\" não informadas, assumirá que o PIX foi realizado para um cliente consumidor padrão.\n\nCaso não exista um cliente consumidor cadastrado, o mesmo será criado automaticamente.\n\nEssa tag não deve ser preenchida quando a tag \"nCodTitulo\" for informada."},"cCnpjCpf":{"type":"string","maxLength":20,"description":"CNPJ/CPF do cliente.\nInformação utilizada para identificar o cadastro do Cliente.\n\nUtilize a tag \"cbpj_cpf\" do método \"ListarClientes\" da API\n/api/v1/geral/clientes/\npara obter essa informação.\n\n\nQuando as  tags \"cIdCliente\" e cCnpjCpf\" não informadas, assumirá que o PIX foi realizado para um cliente consumidor padrão.\n\nCaso não exista um cliente consumidor cadastrado, o mesmo será criado automaticamente."}},"required":["cCodIntPix"]}}},"example":{"call":"GerarPix","param":[{"cCodIntPix":"1670867357","nIdCliente":0,"vValor":1.99,"nIdConta":0,"cUrlNotif":""}]}},"financas_pix_GerarPix_retorno":{"type":"object","properties":{"nIdPix":{"type":"integer","description":"ID do lançamento PIX. O conteúdo desse campo é o código interno gerado pelo Omie ao gerar o PIX. Esse campo não é exibido na tela do Omie, mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs."},"cCodIntPix":{"type":"string","description":"Código do lançamento gerado pelo integrador."},"nCodTitulo":{"type":"integer","description":"Código da Conta a Receber."},"cUrlPix":{"type":"string","description":"Link para obter o PDF do QrCode do PIX."},"cQrCode":{"type":"string","description":"String para a renderização do QR Code PIX."},"cCopiaCola":{"type":"string","description":"Código gerado a partir do QR Code para pagamento do PIX."},"cCodStatus":{"type":"string"},"cDescStatus":{"type":"string"},"cCliente":{"type":"integer","description":"Código do Cliente pagador do PIX."}},"title":"GerarPix (retorno)"},"financas_pix_GerarQrCodePix":{"type":"object","title":"GerarQrCodePix","description":"Gera um QrCode estático para pagamentos.","required":["call","param"],"properties":{"call":{"type":"string","enum":["GerarQrCodePix"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdConta":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente.\n\nCaso não informado, assumirá a conta omie.CASH\n\nUtilize a tag \"codigo\" do método \"PesquisarContaCorrente\" da API\nhttp://app.omie.com.br/api/v1/geral/contacorrente/\npara obter essa informação."}}}}},"example":{"call":"GerarQrCodePix","param":[{"nIdConta":0}]}},"financas_pix_GerarQrCodePix_retorno":{"type":"object","properties":{"cUrlPix":{"type":"string","description":"Link para obter o PDF do QrCode do PIX."},"cQrCode":{"type":"string","description":"String para a renderização do QR Code PIX."},"cCopiaCola":{"type":"string","description":"Código gerado a partir do QR Code para pagamento do PIX."},"cCodStatus":{"type":"string"},"cDescStatus":{"type":"string"}},"title":"GerarQrCodePix (retorno)"},"financas_pix_ListarPix":{"type":"object","title":"ListarPix","description":"Obtém a lista de detalhes dos PIX.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarPix"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15},"nRegPorPagina":{"type":"integer","maxLength":15},"dEmissaoDe":{"type":"string","maxLength":10,"description":"Filtrar pela data de emissão - de."},"dEmissaoAte":{"type":"string","maxLength":10,"description":"Filtrar pela data de emissão - Ate."},"cStatus":{"type":"string","maxLength":100,"description":"Status do PIX.\n\nPode ser:\n\nLIQUIDADO\nCANCELADO\nREGISTRADO"}}}}},"example":{"call":"ListarPix","param":[{"nPagina":1,"nRegPorPagina":50}]}},"financas_pix_ListarPix_retorno":{"type":"object","properties":{"nPagina":{"type":"integer"},"nTotPaginas":{"type":"integer"},"nRegistros":{"type":"integer"},"nTotRegistros":{"type":"integer"},"ListaPix":{"type":"array","items":{"type":"object","properties":{"nIdPix":{"type":"integer","description":"ID do lançamento PIX. O conteúdo desse campo é o código interno gerado pelo Omie ao gerar o PIX. Esse campo não é exibido na tela do Omie, mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs."},"cCodIntPix":{"type":"string","description":"Código do lançamento gerado pelo integrador."},"cCliente":{"type":"integer","description":"Código do Cliente pagador do PIX"},"nCodTitulo":{"type":"integer","description":"Código da Conta a Receber."},"vValor":{"type":"decimal","description":"Valor do PIX."},"dEmissao":{"type":"string","description":"Data de emissão."},"dVencimento":{"type":"string","description":"Data de vencimento."},"cUrlPix":{"type":"string","description":"Link para obter o PDF do QrCode do PIX."},"cCopiaCola":{"type":"string","description":"Código gerado a partir do QR Code para pagamento do PIX."},"cStatus":{"type":"string","description":"Status do PIX. Pode ser: LIQUIDADO CANCELADO REGISTRADO"},"cInfo":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão. No formato dd/mm/aaaa."},"hInc":{"type":"string","description":"Hora da Inclusão. No formato hh:mm:ss."},"uInc":{"type":"string","description":"Usuário da Inclusão."},"dAlt":{"type":"string","description":"Data da Alteração. No formato dd/mm/aaaa."},"hAlt":{"type":"string","description":"Hora da Alteração. No formato hh:mm:ss."},"uAlt":{"type":"string","description":"Usuário da Alteração."}},"description":"Informações sobre o cadastro do PIX."}}}}},"title":"ListarPix (retorno)"},"financas_pix_ListarStatusPix":{"type":"object","title":"ListarStatusPix","description":"Obtém a lista de Status dos PIX.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarStatusPix"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15},"nRegPorPagina":{"type":"integer","maxLength":15},"dEmissaoDe":{"type":"string","maxLength":10,"description":"Filtrar pela data de emissão - de."},"dEmissaoAte":{"type":"string","maxLength":10,"description":"Filtrar pela data de emissão - Ate."},"cStatus":{"type":"string","maxLength":100,"description":"Status do PIX.\n\nPode ser:\n\nLIQUIDADO\nCANCELADO\nREGISTRADO"}}}}},"example":{"call":"ListarStatusPix","param":[{"nPagina":1,"nRegPorPagina":50}]}},"financas_pix_ListarStatusPix_retorno":{"type":"object","properties":{"nPagina":{"type":"integer"},"nTotPaginas":{"type":"integer"},"nRegistros":{"type":"integer"},"nTotRegistros":{"type":"integer"},"ListaStatusPix":{"type":"array","items":{"type":"object","properties":{"nIdPix":{"type":"integer","description":"ID do lançamento PIX. O conteúdo desse campo é o código interno gerado pelo Omie ao gerar o PIX. Esse campo não é exibido na tela do Omie, mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs."},"cCodIntPix":{"type":"string","description":"Código do lançamento gerado pelo integrador."},"nCodTitulo":{"type":"integer","description":"Chave do Conta a Receber."},"vValor":{"type":"decimal","description":"Valor do PIX."},"cStatus":{"type":"string","description":"Status do PIX. Pode ser: LIQUIDADO CANCELADO REGISTRADO"}}}}},"title":"ListarStatusPix (retorno)"},"financas_pix_ObterPix":{"type":"object","title":"ObterPix","description":"Obtém os dados doPIX.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterPix"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdPix":{"type":"integer","maxLength":15,"description":"ID do lançamento PIX.\nO conteúdo desse campo é o código interno gerado pelo Omie ao gerar o PIX.\n\nEsse campo não é exibido na tela do Omie, mas é a chave de integração via API.\nÉ uma informação interna, utilizada apenas nas APIs."},"cCodIntPix":{"type":"string","maxLength":60,"description":"Código do lançamento gerado pelo integrador."},"nCodTitulo":{"type":"integer","maxLength":15,"description":"Código do Título a Receber referente ao PIX."}}}}},"example":{"call":"ObterPix","param":[{"nIdPix":0,"cCodIntPix":"","nCodTitulo":0}]}},"financas_pix_ObterPix_retorno":{"type":"object","properties":{"nIdPix":{"type":"integer","description":"ID do lançamento PIX. O conteúdo desse campo é o código interno gerado pelo Omie ao gerar o PIX. Esse campo não é exibido na tela do Omie, mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs."},"cCodIntPix":{"type":"string","description":"Código do lançamento gerado pelo integrador."},"cCliente":{"type":"integer","description":"Código do Cliente pagador do PIX"},"nCodTitulo":{"type":"integer","description":"Código da Conta a Receber."},"vValor":{"type":"decimal","description":"Valor do PIX."},"dEmissao":{"type":"string","description":"Data de emissão."},"dVencimento":{"type":"string","description":"Data de vencimento."},"cUrlPix":{"type":"string","description":"Link para obter o PDF do QrCode do PIX."},"cQrCode":{"type":"string","description":"String para a renderização do QR Code PIX."},"cCopiaCola":{"type":"string","description":"Código gerado a partir do QR Code para pagamento do PIX."},"cStatus":{"type":"string","description":"Status do PIX. Pode ser: LIQUIDADO CANCELADO REGISTRADO"},"cInfo":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão. No formato dd/mm/aaaa."},"hInc":{"type":"string","description":"Hora da Inclusão. No formato hh:mm:ss."},"uInc":{"type":"string","description":"Usuário da Inclusão."},"dAlt":{"type":"string","description":"Data da Alteração. No formato dd/mm/aaaa."},"hAlt":{"type":"string","description":"Hora da Alteração. No formato hh:mm:ss."},"uAlt":{"type":"string","description":"Usuário da Alteração."}},"description":"Informações sobre o cadastro do PIX."}},"title":"ObterPix (retorno)"},"financas_pix_ObterStatusPix":{"type":"object","title":"ObterStatusPix","description":"Obtém o Status de um PIX.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterStatusPix"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdPix":{"type":"integer","maxLength":15,"description":"ID do lançamento PIX.\nO conteúdo desse campo é o código interno gerado pelo Omie ao gerar o PIX.\n\nEsse campo não é exibido na tela do Omie, mas é a chave de integração via API.\nÉ uma informação interna, utilizada apenas nas APIs."},"cCodIntPix":{"type":"string","maxLength":60,"description":"Código do lançamento gerado pelo integrador."},"nCodTitulo":{"type":"integer","maxLength":15,"description":"Código do Título a Receber referente ao PIX."}}}}},"example":{"call":"ObterStatusPix","param":[{"nIdPix":0,"cCodIntPix":"","nCodTitulo":0}]}},"financas_pix_ObterStatusPix_retorno":{"type":"object","properties":{"nIdPix":{"type":"integer","description":"ID do lançamento PIX. O conteúdo desse campo é o código interno gerado pelo Omie ao gerar o PIX. Esse campo não é exibido na tela do Omie, mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs."},"cCodIntPix":{"type":"string","description":"Código do lançamento gerado pelo integrador."},"nCodTitulo":{"type":"integer","description":"Chave da Conta a Receber."},"vValor":{"type":"decimal","description":"Valor do PIX."},"cStatus":{"type":"string","description":"Status do PIX. Pode ser: LIQUIDADO CANCELADO REGISTRADO"}},"title":"ObterStatusPix (retorno)"},"financas_resumo_ObterDetalhesLancamento":{"type":"object","title":"ObterDetalhesLancamento","description":"Detalhes do lançamento em aberto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterDetalhesLancamento"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdTitulo":{"type":"integer","maxLength":15,"description":"Informe aqui o código da conta pagar ou receber."},"cIncluirTarefas":{"type":"string","maxLength":1,"example":"S","description":"Indica se deve incluir as tarefas vinculadas ao lançamento no retorno (S/N).\n\nComo default é \"N\"."}},"required":["nIdTitulo"]}}},"example":{"call":"ObterDetalhesLancamento","param":[{"nIdTitulo":0}]}},"financas_resumo_ObterDetalhesLancamento_retorno":{"type":"object","properties":{"cTipoLanc":{"type":"string","description":"Tipo do lançamento retornado. P - Lançamento a Pagar R - Lançamento a Receber"},"nIdTitulo":{"type":"integer","description":"Código do lançamento. (Gerado internamente, não é visualizado na tela)"},"nIdCliente":{"type":"integer","description":"Código do cliente ou Fornecedor. (Gerado internamente, não é visualizado na tela)"},"cNomeCliente":{"type":"string","description":"Nome do Cliente ou Fornecedor."},"cCodCateg":{"type":"string","description":"Código da Categoria"},"cDescCateg":{"type":"string","description":"Descrição da categoria."},"cDescCtaCorr":{"type":"string","description":"Descrição da conta corrente."},"dEmissao":{"type":"string","description":"Data de emissão do lançamento."},"dVencimento":{"type":"string","description":"Data de vencimento do lançamento."},"dPrevisao":{"type":"string","description":"Data de previsão do lançamento."},"nDiasAtraso":{"type":"decimal","description":"Dias de atraso do lançamento."},"vDoc":{"type":"decimal","description":"Valor do lançamento."},"cUrlLogoBanco":{"type":"string","description":"URL da Imagem do Logo do Banco."},"cSituacao":{"type":"string","description":"Situação do lançamento. Ex: Atrasado desde 30/10 Qua"},"cCor":{"type":"string"},"cIcone":{"type":"string"},"nQtdeAnexos":{"type":"integer","description":"Indica a quantidade de anexos."},"listaAnexos":{"type":"array","items":{"type":"object","properties":{"nIdAnexo":{"type":"integer","description":"ID do anexo. Gerado automático na inclusão. Informe esse campo para Obter, Consultar e Excluir o anexo."},"cCodIntAnexo":{"type":"string","description":"Código de integração do anexo. (Interno, utilizado apenas na integração via API, não é exibido na tela). Utilize esse campo para informar o código do anexo utilizado no seu aplicativo quando incluir o anexo no Omie. Assim, poderá utilizar esse campo para resgatar o anexo desejado."},"cNomeArquivo":{"type":"string","description":"Nome do arquivo que foi adicionado. Preencha essa tag, apenas se você não tiver ou souber qual é o código de integração do anexo (tag cCodIntAnexo). Caso a tag cCodIntAnexo esteja preenchida, o conteúdo dessa tag será desconsiderado."},"cTipoArquivo":{"type":"string","description":"Tipo de arquivo."},"cTabela":{"type":"string","description":"Nome da tabela onde o anexo está incluído. Pode ser: conta-pagar conta-receber"}}},"description":"Lista de anexos do lançamento."},"nQtdeTarefas":{"type":"integer","description":"Indica a quantidade de tarefas."},"listaTarefas":{"type":"array","items":{"type":"object","properties":{"nCodTarefa":{"type":"integer","description":"Código único da tarefa."},"cCodIntTarefa":{"type":"string"},"cDescricao":{"type":"string","description":"Descrição da tarefa."},"dData":{"type":"string"},"hHora":{"type":"string"},"nCodDoc":{"type":"integer","description":"Id do documento vinculado a tarefa. Esse campo varia conforme a origem da tarefa. Ele permite vincular a tarefa a um documento específico, seja ele relacionado a uma oportunidade, contas a pagar, contas a receber, entre outros. Exemplo: Se a origem da tarefa for \"pedido-compra\", esse campo reflete o código do pedido de compra. Se a origem da tarefa for \"contas-receber\", esse campo reflete o código da conta a receber."},"nCodUserAtb":{"type":"integer","description":"Código do usuário atribuído."},"cNomeUserAtb":{"type":"string"}}},"description":"Lista com as tarefas relacionadas ao lançamento. Retornado quando preenchida a tag \"cIncluirTarefas\" como \"S\"."},"cBolGerado":{"type":"string","description":"Indica se o boleto foi gerado. Retornado apenas para contas a receber."},"cBolPodeGerar":{"type":"string","description":"Indica se o boleto pode ser gerado. (S/N) Retornado apenas para contas a receber."},"boletoInfo":{"type":"object","properties":{"cNumBoleto":{"type":"string","description":"Nosso número (sequencial)."},"cNumBancario":{"type":"string","description":"Nosso número impresso no boleto (formatado)."},"cCodBarras":{"type":"string","description":"Código de barras do boleto."},"cLinkBoleto":{"type":"string","description":"Link do boleto."},"dEmissao":{"type":"string","description":"Data de emissão."},"dVencimento":{"type":"string","description":"Data de vencimento."},"nPerJuros":{"type":"decimal","description":"Percentual de juros ao mês."},"nPerMulta":{"type":"decimal","description":"Percentual de multa."}},"description":"Detalhes do boleto gerado. Retornado apenas para contas a receber."},"cPixGerado":{"type":"string","description":"Indica se o PIX foi gerado. Retornado apenas para contas a receber."},"cPixPodeGerar":{"type":"string","description":"Indica se o PIX pode ser gerado. (S/N) Retornado apenas para contas a receber."},"pixInfo":{"type":"object","properties":{"nIdPix":{"type":"integer","description":"ID do lançamento PIX. O conteúdo desse campo é o código interno gerado pelo Omie ao gerar o PIX. Esse campo não é exibido na tela do Omie, mas é a chave de integração via API. É uma informação interna, utilizada apenas nas APIs."},"cCodIntPix":{"type":"string","description":"Código do lançamento gerado pelo integrador."},"dEmissao":{"type":"string","description":"Data de emissão."},"dVencimento":{"type":"string","description":"Data de vencimento."},"cCopiaCola":{"type":"string","description":"Código gerado a partir do QR Code para pagamento do PIX."},"cUrlPix":{"type":"string","description":"Link para obter o PDF do QrCode do PIX."},"cStatus":{"type":"string","description":"Status do PIX na API do banco."},"vValor":{"type":"decimal","description":"Valor do PIX."}},"description":"Detalhes do boleto gerado. Retornado apenas para contas a receber."}},"title":"ObterDetalhesLancamento (retorno)"},"financas_resumo_ObterListaEmAberto":{"type":"object","title":"ObterListaEmAberto","description":"Lista de lançamentos em aberto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterListaEmAberto"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"dDia":{"type":"string","maxLength":10,"description":"Informe aqui a data de registro para listar os lançamentos.\n\nDefault data atual."},"cTipo":{"type":"string","maxLength":1,"example":"P","description":"Informe aqui o tipo de Lançamento.\n\nPode ser:\nP - Lançamentos a Pagar.\nR - Lançamentos a Receber."},"nCodCliente":{"type":"integer","maxLength":15},"cNomeCliente":{"type":"string","maxLength":100,"description":"Nome do Cliente ou Fornecedor."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página."},"nPagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."}},"required":["cTipo"]}}},"example":{"call":"ObterListaEmAberto","param":[{"dDia":"30/09/2026","cTipo":"P","nPagina":1,"nRegPorPagina":50}]}},"financas_resumo_ObterListaEmAberto_retorno":{"type":"object","properties":{"ListaEmEberto":{"type":"array","items":{"type":"object","properties":{"nIdTitulo":{"type":"integer","description":"Código do lançamento. (Gerado internamente, não é visualizado na tela)"},"nIdCliente":{"type":"integer","description":"Código do cliente ou Fornecedor. (Gerado internamente, não é visualizado na tela)"},"cNomeCliente":{"type":"string","description":"Nome do Cliente ou Fornecedor."},"vDoc":{"type":"decimal","description":"Valor do lançamento."},"dVencimento":{"type":"string","description":"Data de vencimento do lançamento."},"dEmissao":{"type":"string","description":"Data de emissão do lançamento."},"cCodCateg":{"type":"string","description":"Código da Categoria"},"cDescCateg":{"type":"string","description":"Descrição da categoria."},"nDiasAtraso":{"type":"decimal","description":"Dias de atraso do lançamento."},"nQtdeAnexos":{"type":"integer","description":"Indica a quantidade de anexos."},"nQtdeTarefas":{"type":"integer","description":"Indica a quantidade de tarefas."},"cIcone":{"type":"string"},"cCor":{"type":"string"},"cUrlLogoBanco":{"type":"string","description":"URL da Imagem do Logo do Banco."},"cBolGerado":{"type":"string","description":"Indica se o boleto foi gerado. Retornado apenas para contas a receber."},"cBolPodeGerar":{"type":"string","description":"Indica se o boleto pode ser gerado. (S/N) Retornado apenas para contas a receber."},"cPixGerado":{"type":"string","description":"Indica se o PIX foi gerado. Retornado apenas para contas a receber."},"cPixPodeGerar":{"type":"string","description":"Indica se o PIX pode ser gerado. (S/N) Retornado apenas para contas a receber."}}},"description":"Lista de Lançamentos em aberto."},"nRegistros":{"type":"integer"},"nPagina":{"type":"integer"},"nTotPaginas":{"type":"integer"},"nTotRegistros":{"type":"integer"}},"title":"ObterListaEmAberto (retorno)"},"financas_resumo_ObterListaFinancas":{"type":"object","title":"ObterListaFinancas","description":"Obtém a lista de lançamentos.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterListaFinancas"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"dDia":{"type":"string","maxLength":10,"description":"Informe aqui a data de registro para listar os lançamentos.\n\nDefault data atual."},"cCodCateg":{"type":"string","maxLength":20,"description":"Informe aqui o código da categoria de acordo com o preenchimento da tag \"cTipo\".\n\nPara lançamentos a pagar (\"cTipo\" = \"P\") você deve informar uma categoria do tipo Despesa e para lançamentos a receber (\"cTipo\" = \"R\") deve informar uma categoria do tipo Receita.\n\nUtilize a tag \"codigo\" do método \"ListarCategorias\" da API\n/api/v1/geral/categorias/\npara obter essa informação."},"cTipo":{"type":"string","maxLength":1,"example":"P","description":"Informe aqui o tipo de Lançamento.\n\nPode ser:\nP - Lançamentos a Pagar.\nR - Lançamentos a Receber."}},"required":["cCodCateg","cTipo"]}}},"example":{"call":"ObterListaFinancas","param":[{"dDia":"30/09/2026","cCodCateg":"1.01.01","cTipo":"R"}]}},"financas_resumo_ObterListaFinancas_retorno":{"type":"object","properties":{"listaDetalhesFinancas":{"type":"array","items":{"type":"object","properties":{"nIdTitulo":{"type":"integer","description":"Código do lançamento. (Gerado internamente, não é visualizado na tela)"},"nIdCliente":{"type":"integer","description":"Código do cliente ou Fornecedor. (Gerado internamente, não é visualizado na tela)"},"cNomeCliente":{"type":"string","description":"Nome do Cliente ou Fornecedor."},"vDoc":{"type":"decimal","description":"Valor do lançamento."},"dVencimento":{"type":"string","description":"Data de vencimento do lançamento."},"dEmissao":{"type":"string","description":"Data de emissão do lançamento."},"dPrevisao":{"type":"string","description":"Data de previsão do Lançamento."},"nIdConta":{"type":"integer","description":"Código da Conta Corrente. (Gerado internamente, não é visualizado na tela)"},"cNomeConta":{"type":"string","description":"Nome da Conta Corrente."},"cNumDocumentoFiscal":{"type":"string","description":"Número do Documento fiscal."},"cNumDocumento":{"type":"string","description":"Número do documento."}}},"description":"Lista de Lançamentos."}},"title":"ObterListaFinancas (retorno)"},"financas_resumo_ObterResumoFinancas":{"type":"object","title":"ObterResumoFinancas","description":"Obtém o resumo das finanças.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterResumoFinancas"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"dDia":{"type":"string","maxLength":10,"example":"18/06/2026","description":"Data da Consulta."},"lApenasResumo":{"type":"boolean","description":"Exibir apenas o resumo.\n\nQuando true será retornado as estruturas:\n\ncontaCorrente\ncontaPagar\ncontaReceber\n\nQuando false retornará todas as estruturas.\n\nDefault = true"},"lExibirCategoria":{"type":"boolean","description":"Exibir os valores dos lançamentos por categoria.\n\nQuando true será retornado as estruturas:\n\ncontaPagarCategoria\ncontaReceberCategoria\n\nDefault = true"}}}}},"example":{"call":"ObterResumoFinancas","param":[{"dDia":"30/09/2026","lApenasResumo":true}]}},"financas_resumo_ObterResumoFinancas_retorno":{"type":"object","properties":{"dDia":{"type":"string","description":"Data da Consulta."},"contaCorrente":{"type":"object","properties":{"vTotal":{"type":"decimal","description":"Valor total."},"vLimiteCredito":{"type":"decimal","description":"Valor total Saldo + Limite de Crédito."},"cIcone":{"type":"string"},"cCor":{"type":"string"}},"description":"Exibe o total de saldo das contas correntes."},"contaPagar":{"type":"object","properties":{"nTotal":{"type":"decimal","description":"Quantidade de lançamentos."},"vTotal":{"type":"decimal","description":"Valor total dos lançamentos."},"vAtraso":{"type":"decimal","description":"Valor total dos lançamentos em atraso."},"cIcone":{"type":"string"},"cCor":{"type":"string"}},"description":"Exibe os totais dos lançamentos a pagar."},"contaReceber":{"type":"object","properties":{"nTotal":{"type":"decimal","description":"Quantidade de lançamentos."},"vTotal":{"type":"decimal","description":"Valor total dos lançamentos."},"vAtraso":{"type":"decimal","description":"Valor total dos lançamentos em atraso."},"cIcone":{"type":"string"},"cCor":{"type":"string"}},"description":"Exibe os totais dos lançamentos a receber."},"contaPagarCategoria":{"type":"array","items":{"type":"object","properties":{"vTotal":{"type":"decimal","description":"Valor total."},"nTotal":{"type":"decimal","description":"Quantidade total de lançamentos."},"cCodCateg":{"type":"string","description":"Código da Categoria"},"cDescCateg":{"type":"string","description":"Descrição da categoria."},"cIcone":{"type":"string"},"cCor":{"type":"string"}}},"description":"Exibe os totais por categoria dos lançamentos a pagar."},"contaReceberCategoria":{"type":"array","items":{"type":"object","properties":{"vTotal":{"type":"decimal","description":"Valor total."},"nTotal":{"type":"decimal","description":"Quantidade total de lançamentos."},"cCodCateg":{"type":"string","description":"Código da Categoria"},"cDescCateg":{"type":"string","description":"Descrição da categoria."},"cIcone":{"type":"string"},"cCor":{"type":"string"}}},"description":"Exibe os totais por categoria dos lançamentos a receber."},"contaPagarAtraso":{"type":"array","items":{"type":"object","properties":{"nIdTitulo":{"type":"integer","description":"Código do lançamento. (Gerado internamente, não é visualizado na tela)"},"nIdCliente":{"type":"integer","description":"Código do cliente ou Fornecedor. (Gerado internamente, não é visualizado na tela)"},"cNomeCliente":{"type":"string","description":"Nome do Cliente ou Fornecedor."},"vDoc":{"type":"decimal","description":"Valor do lançamento."},"dVencimento":{"type":"string","description":"Data de vencimento do lançamento."},"dEmissao":{"type":"string","description":"Data de emissão do lançamento."},"cCodCateg":{"type":"string","description":"Código da Categoria"},"cDescCateg":{"type":"string","description":"Descrição da categoria."},"nDiasAtraso":{"type":"decimal","description":"Dias de atraso do lançamento."},"cIcone":{"type":"string"},"cCor":{"type":"string"},"cUrlLogoBanco":{"type":"string","description":"URL da Imagem do Logo do Banco."}}},"description":"Exibe os lançamentos a pagar atrasados."},"contaReceberAtraso":{"type":"array","items":{"type":"object","properties":{"nIdTitulo":{"type":"integer","description":"Código do lançamento. (Gerado internamente, não é visualizado na tela)"},"nIdCliente":{"type":"integer","description":"Código do cliente ou Fornecedor. (Gerado internamente, não é visualizado na tela)"},"cNomeCliente":{"type":"string","description":"Nome do Cliente ou Fornecedor."},"vDoc":{"type":"decimal","description":"Valor do lançamento."},"dVencimento":{"type":"string","description":"Data de vencimento do lançamento."},"dEmissao":{"type":"string","description":"Data de emissão do lançamento."},"cCodCateg":{"type":"string","description":"Código da Categoria"},"cDescCateg":{"type":"string","description":"Descrição da categoria."},"nDiasAtraso":{"type":"decimal","description":"Dias de atraso do lançamento."},"cIcone":{"type":"string"},"cCor":{"type":"string"},"cUrlLogoBanco":{"type":"string","description":"URL da Imagem do Logo do Banco."}}},"description":"Exibe os lançamentos a receber atrasados."},"fluxoCaixa":{"type":"object","properties":{"dDia":{"type":"string","description":"Data da Consulta."},"vPagar":{"type":"decimal","description":"Valor total de títulos a pagar."},"vReceber":{"type":"decimal","description":"Valor total de títulos a receber."},"vSaldo":{"type":"decimal","description":"Valor total do saldo bancário."}},"description":"Exibe as informações de resumo do caixa."}},"title":"ObterResumoFinancas (retorno)"},"geral_anexo_ConsultarAnexo":{"type":"object","title":"ConsultarAnexo","description":"Consulta os dados de um anexo vinculado a um documento.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarAnexo"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cCodIntAnexo":{"type":"string","maxLength":20,"description":"Código de integração do anexo.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nUtilize esse campo para informar o código do anexo utilizado no seu aplicativo quando incluir o anexo no Omie.\nAssim, poderá utilizar esse campo para resgatar o anexo desejado."},"cTabela":{"type":"string","maxLength":100,"example":"cliente","description":"Nome da tabela onde o anexo está incluído.\n\nPode ser:\ncliente\nproduto\nservico\npedido-venda\nremessa-produto\nordem-servico\ncontrato-servico\npedido-compra\nnota-entrada\nordem-producao\nconta-pagar\nconta-receber\nconta-corrente\nconta-corrente-lancamento\ncrm-contas\ncrm-contatos\ncrm-oportunidades\ncom-recebimento"},"nId":{"type":"integer","maxLength":15,"description":"ID do documento de acordo com a tabela especificada.\n\nPor exemplo:\nCaso você informe \"cliente\" na tag \"cTabela\" você deve informar o ID do cliente neste campo."},"nIdAnexo":{"type":"integer","maxLength":15,"description":"ID do anexo.\n\nGerado automático na inclusão.\nInforme esse campo para Obter, Consultar e Excluir o anexo."},"cNomeArquivo":{"type":"string","maxLength":100,"description":"Nome do arquivo do anexo."}},"required":["cTabela","nId"]}}},"example":{"call":"ConsultarAnexo","param":[{"cCodIntAnexo":"","cTabela":"","nId":0,"nIdAnexo":0,"cNomeArquivo":""}]}},"geral_anexo_ConsultarAnexo_retorno":{"type":"object","properties":{"cCodIntAnexo":{"type":"string","description":"Código de integração do anexo. (Interno, utilizado apenas na integração via API, não é exibido na tela). Utilize esse campo para informar o código do anexo utilizado no seu aplicativo quando incluir o anexo no Omie. Assim, poderá utilizar esse campo para resgatar o anexo desejado."},"cTabela":{"type":"string","description":"Nome da tabela onde o anexo está incluído. Pode ser: cliente produto servico pedido-venda remessa-produto ordem-servico contrato-servico pedido-compra nota-entrada ordem-producao conta-pagar conta-receber conta-corrente conta-corrente-lancamento crm-contas crm-contatos crm-oportunidades com-recebimento"},"nId":{"type":"integer","description":"ID do documento de acordo com a tabela especificada. Por exemplo: Caso você informe \"cliente\" na tag \"cTabela\" você deve informar o ID do cliente neste campo."},"nIdAnexo":{"type":"integer","description":"ID do anexo. Gerado automático na inclusão. Informe esse campo para Obter, Consultar e Excluir o anexo."},"cNomeArquivo":{"type":"string","description":"Nome do arquivo que foi adicionado. Preencha essa tag, apenas se você não tiver ou souber qual é o código de integração do anexo (tag cCodIntAnexo). Caso a tag cCodIntAnexo esteja preenchida, o conteúdo dessa tag será desconsiderado."},"cTipoArquivo":{"type":"string","description":"Tipo de Arquivo."},"info":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão. No formato dd/mm/aaaa."},"hInc":{"type":"string","description":"Hora da Inclusão. No formato hh:mm:ss."},"uInc":{"type":"string","description":"Usuário da Inclusão."},"dAlt":{"type":"string","description":"Data da Alteração. No formato dd/mm/aaaa."},"hAlt":{"type":"string","description":"Hora da Alteração. No formato hh:mm:ss."},"uAlt":{"type":"string","description":"Usuário da Alteração."},"cImpAPI":{"type":"string","description":"Importado pela API (S/N)."}},"description":"Informações complementares do anexo."}},"title":"ConsultarAnexo (retorno)"},"geral_anexo_ExcluirAnexo":{"type":"object","title":"ExcluirAnexo","description":"Exclui um anexo vinculado a um documento.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirAnexo"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cCodIntAnexo":{"type":"string","maxLength":20,"description":"Código de integração do anexo.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nUtilize esse campo para informar o código do anexo utilizado no seu aplicativo quando incluir o anexo no Omie.\nAssim, poderá utilizar esse campo para resgatar o anexo desejado."},"cTabela":{"type":"string","maxLength":100,"example":"cliente","description":"Nome da tabela onde o anexo está incluído.\n\nPode ser:\ncliente\nproduto\nservico\npedido-venda\nremessa-produto\nordem-servico\ncontrato-servico\npedido-compra\nnota-entrada\nordem-producao\nconta-pagar\nconta-receber\nconta-corrente\nconta-corrente-lancamento\ncrm-contas\ncrm-contatos\ncrm-oportunidades\ncom-recebimento"},"nId":{"type":"integer","maxLength":15,"description":"ID do documento de acordo com a tabela especificada.\n\nPor exemplo:\nCaso você informe \"cliente\" na tag \"cTabela\" você deve informar o ID do cliente neste campo."},"nIdAnexo":{"type":"integer","maxLength":15,"description":"ID do anexo.\n\nGerado automático na inclusão.\nInforme esse campo para Obter, Consultar e Excluir o anexo."},"cNomeArquivo":{"type":"string","maxLength":100,"description":"Nome do arquivo do anexo."}},"required":["cTabela","nId"]}}},"example":{"call":"ExcluirAnexo","param":[{"cCodIntAnexo":"","cTabela":"","nId":0,"nIdAnexo":0,"cNomeArquivo":""}]}},"geral_anexo_ExcluirAnexo_retorno":{"type":"object","properties":{"cCodIntAnexo":{"type":"string","description":"Código de integração do anexo. (Interno, utilizado apenas na integração via API, não é exibido na tela). Utilize esse campo para informar o código do anexo utilizado no seu aplicativo quando incluir o anexo no Omie. Assim, poderá utilizar esse campo para resgatar o anexo desejado."},"cTabela":{"type":"string","description":"Nome da tabela onde o anexo está incluído. Pode ser: cliente produto servico pedido-venda remessa-produto ordem-servico contrato-servico pedido-compra nota-entrada ordem-producao conta-pagar conta-receber conta-corrente conta-corrente-lancamento crm-contas crm-contatos crm-oportunidades com-recebimento"},"nId":{"type":"integer","description":"ID do documento de acordo com a tabela especificada. Por exemplo: Caso você informe \"cliente\" na tag \"cTabela\" você deve informar o ID do cliente neste campo."},"nIdAnexo":{"type":"integer","description":"ID do anexo. Gerado automático na inclusão. Informe esse campo para Obter, Consultar e Excluir o anexo."},"cNomeArquivo":{"type":"string","description":"Nome do arquivo que foi adicionado. Preencha essa tag, apenas se você não tiver ou souber qual é o código de integração do anexo (tag cCodIntAnexo). Caso a tag cCodIntAnexo esteja preenchida, o conteúdo dessa tag será desconsiderado."},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro duranteo o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodigoStatus\"."}},"title":"ExcluirAnexo (retorno)"},"geral_anexo_IncluirAnexo":{"type":"object","title":"IncluirAnexo","description":"Inclui o anexo para um documento.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirAnexo"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cCodIntAnexo":{"type":"string","maxLength":20,"description":"Código de integração do anexo.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nUtilize esse campo para informar o código do anexo utilizado no seu aplicativo quando incluir o anexo no Omie.\nAssim, poderá utilizar esse campo para resgatar o anexo desejado."},"cTabela":{"type":"string","maxLength":100,"example":"cliente","description":"Nome da tabela onde o anexo está incluído.\n\nPode ser:\ncliente\nproduto\nservico\npedido-venda\nremessa-produto\nordem-servico\ncontrato-servico\npedido-compra\nnota-entrada\nordem-producao\nconta-pagar\nconta-receber\nconta-corrente\nconta-corrente-lancamento\ncrm-contas\ncrm-contatos\ncrm-oportunidades\ncom-recebimento"},"nId":{"type":"integer","maxLength":15,"description":"ID do documento de acordo com a tabela especificada.\n\nPor exemplo:\nCaso você informe \"cliente\" na tag \"cTabela\" você deve informar o ID do cliente neste campo."},"cNomeArquivo":{"type":"string","maxLength":100,"description":"Nome do arquivo do anexo."},"cTipoArquivo":{"type":"string","maxLength":10,"description":"Tipo de Arquivo."},"cArquivo":{"type":"string","description":"Conteúdo do arquivo a ser anexado, compactado (zip) e convertido   em base 64."},"cMd5":{"type":"string","maxLength":32,"description":"MD5 do arquivo enviado na tag \"cArquivo\"."}},"required":["cArquivo","cMd5","cNomeArquivo","cTabela","nId"]}}},"example":{"call":"IncluirAnexo","param":[{"cCodIntAnexo":"","cTabela":"","nId":0,"cNomeArquivo":"","cTipoArquivo":"","cArquivo":"","cMd5":""}]}},"geral_anexo_IncluirAnexo_retorno":{"type":"object","properties":{"cCodIntAnexo":{"type":"string","description":"Código de integração do anexo. (Interno, utilizado apenas na integração via API, não é exibido na tela). Utilize esse campo para informar o código do anexo utilizado no seu aplicativo quando incluir o anexo no Omie. Assim, poderá utilizar esse campo para resgatar o anexo desejado."},"cTabela":{"type":"string","description":"Nome da tabela onde o anexo está incluído. Pode ser: cliente produto servico pedido-venda remessa-produto ordem-servico contrato-servico pedido-compra nota-entrada ordem-producao conta-pagar conta-receber conta-corrente conta-corrente-lancamento crm-contas crm-contatos crm-oportunidades com-recebimento"},"nId":{"type":"integer","description":"ID do documento de acordo com a tabela especificada. Por exemplo: Caso você informe \"cliente\" na tag \"cTabela\" você deve informar o ID do cliente neste campo."},"nIdAnexo":{"type":"integer","description":"ID do anexo. Gerado automático na inclusão. Informe esse campo para Obter, Consultar e Excluir o anexo."},"cNomeArquivo":{"type":"string","description":"Nome do arquivo que foi adicionado. Preencha essa tag, apenas se você não tiver ou souber qual é o código de integração do anexo (tag cCodIntAnexo). Caso a tag cCodIntAnexo esteja preenchida, o conteúdo dessa tag será desconsiderado."},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro duranteo o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodigoStatus\"."}},"title":"IncluirAnexo (retorno)"},"geral_anexo_ListarAnexo":{"type":"object","title":"ListarAnexo","description":"Lista os anexos vinculados a um documento.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarAnexo"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página que se deseja resgatar.\nO padrão é \"1\"."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Número de registros retornados por página.\nO padrão é 20.\nO limite máximo é 50 por página."},"cOrdenarPor":{"type":"string","maxLength":100,"example":"ARQUIVO","description":"Ordem os resultados da página por:\nARQUIVO - Nome do arquivo."},"cOrdemDecrescente":{"type":"string","maxLength":1,"example":"S","description":"Indica se a ordem de exibição é Decrescente caso seja informado \"S\"."},"dDtIncDe":{"type":"string","maxLength":10,"description":"Data de inclusão inicial.\nNo formato dd/mm/aaaa."},"dDtIncAte":{"type":"string","maxLength":10,"description":"Data de inclusão final.\nNo formato dd/mm/aaaa."},"dDtAltDe":{"type":"string","maxLength":10,"description":"Data de alteração inicial.\nNo formato dd/mm/aaaa."},"dDtAltAte":{"type":"string","maxLength":10,"description":"Data de alteração final.\nNo formato dd/mm/aaaa."},"nId":{"type":"integer","maxLength":15,"description":"ID do documento de acordo com a tabela especificada.\n\nPor exemplo:\nCaso você informe \"cliente\" na tag \"cTabela\" você deve informar o ID do cliente neste campo."},"cTabela":{"type":"string","maxLength":100,"example":"cliente","description":"Nome da tabela onde o anexo está incluído.\n\nPode ser:\ncliente\nproduto\nservico\npedido-venda\nremessa-produto\nordem-servico\ncontrato-servico\npedido-compra\nnota-entrada\nordem-producao\nconta-pagar\nconta-receber\nconta-corrente\nconta-corrente-lancamento\ncrm-contas\ncrm-contatos\ncrm-oportunidades\ncom-recebimento"}},"required":["cTabela","nId"]}}},"example":{"call":"ListarAnexo","param":[{"nPagina":1,"nRegPorPagina":50,"nId":0,"cTabela":""}]}},"geral_anexo_ListarAnexo_retorno":{"type":"object","properties":{"nPagina":{"type":"integer","description":"Número da página resgatada."},"nTotPaginas":{"type":"integer","description":"Número total de páginas encontradas."},"nRegistros":{"type":"integer","description":"Número de registros retornados na página."},"nTotRegistros":{"type":"integer","description":"Número total de registros encontrados."},"listaAnexos":{"type":"array","items":{"type":"object","properties":{"cCodIntAnexo":{"type":"string","description":"Código de integração do anexo. (Interno, utilizado apenas na integração via API, não é exibido na tela). Utilize esse campo para informar o código do anexo utilizado no seu aplicativo quando incluir o anexo no Omie. Assim, poderá utilizar esse campo para resgatar o anexo desejado."},"cTipoArquivo":{"type":"string","description":"Tipo de Arquivo."},"nId":{"type":"integer","description":"ID do documento de acordo com a tabela especificada. Por exemplo: Caso você informe \"cliente\" na tag \"cTabela\" você deve informar o ID do cliente neste campo."},"nIdAnexo":{"type":"integer","description":"ID do anexo. Gerado automático na inclusão. Informe esse campo para Obter, Consultar e Excluir o anexo."},"cNomeArquivo":{"type":"string","description":"Nome do arquivo que foi adicionado. Preencha essa tag, apenas se você não tiver ou souber qual é o código de integração do anexo (tag cCodIntAnexo). Caso a tag cCodIntAnexo esteja preenchida, o conteúdo dessa tag será desconsiderado."},"cTabela":{"type":"string","description":"Nome da tabela onde o anexo está incluído. Pode ser: cliente produto servico pedido-venda remessa-produto ordem-servico contrato-servico pedido-compra nota-entrada ordem-producao conta-pagar conta-receber conta-corrente conta-corrente-lancamento crm-contas crm-contatos crm-oportunidades com-recebimento"},"info":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão. No formato dd/mm/aaaa."},"hInc":{"type":"string","description":"Hora da Inclusão. No formato hh:mm:ss."},"uInc":{"type":"string","description":"Usuário da Inclusão."},"dAlt":{"type":"string","description":"Data da Alteração. No formato dd/mm/aaaa."},"hAlt":{"type":"string","description":"Hora da Alteração. No formato hh:mm:ss."},"uAlt":{"type":"string","description":"Usuário da Alteração."},"cImpAPI":{"type":"string","description":"Importado pela API (S/N)."}},"description":"Informações complementares do anexo."}}},"description":"Lista de anexos do título do contas a receber encontrados."}},"title":"ListarAnexo (retorno)"},"geral_anexo_ObterAnexo":{"type":"object","title":"ObterAnexo","description":"Obtém o link de download de um anexo vinculado a um documento.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterAnexo"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cCodIntAnexo":{"type":"string","maxLength":20,"description":"Código de integração do anexo.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nUtilize esse campo para informar o código do anexo utilizado no seu aplicativo quando incluir o anexo no Omie.\nAssim, poderá utilizar esse campo para resgatar o anexo desejado."},"cTabela":{"type":"string","maxLength":100,"example":"cliente","description":"Nome da tabela onde o anexo está incluído.\n\nPode ser:\ncliente\nproduto\nservico\npedido-venda\nremessa-produto\nordem-servico\ncontrato-servico\npedido-compra\nnota-entrada\nordem-producao\nconta-pagar\nconta-receber\nconta-corrente\nconta-corrente-lancamento\ncrm-contas\ncrm-contatos\ncrm-oportunidades\ncom-recebimento"},"nId":{"type":"integer","maxLength":15,"description":"ID do documento de acordo com a tabela especificada.\n\nPor exemplo:\nCaso você informe \"cliente\" na tag \"cTabela\" você deve informar o ID do cliente neste campo."},"nIdAnexo":{"type":"integer","maxLength":15,"description":"ID do anexo.\n\nGerado automático na inclusão.\nInforme esse campo para Obter, Consultar e Excluir o anexo."},"cNomeArquivo":{"type":"string","maxLength":100,"description":"Nome do arquivo do anexo."}},"required":["cTabela","nId"]}}},"example":{"call":"ObterAnexo","param":[{"cCodIntAnexo":"","cTabela":"","nId":0,"nIdAnexo":0,"cNomeArquivo":""}]}},"geral_anexo_ObterAnexo_retorno":{"type":"object","properties":{"cCodIntAnexo":{"type":"string","description":"Código de integração do anexo. (Interno, utilizado apenas na integração via API, não é exibido na tela). Utilize esse campo para informar o código do anexo utilizado no seu aplicativo quando incluir o anexo no Omie. Assim, poderá utilizar esse campo para resgatar o anexo desejado."},"cTabela":{"type":"string","description":"Nome da tabela onde o anexo está incluído. Pode ser: cliente produto servico pedido-venda remessa-produto ordem-servico contrato-servico pedido-compra nota-entrada ordem-producao conta-pagar conta-receber conta-corrente conta-corrente-lancamento crm-contas crm-contatos crm-oportunidades com-recebimento"},"nId":{"type":"integer","description":"ID do documento de acordo com a tabela especificada. Por exemplo: Caso você informe \"cliente\" na tag \"cTabela\" você deve informar o ID do cliente neste campo."},"nIdAnexo":{"type":"integer","description":"ID do anexo. Gerado automático na inclusão. Informe esse campo para Obter, Consultar e Excluir o anexo."},"cNomeArquivo":{"type":"string","description":"Nome do arquivo que foi adicionado. Preencha essa tag, apenas se você não tiver ou souber qual é o código de integração do anexo (tag cCodIntAnexo). Caso a tag cCodIntAnexo esteja preenchida, o conteúdo dessa tag será desconsiderado."},"cLinkDownload":{"type":"string","description":"URL para download do anexo solicitado."},"dDtExpiracao":{"type":"string","description":"Data de expiração da url disponibilizada. No formato dd/mm/aaaa."},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro duranteo o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodigoStatus\"."}},"title":"ObterAnexo (retorno)"},"geral_bancos_ConsultarBanco":{"type":"object","title":"ConsultarBanco","description":"Consulta os dados de um banco específico.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarBanco"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo":{"type":"string","maxLength":3,"description":"código do Banco / Instituíção Financeira."}},"required":["codigo"]}}},"example":{"call":"ConsultarBanco","param":[{"codigo":""}]}},"geral_bancos_ConsultarBanco_retorno":{"type":"object","properties":{"cnab_altve":{"type":"string","description":"CNAB - Permite a Alteração do Vencimento da Cobrança"},"cnab_altvl":{"type":"string","description":"CNAB - Permite a Alteração do Valor da Cobrança"},"cnab_cob":{"type":"string","description":"CNAB - Remessa de Cobrança [S/N]"},"cnab_pag":{"type":"string","description":"CNAB - Remessa de Pagamento [S/N]"},"crawler_sn":{"type":"string","description":"Crawler - Possui integração automática com o Crawler [S/N]"},"cwr_cobrem":{"type":"string","description":"Crawler - Possui remessa do CNAB de Cobrança pelo Crawler [S/N]"},"cwr_cobret":{"type":"string","description":"Crawler - Possui retorno do CNAB de Cobrança pelo Crawler [S/N]"},"cwr_pagrem":{"type":"string","description":"Crawler - Possui remessa do CNAB de Pagamentos pelo Crawler [S/N]"},"cwr_pagret":{"type":"string","description":"Crawler - Possui retorno do CNAB de Pagamentos pelo Crawler [S/N]"},"cwr_extr":{"type":"string","description":"Crawler - Possui retorno do Extrato da Conta Corrente pelo Crawler [S/N]"},"obank_sn":{"type":"string","description":"Possui integração automática com banco via API [S/N]"},"obank_cobr":{"type":"string","description":"Possui integração dos boletos de cobrança via API [S/N]"},"obank_extr":{"type":"string","description":"Possui integração dos extratos bancários via API [S/N]"},"obank_pagt":{"type":"string","description":"Possui integração dos pagamentos via API [S/N]"},"obank_pix":{"type":"string","description":"Possui integração do PIX via API [S/N]"},"cod_compen":{"type":"string","description":"Código da Instituição Bancária para Compensação"},"cod_ispb":{"type":"string","description":"Código Identificador do Sistema de Pagamento Brasileiro"},"descond_sn":{"type":"string","description":"Possui Desconto Condicional [S/N]"},"descond_qt":{"type":"integer","description":"Quantidade de Descontos Condicionais permitidos para o Banco"},"entf_cnpj":{"type":"string","description":"CNPJ da instituição financeira de pagamento."},"codigo":{"type":"string","description":"Código do Banco / Instituição Financeira"},"nome":{"type":"string","description":"Nome do Banco"},"tipo":{"type":"string","description":"Tipo da Conta Corrente (CB Conta Bancária, CX Caixinha, CV Carteira Virtual ou AC Administradora de Cartões)"}},"title":"ConsultarBanco (retorno)"},"geral_bancos_ListarBancos":{"type":"object","title":"ListarBancos","description":"Exibe uma lista com os banco cadastrados.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarBancos"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"tipo":{"type":"string","maxLength":2,"description":"Tipo da Conta Corrente (CB Conta Bancária, CX Caixinha, CV Carteira Virtual ou AC Administradora de Cartões)"},"nome":{"type":"string","maxLength":40,"description":"Nome do Banco"},"apenas_importado_api":{"type":"string","maxLength":1,"description":"DEPRECATED"},"ordenar_por":{"type":"string","maxLength":100,"description":"DEPRECATED"},"ordem_descrescente":{"type":"string","maxLength":1,"description":"DEPRECATED"}}}}},"example":{"call":"ListarBancos","param":[{"pagina":1,"registros_por_pagina":100}]}},"geral_bancos_ListarBancos_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada"},"total_de_paginas":{"type":"integer","description":"Número total de páginas"},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"total de registros encontrados"},"fin_banco_cadastro":{"type":"array","items":{"type":"object","properties":{"cnab_altve":{"type":"string","description":"CNAB - Permite a Alteração do Vencimento da Cobrança"},"cnab_altvl":{"type":"string","description":"CNAB - Permite a Alteração do Valor da Cobrança"},"cnab_cob":{"type":"string","description":"CNAB - Remessa de Cobrança [S/N]"},"cnab_pag":{"type":"string","description":"CNAB - Remessa de Pagamento [S/N]"},"crawler_sn":{"type":"string","description":"Crawler - Possui integração automática com o Crawler [S/N]"},"cwr_cobrem":{"type":"string","description":"Crawler - Possui remessa do CNAB de Cobrança pelo Crawler [S/N]"},"cwr_cobret":{"type":"string","description":"Crawler - Possui retorno do CNAB de Cobrança pelo Crawler [S/N]"},"cwr_pagrem":{"type":"string","description":"Crawler - Possui remessa do CNAB de Pagamentos pelo Crawler [S/N]"},"cwr_pagret":{"type":"string","description":"Crawler - Possui retorno do CNAB de Pagamentos pelo Crawler [S/N]"},"cwr_extr":{"type":"string","description":"Crawler - Possui retorno do Extrato da Conta Corrente pelo Crawler [S/N]"},"obank_sn":{"type":"string","description":"Possui integração automática com banco via API [S/N]"},"obank_cobr":{"type":"string","description":"Possui integração dos boletos de cobrança via API [S/N]"},"obank_extr":{"type":"string","description":"Possui integração dos extratos bancários via API [S/N]"},"obank_pagt":{"type":"string","description":"Possui integração dos pagamentos via API [S/N]"},"obank_pix":{"type":"string","description":"Possui integração do PIX via API [S/N]"},"cod_compen":{"type":"string","description":"Código da Instituição Bancária para Compensação"},"cod_ispb":{"type":"string","description":"Código Identificador do Sistema de Pagamento Brasileiro"},"descond_sn":{"type":"string","description":"Possui Desconto Condicional [S/N]"},"descond_qt":{"type":"integer","description":"Quantidade de Descontos Condicionais permitidos para o Banco"},"entf_cnpj":{"type":"string","description":"CNPJ da instituição financeira de pagamento."},"codigo":{"type":"string","description":"Código do Banco / Instituição Financeira"},"nome":{"type":"string","description":"Nome do Banco"},"tipo":{"type":"string","description":"Tipo da Conta Corrente (CB Conta Bancária, CX Caixinha, CV Carteira Virtual ou AC Administradora de Cartões)"}}},"description":"Cadastro de bancos / instituições financeiras."}},"title":"ListarBancos (retorno)"},"geral_bandeiracartao_ListarBandeiras":{"type":"object","title":"ListarBandeiras","description":"Executa a listagem de bandeiras dos cartões.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarBandeiras"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Número de registros por página."}}}}},"example":{"call":"ListarBandeiras","param":[{"nPagina":1,"nRegPorPagina":50}]}},"geral_bandeiracartao_ListarBandeiras_retorno":{"type":"object","properties":{"nRegistros":{"type":"integer","description":"Número de registros."},"nPagina":{"type":"integer","description":"Número da página."},"nTotPaginas":{"type":"integer","description":"Número total de páginas."},"nTotRegistros":{"type":"integer","description":"Número total de registros."},"listaBandeira":{"type":"array","items":{"type":"object","properties":{"cCodigo":{"type":"string","description":"Código da bandeira"},"cDescricao":{"type":"string","description":"Descrição da bandeira do cartão."}}},"description":"Código e descrição."}},"title":"ListarBandeiras (retorno)"},"geral_caracteristicas_AlterarCaracteristica":{"type":"object","title":"AlterarCaracteristica","description":"Altera uma característica de produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarCaracteristica"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodCaract":{"type":"integer","maxLength":15,"description":"Código da característica de produto.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno da característica do produto gerado pelo Omie."},"cCodIntCaract":{"type":"string","maxLength":60,"description":"Código de integração da característica do produto.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código da característica utilizado no seu aplicativo quando incluir uma característica no Omie.\nAssim, poderá utilizar esse campo para resgatar as informações da característica desejada.\nCaso informe esse campo, não informe a tag nCodCaract. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"cNomeCaract":{"type":"string","maxLength":30,"description":"Nome da característica.\n(Não será permitida a inclusão de mais de uma característica com a mesma descrição."},"cValorDef":{"type":"string","maxLength":1,"example":"S","description":"Definir os conteúdos possíveis para essa característica (S/N).\n\nComo padrão o valor é \"N\"."},"conteudosPermitidos":{"type":"array","items":{"type":"object","properties":{"cConteudo":{"type":"string","description":"Descrição do conteúdo da característica."},"nIdConteudo":{"type":"integer","maxLength":15,"description":"Id do do Conteúdo/valor da característica."}}}}},"required":["cNomeCaract"]}}},"example":{"call":"AlterarCaracteristica","param":[{"nCodCaract":0,"cCodIntCaract":"","cNomeCaract":""}]}},"geral_caracteristicas_AlterarCaracteristica_retorno":{"type":"object","properties":{"nCodCaract":{"type":"integer","description":"Código da característica de produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da característica do produto gerado pelo Omie."},"cCodIntCaract":{"type":"string","description":"Código de integração da característica do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código da característica utilizado no seu aplicativo quando incluir uma característica no Omie. Assim, poderá utilizar esse campo para resgatar as informações da característica desejada. Caso informe esse campo, não informe a tag nCodCaract. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro duranteo o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodigoStatus\"."}},"title":"AlterarCaracteristica (retorno)"},"geral_caracteristicas_ConsultarCaracteristica":{"type":"object","title":"ConsultarCaracteristica","description":"Consulta uma característica de produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarCaracteristica"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodCaract":{"type":"integer","maxLength":15,"description":"Código da característica de produto.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno da característica do produto gerado pelo Omie."},"cCodIntCaract":{"type":"string","maxLength":60,"description":"Código de integração da característica do produto.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código da característica utilizado no seu aplicativo quando incluir uma característica no Omie.\nAssim, poderá utilizar esse campo para resgatar as informações da característica desejada.\nCaso informe esse campo, não informe a tag nCodCaract. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."}}}}},"example":{"call":"ConsultarCaracteristica","param":[{"nCodCaract":0,"cCodIntCaract":""}]}},"geral_caracteristicas_ConsultarCaracteristica_retorno":{"type":"object","properties":{"nCodCaract":{"type":"integer","description":"Código da característica de produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da característica do produto gerado pelo Omie."},"cCodIntCaract":{"type":"string","description":"Código de integração da característica do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código da característica utilizado no seu aplicativo quando incluir uma característica no Omie. Assim, poderá utilizar esse campo para resgatar as informações da característica desejada. Caso informe esse campo, não informe a tag nCodCaract. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"cNomeCaract":{"type":"string","description":"Nome da característica. (Não será permitida a inclusão de mais de uma característica com a mesma descrição."},"conteudosPermitidos":{"type":"array","items":{"type":"object","properties":{"cConteudo":{"type":"string","description":"Descrição do conteúdo da característica."},"nIdConteudo":{"type":"integer","description":"Id do do Conteúdo/valor da característica."}}}},"info":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão. No formato dd/mm/aaaa."},"hInc":{"type":"string","description":"Hora da Inclusão. No formato hh:mm:ss."},"uInc":{"type":"string","description":"Usuário da Inclusão."},"dAlt":{"type":"string","description":"Data da Alteração. No formato dd/mm/aaaa."},"hAlt":{"type":"string","description":"Hora da Alteração. No formato hh:mm:ss."},"uAlt":{"type":"string","description":"Usuário da Alteração."},"cImpAPI":{"type":"string","description":"Importado pela API (S/N)."}},"description":"Informações complementares da característica do produto."}},"title":"ConsultarCaracteristica (retorno)"},"geral_caracteristicas_ExcluirCaracteristica":{"type":"object","title":"ExcluirCaracteristica","description":"Exclui uma característica de produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirCaracteristica"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodCaract":{"type":"integer","maxLength":15,"description":"Código da característica de produto.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno da característica do produto gerado pelo Omie."},"cCodIntCaract":{"type":"string","maxLength":60,"description":"Código de integração da característica do produto.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código da característica utilizado no seu aplicativo quando incluir uma característica no Omie.\nAssim, poderá utilizar esse campo para resgatar as informações da característica desejada.\nCaso informe esse campo, não informe a tag nCodCaract. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."}}}}},"example":{"call":"ExcluirCaracteristica","param":[{"nCodCaract":0,"cCodIntCaract":""}]}},"geral_caracteristicas_ExcluirCaracteristica_retorno":{"type":"object","properties":{"nCodCaract":{"type":"integer","description":"Código da característica de produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da característica do produto gerado pelo Omie."},"cCodIntCaract":{"type":"string","description":"Código de integração da característica do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código da característica utilizado no seu aplicativo quando incluir uma característica no Omie. Assim, poderá utilizar esse campo para resgatar as informações da característica desejada. Caso informe esse campo, não informe a tag nCodCaract. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro duranteo o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodigoStatus\"."}},"title":"ExcluirCaracteristica (retorno)"},"geral_caracteristicas_IncluirCaracteristica":{"type":"object","title":"IncluirCaracteristica","description":"Inclui uma característica de produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirCaracteristica"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cCodIntCaract":{"type":"string","maxLength":60,"description":"Código de integração da característica do produto.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código da característica utilizado no seu aplicativo quando incluir uma característica no Omie.\nAssim, poderá utilizar esse campo para resgatar as informações da característica desejada.\nCaso informe esse campo, não informe a tag nCodCaract. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"cNomeCaract":{"type":"string","maxLength":30,"description":"Nome da característica.\n(Não será permitida a inclusão de mais de uma característica com a mesma descrição."},"cValorDef":{"type":"string","maxLength":1,"example":"S","description":"Definir os conteúdos possíveis para essa característica (S/N).\n\nComo padrão o valor é \"N\"."},"conteudosPermitidos":{"type":"array","items":{"type":"object","properties":{"cConteudo":{"type":"string","description":"Descrição do conteúdo da característica."},"nIdConteudo":{"type":"integer","maxLength":15,"description":"Id do do Conteúdo/valor da característica."}}}}},"required":["cCodIntCaract","cNomeCaract"]}}},"example":{"call":"IncluirCaracteristica","param":[{"cCodIntCaract":"CPROD1790776558","cNomeCaract":""}]}},"geral_caracteristicas_IncluirCaracteristica_retorno":{"type":"object","properties":{"nCodCaract":{"type":"integer","description":"Código da característica de produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da característica do produto gerado pelo Omie."},"cCodIntCaract":{"type":"string","description":"Código de integração da característica do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código da característica utilizado no seu aplicativo quando incluir uma característica no Omie. Assim, poderá utilizar esse campo para resgatar as informações da característica desejada. Caso informe esse campo, não informe a tag nCodCaract. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro duranteo o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodigoStatus\"."}},"title":"IncluirCaracteristica (retorno)"},"geral_caracteristicas_ListarCaracteristicas":{"type":"object","title":"ListarCaracteristicas","description":"Listar as características de produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarCaracteristicas"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página que se deseja resgatar.\nO padrão é \"1\"."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Número de registros retornados por página.\nO padrão é 20.\nO limite máximo é 50 por página."},"cOrdenarPor":{"type":"string","maxLength":100,"description":"Ordem os resultados da página por:\nCODIGO - Código do Característica.\nCODINT - Código de Integração da Característica.\nNOME - Nome da Característica."},"cOrdemDecrescente":{"type":"string","maxLength":1,"description":"Indica se a ordem de exibição é Decrescente caso seja informado \"S\"."},"dDtIncDe":{"type":"string","maxLength":10,"description":"Data de inclusão inicial.\nNo formato dd/mm/aaaa."},"dDtIncAte":{"type":"string","maxLength":10,"description":"Data de inclusão final.\nNo formato dd/mm/aaaa."},"dDtAltDe":{"type":"string","maxLength":10,"description":"Data de alteração inicial.\nNo formato dd/mm/aaaa."},"dDtAltAte":{"type":"string","maxLength":10,"description":"Data de alteração final.\nNo formato dd/mm/aaaa."}}}}},"example":{"call":"ListarCaracteristicas","param":[{"nPagina":1,"nRegPorPagina":50}]}},"geral_caracteristicas_ListarCaracteristicas_retorno":{"type":"object","properties":{"nPagina":{"type":"integer","description":"Número da página resgatada."},"nTotPaginas":{"type":"integer","description":"Número total de páginas encontradas."},"nRegistros":{"type":"integer","description":"Número de registros retornados na página."},"nTotRegistros":{"type":"integer","description":"Número total de registros encontrados."},"listaCaracteristicas":{"type":"array","items":{"type":"object","properties":{"nCodCaract":{"type":"integer","description":"Código da característica de produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da característica do produto gerado pelo Omie."},"cCodIntCaract":{"type":"string","description":"Código de integração da característica do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código da característica utilizado no seu aplicativo quando incluir uma característica no Omie. Assim, poderá utilizar esse campo para resgatar as informações da característica desejada. Caso informe esse campo, não informe a tag nCodCaract. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"cNomeCaract":{"type":"string","description":"Nome da característica. (Não será permitida a inclusão de mais de uma característica com a mesma descrição."},"conteudosPermitidos":{"type":"array","items":{"type":"object","properties":{"cConteudo":{"type":"string","description":"Descrição do conteúdo da característica."},"nIdConteudo":{"type":"integer","description":"Id do do Conteúdo/valor da característica."}}}},"info":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão. No formato dd/mm/aaaa."},"hInc":{"type":"string","description":"Hora da Inclusão. No formato hh:mm:ss."},"uInc":{"type":"string","description":"Usuário da Inclusão."},"dAlt":{"type":"string","description":"Data da Alteração. No formato dd/mm/aaaa."},"hAlt":{"type":"string","description":"Hora da Alteração. No formato hh:mm:ss."},"uAlt":{"type":"string","description":"Usuário da Alteração."},"cImpAPI":{"type":"string","description":"Importado pela API (S/N)."}},"description":"Informações complementares da característica do produto."}}},"description":"Lista de características de produto."}},"title":"ListarCaracteristicas (retorno)"},"geral_categorias_AlterarCategoria":{"type":"object","title":"AlterarCategoria","description":"Alteração de categoria.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarCategoria"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo":{"type":"string","maxLength":20,"description":"Código para a Categoria.\n\nInformação obrigatória para o método AlterarCategoria e AlterarGrupoCategoria."},"descricao":{"type":"string","maxLength":50,"description":"Descrição para a Categoria\n\nInformação obrigatória para os métodos IncluirCategoria e IncluirGrupoCategoria."},"natureza":{"type":"string","maxLength":50,"description":"Descrição da Natureza da conta."},"tipo_categoria":{"type":"string","maxLength":3,"description":"Tipo de gasto/receita realizado com esta categoria\n\nEssa informação pode ser obtida pela API:\n/api/v1/geral/tipocategoria/\nUtilizando o método ListarTipoCategoria, o código é retornado na tag \"cCodigo\"\nPara que esse código seja válido, é necessário que:\nInclusão:\n- \"categoria_superior\" começar com \"1\", então \"cTipo\" deve ser igual a \"R\"\n- \"categoria_superior\" começar com \"2\", então \"cTipo\" deve ser igual a \"P\"\n\nAlteração:\n- \"codigo\" começar com \"1\", então \"cTipo\" deve ser igual a \"R\"\n- \"codigo\" começar com \"2\", então \"cTipo\" deve ser igual a \"P\"."},"codigo_dre":{"type":"string","maxLength":10,"description":"Código no DRE (Demonstrativo de Resultados do Exercício)\n\nEssa informação pode ser obtida pela API:\n/api/v1/geral/dre/\nUtilizando o método ListarCadastroDRE, o código é retornado na tag \"codigoDRE\"\nPara que esse código seja válido, é necessário que:\n- \"nivelDRE\" seja igual a 3\n- \"naoExibirDRE\" seja igual a \"N\"\n- \"totalizaDRE\" seja igual a \"N\"."},"conta_inativa":{"type":"string","maxLength":1,"description":"Indica que a categoria ou grupo de categoria está inativo."}},"required":["codigo","descricao"]}}},"example":{"call":"AlterarCategoria","param":[{"codigo":"","descricao":"","natureza":"","tipo_categoria":"","codigo_dre":"","conta_inativa":""}]}},"geral_categorias_AlterarCategoria_retorno":{"type":"object","properties":{"codigo_status":{"type":"string"},"descricao_status":{"type":"string"},"codigo":{"type":"string","description":"Código da categoria."}},"title":"AlterarCategoria (retorno)"},"geral_categorias_AlterarGrupoCategoria":{"type":"object","title":"AlterarGrupoCategoria","description":"Alteração de um grupo totalizador de categoria.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarGrupoCategoria"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo":{"type":"string","maxLength":20,"description":"Código para a Categoria.\n\nInformação obrigatória para o método AlterarCategoria e AlterarGrupoCategoria."},"descricao":{"type":"string","maxLength":50,"description":"Descrição para a Categoria\n\nInformação obrigatória para os métodos IncluirCategoria e IncluirGrupoCategoria."},"natureza":{"type":"string","maxLength":50,"description":"Descrição da Natureza da conta."}},"required":["codigo","descricao"]}}},"example":{"call":"AlterarGrupoCategoria","param":[{"codigo":"","descricao":"","natureza":""}]}},"geral_categorias_AlterarGrupoCategoria_retorno":{"type":"object","properties":{"codigo_status":{"type":"string"},"descricao_status":{"type":"string"},"codigo":{"type":"string","description":"Código da categoria."}},"title":"AlterarGrupoCategoria (retorno)"},"geral_categorias_ConsultarCategoria":{"type":"object","title":"ConsultarCategoria","description":"Consulta uma categoria.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarCategoria"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo":{"type":"string","maxLength":20,"description":"Código da categoria."}},"required":["codigo"]}}},"example":{"call":"ConsultarCategoria","param":[{"codigo":""}]}},"geral_categorias_ConsultarCategoria_retorno":{"type":"object","properties":{"codigo":{"type":"string","description":"Código para a Categoria. Informação obrigatória para o método AlterarCategoria."},"descricao":{"type":"string","description":"Descrição para a Categoria Informação obrigatória para os métodos IncluirCategoria e IncluirGrupoCategoria."},"descricao_padrao":{"type":"string","description":"Descrição Padrão para a Categoria."},"tipo_categoria":{"type":"string","description":"Tipo de gasto/receita realizado com esta categoria Para inclusão ou alteração essa informação pode ser obtida pela API: /api/v1/geral/tipocategoria/ Utilizando o método ListarTipoCategoria, o código é retornado na tag \"cCodigo\" Para que esse código seja válido, é necessário que: Inclusão: - \"categoria_superior\" começar com \"1\", então \"cTipo\" deve ser igual a \"R\" - \"categoria_superior\" começar com \"2\", então \"cTipo\" deve ser igual a \"P\" Alteração: - \"codigo\" começar com \"1\", então \"cTipo\" deve ser igual a \"R\" - \"codigo\" começar com \"2\", então \"cTipo\" deve ser igual a \"P\"."},"conta_inativa":{"type":"string","description":"Indica que a categoria ou grupo de categoria está inativo."},"definida_pelo_usuario":{"type":"string","description":"Indica que a conta financeira é definida pelo usuário."},"id_conta_contabil":{"type":"integer","description":"ID da Conta Contábil."},"tag_conta_contabil":{"type":"string","description":"Tag para Conta Contábil."},"conta_despesa":{"type":"string","description":"Quando S, indica que é conta de despesa."},"conta_receita":{"type":"string","description":"Quando S, indica que é conta de receita."},"nao_exibir":{"type":"string","description":"Indica que a Categoria não deve ser exibida em ComboBox."},"natureza":{"type":"string","description":"Descrição da Natureza da conta, equivalente ao campo \"Observação\" da categoria no ERP."},"totalizadora":{"type":"string","description":"Quando S, indica que é totalizadora de conta."},"transferencia":{"type":"string","description":"Quando S, indica que é categoria de transferência."},"codigo_dre":{"type":"string","description":"Código no DRE (Demonstrativo de Resultados do Exercício) Para inclusão ou alteração essa informação pode ser obtida pela API: /api/v1/geral/dre/ Utilizando o método ListarCadastroDRE, o código é retornado na tag \"codigoDRE\" Para que esse código seja válido, é necessário que: - \"nivelDRE\" seja igual a 3 - \"naoExibirDRE\" seja igual a \"N\" - \"totalizaDRE\" seja igual a \"N\"."},"categoria_superior":{"type":"string","description":"Código do grupo da categoria Para inclusão essa informação pode ser obtida pela API: /api/v1/geral/categorias/ Utilizando o método ListarCategorias, o código é retornado na tag \"codigo\" Para que esse código seja válido, é necessário que: - \"codigo\" tenha 4 dígitos - \"totalizadora\" deve ser igual a \"S\"."},"dadosDRE":{"type":"object","properties":{"codigoDRE":{"type":"string","description":"Código da Conta do DRE."},"descricaoDRE":{"type":"string","description":"Descrição da Conta do DRE."},"naoExibirDRE":{"type":"string","description":"Indica se a Conta está marcada para não exibir no DRE."},"nivelDRE":{"type":"integer","description":"Nível da Conta da DRE."},"sinalDRE":{"type":"string","description":"Sinal da Conta para o DRE."},"totalizaDRE":{"type":"string","description":"Indica se a Conta do DRE é Totalizadora."}},"description":"Detalhes da conta do DRE."}},"title":"ConsultarCategoria (retorno)"},"geral_categorias_IncluirCategoria":{"type":"object","title":"IncluirCategoria","description":"Inclusão de categoria.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirCategoria"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"categoria_superior":{"type":"string","description":"Código do grupo da categoria\n\nPara inclusão essa informação pode ser obtida pela API:\n/api/v1/geral/categorias/\n\nUtilizando o método ListarCategorias, o código é retornado na tag \"codigo\"\nPara que esse código seja válido, é necessário que:\n- \"codigo\" tenha 4 dígitos\n- \"totalizadora\" deve ser igual a \"S\"."},"descricao":{"type":"string","maxLength":50,"description":"Descrição para a Categoria\n\nInformação obrigatória para os métodos IncluirCategoria e IncluirGrupoCategoria."},"natureza":{"type":"string","maxLength":50,"description":"Descrição da Natureza da conta, equivalente ao campo \"Observação\" da categoria no ERP."},"tipo_categoria":{"type":"string","maxLength":3,"description":"Tipo de gasto/receita realizado com esta categoria\n\nEssa informação pode ser obtida pela API:\n/api/v1/geral/tipocategoria/\nUtilizando o método ListarTipoCategoria, o código é retornado na tag \"cCodigo\"\nPara que esse código seja válido, é necessário que:\nInclusão:\n- \"categoria_superior\" começar com \"1\", então \"cTipo\" deve ser igual a \"R\"\n- \"categoria_superior\" começar com \"2\", então \"cTipo\" deve ser igual a \"P\"\n\nAlteração:\n- \"codigo\" começar com \"1\", então \"cTipo\" deve ser igual a \"R\"\n- \"codigo\" começar com \"2\", então \"cTipo\" deve ser igual a \"P\"."},"codigo_dre":{"type":"string","maxLength":10,"description":"Código no DRE (Demonstrativo de Resultados do Exercício)\n\nEssa informação pode ser obtida pela API:\n/api/v1/geral/dre/\nUtilizando o método ListarCadastroDRE, o código é retornado na tag \"codigoDRE\"\nPara que esse código seja válido, é necessário que:\n- \"nivelDRE\" seja igual a 3\n- \"naoExibirDRE\" seja igual a \"N\"\n- \"totalizaDRE\" seja igual a \"N\"."}},"required":["categoria_superior","descricao"]}}},"example":{"call":"IncluirCategoria","param":[{"categoria_superior":"","descricao":"","natureza":"","tipo_categoria":"","codigo_dre":""}]}},"geral_categorias_IncluirCategoria_retorno":{"type":"object","properties":{"codigo_status":{"type":"string"},"descricao_status":{"type":"string"},"codigo":{"type":"string","description":"Código da categoria."}},"title":"IncluirCategoria (retorno)"},"geral_categorias_IncluirGrupoCategoria":{"type":"object","title":"IncluirGrupoCategoria","description":"Inclusão de um grupo totalizador de categoria.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirGrupoCategoria"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"descricao":{"type":"string","maxLength":50,"description":"Descrição para a Categoria\n\nInformação obrigatória para os métodos IncluirCategoria e IncluirGrupoCategoria."},"tipo_grupo":{"type":"string","maxLength":1,"description":"Tipo de grupo de categorias ( R = Receita ou D = Despesa ).\n\nInformação obrigatória para o método IncluirGrupoCategoria."},"natureza":{"type":"string","maxLength":50,"description":"Descrição da Natureza da conta."}},"required":["descricao","tipo_grupo"]}}},"example":{"call":"IncluirGrupoCategoria","param":[{"descricao":"","tipo_grupo":"","natureza":""}]}},"geral_categorias_IncluirGrupoCategoria_retorno":{"type":"object","properties":{"codigo_status":{"type":"string"},"descricao_status":{"type":"string"},"codigo":{"type":"string","description":"Código da categoria."}},"title":"IncluirGrupoCategoria (retorno)"},"geral_categorias_ListarCategorias":{"type":"object","title":"ListarCategorias","description":"Lista as categorias cadastradas.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarCategorias"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"apenas_importado_api":{"deprecated":true,"type":"string","maxLength":1,"description":"DEPRECATED"},"ordenar_por":{"deprecated":true,"type":"string","maxLength":100,"description":"DEPRECATED"},"ordem_descrescente":{"deprecated":true,"type":"string","maxLength":1,"description":"DEPRECATED"},"filtrar_apenas_ativo":{"type":"string","maxLength":1,"description":"Filtrar apenas categorias ativas."},"filtrar_por_tipo":{"type":"string","maxLength":1,"description":"Filtrar categorias por tipo\n\nPode ser:\nR - Receita\nD - Despesa\n\nRetorna apenas as categorias ativas, não totalizadoras e que estejam configuradas para serem exibidas."},"descricao":{"type":"string","maxLength":50}}}}},"example":{"call":"ListarCategorias","param":[{"pagina":1,"registros_por_pagina":50,"descricao":""}]}},"geral_categorias_ListarCategorias_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada."},"total_de_paginas":{"type":"integer","description":"Número total de páginas."},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"Total de registros encontrados."},"categoria_cadastro":{"type":"array","items":{"type":"object","properties":{"codigo":{"type":"string","description":"Código para a Categoria. Informação obrigatória para o método AlterarCategoria."},"descricao":{"type":"string","description":"Descrição para a Categoria Informação obrigatória para os métodos IncluirCategoria e IncluirGrupoCategoria."},"descricao_padrao":{"type":"string","description":"Descrição Padrão para a Categoria."},"tipo_categoria":{"type":"string","description":"Tipo de gasto/receita realizado com esta categoria Para inclusão ou alteração essa informação pode ser obtida pela API: /api/v1/geral/tipocategoria/ Utilizando o método ListarTipoCategoria, o código é retornado na tag \"cCodigo\" Para que esse código seja válido, é necessário que: Inclusão: - \"categoria_superior\" começar com \"1\", então \"cTipo\" deve ser igual a \"R\" - \"categoria_superior\" começar com \"2\", então \"cTipo\" deve ser igual a \"P\" Alteração: - \"codigo\" começar com \"1\", então \"cTipo\" deve ser igual a \"R\" - \"codigo\" começar com \"2\", então \"cTipo\" deve ser igual a \"P\"."},"conta_inativa":{"type":"string","description":"Indica que a categoria ou grupo de categoria está inativo."},"definida_pelo_usuario":{"type":"string","description":"Indica que a conta financeira é definida pelo usuário."},"id_conta_contabil":{"type":"integer","description":"ID da Conta Contábil."},"tag_conta_contabil":{"type":"string","description":"Tag para Conta Contábil."},"conta_despesa":{"type":"string","description":"Quando S, indica que é conta de despesa."},"conta_receita":{"type":"string","description":"Quando S, indica que é conta de receita."},"nao_exibir":{"type":"string","description":"Indica que a Categoria não deve ser exibida em ComboBox."},"natureza":{"type":"string","description":"Descrição da Natureza da conta, equivalente ao campo \"Observação\" da categoria no ERP."},"totalizadora":{"type":"string","description":"Quando S, indica que é totalizadora de conta."},"transferencia":{"type":"string","description":"Quando S, indica que é categoria de transferência."},"codigo_dre":{"type":"string","description":"Código no DRE (Demonstrativo de Resultados do Exercício) Para inclusão ou alteração essa informação pode ser obtida pela API: /api/v1/geral/dre/ Utilizando o método ListarCadastroDRE, o código é retornado na tag \"codigoDRE\" Para que esse código seja válido, é necessário que: - \"nivelDRE\" seja igual a 3 - \"naoExibirDRE\" seja igual a \"N\" - \"totalizaDRE\" seja igual a \"N\"."},"categoria_superior":{"type":"string","description":"Código do grupo da categoria Para inclusão essa informação pode ser obtida pela API: /api/v1/geral/categorias/ Utilizando o método ListarCategorias, o código é retornado na tag \"codigo\" Para que esse código seja válido, é necessário que: - \"codigo\" tenha 4 dígitos - \"totalizadora\" deve ser igual a \"S\"."},"dadosDRE":{"type":"object","properties":{"codigoDRE":{"type":"string","description":"Código da Conta do DRE."},"descricaoDRE":{"type":"string","description":"Descrição da Conta do DRE."},"naoExibirDRE":{"type":"string","description":"Indica se a Conta está marcada para não exibir no DRE."},"nivelDRE":{"type":"integer","description":"Nível da Conta da DRE."},"sinalDRE":{"type":"string","description":"Sinal da Conta para o DRE."},"totalizaDRE":{"type":"string","description":"Indica se a Conta do DRE é Totalizadora."}},"description":"Detalhes da conta do DRE."}}},"description":"Cadastro de Categorias."}},"title":"ListarCategorias (retorno)"},"geral_cenarios_ListarCenarios":{"type":"object","title":"ListarCenarios","description":"Lista os cenários de impostos.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarCenarios"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15},"nRegPorPagina":{"type":"integer","maxLength":15},"cNome":{"type":"string","maxLength":50}}}}},"example":{"call":"ListarCenarios","param":[{"nPagina":1,"nRegPorPagina":20,"cNome":""}]}},"geral_cenarios_ListarCenarios_retorno":{"type":"object","properties":{"nPagina":{"type":"integer"},"nTotPaginas":{"type":"integer"},"nRegistros":{"type":"integer"},"nTotRegistros":{"type":"integer"},"cenariosEncontrados":{"type":"array","items":{"type":"object","properties":{"nCodigo":{"type":"integer","description":"Código do Cenário de Impostos."},"cNome":{"type":"string","description":"Nome do Cenário de Impostos."},"padrao":{"type":"boolean","description":"Indica se o Cenário de Impostos é padrão."},"industria":{"type":"string","description":"Indica se o cenário se aplica a Indústria."},"comercioVarejista":{"type":"string","description":"Indica se o Cenário de Impostos se aplica ao Comércio (Varejista)."},"comercioAtacadista":{"type":"boolean","description":"Indica se o Cenário de Impostos se aplica ao Comércio (Atacadista)."},"prestadorServico":{"type":"boolean","description":"Indica se o Cenário de Impostos se aplica a Prestação de Serviço."},"construcaoCivil":{"type":"boolean","description":"Indica se o Cenário de Impostos se aplica a Construção Civil."},"inativo":{"type":"string","description":"Indica se o cenário está inativo [S/N]."},"dInc":{"type":"string","description":"Data de Inclusão."},"hInc":{"type":"string","description":"Hora de inclusão."},"uInc":{"type":"string","description":"Código do usuário que realizou a inclusão."},"dAlt":{"type":"string","description":"Data de alteração."},"hAlt":{"type":"string","description":"Hora de alteração."},"uAlt":{"type":"string","description":"Código do usuário que realizou a alteração."}}},"description":"Lista de Cenários de Impostos encontrados."}},"title":"ListarCenarios (retorno)"},"geral_cenarios_ListarImpostosCenario":{"type":"object","title":"ListarImpostosCenario","description":"Lista os impostos do cenário e produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarImpostosCenario"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_cliente_omie":{"type":"integer","maxLength":15,"description":"Código Omie para o cliente."},"codigo_cliente_integracao":{"type":"string","maxLength":60,"description":"Código de Integração para o Cliente."},"consumo_final":{"type":"string","maxLength":1,"description":"Indica se a operação é uma venda para consumo final."},"codigo":{"type":"string","maxLength":60,"description":"É o código do produto que é exibido na tela do Omie.\nNão utilize esse código para realizar a integração, ele tem função apenas informativa para o usuário e pode ser alterado a qualquer momento."},"codigo_produto":{"type":"integer","maxLength":15,"description":"(Código interno utilizado apenas na API).\nEsse código não aparece na tela do Omie.\nUtilize esse código para identificar um produto via API, para obter uma melhor performance.\nOpcionalmente você pode informar o código de integração para localizar um produto através do campo \"codigo_produto_integracao\"."},"codigo_produto_integracao":{"type":"string","maxLength":60,"description":"Código de integração do produto.\n\n(Utilizado para integração via API)\nEsse código não aparece na tela do Omie."},"codigo_cenario":{"type":"integer","maxLength":15,"description":"Código do Cenário de Impostos."}}}}},"example":{"call":"ListarImpostosCenario","param":[{"codigo_cliente_integracao":"CLI00001","consumo_final":"N","codigo_produto_integracao":"PRD00001","codigo_cenario":152055}]}},"geral_cenarios_ListarImpostosCenario_retorno":{"type":"object","properties":{"codigo_empresa":{"type":"integer","description":"Código interno identificador da Empresa."},"codigo_cenario":{"type":"integer","description":"Código do Cenário de Impostos."},"codigo_cliente_omie":{"type":"integer","description":"Código interno de identificação do cliente."},"codigo_cliente_integracao":{"type":"string","description":"Código de Integração par ao cliente."},"codigo_produto":{"type":"integer","description":"(Código interno utilizado apenas na API). Esse código não aparece na tela do Omie. Utilize esse código para identificar um produto via API, para obter uma melhor performance."},"codigo_produto_integracao":{"type":"string","description":"Código de integração do produto. (Utilizado para integração via API) Esse código não aparece na tela do Omie."},"codigo":{"type":"string","description":"É o código do produto que é exibido na tela do Omie. Ele pode ser alterado a qualquer momento."},"ncm":{"type":"string","description":"NCM do produto utilizado na pesquisa."},"consumo_final":{"type":"string","description":"Indicação se a operação é uma venda para consumo final."},"uf_cliente":{"type":"string","description":"Estado onde o cliente está localizado."},"uf_empresa":{"type":"string","description":"Estado onde a Empresa está localizada."},"cnae_cliente":{"type":"string","description":"CNAE do cliente."},"contribuinte_cliente":{"type":"string","description":"Indicativo se o cliente é contribuinte."},"impostos":{"type":"object","properties":{"cfop":{"type":"string","description":"CFOP - Código Fiscal da Operação Fiscal configurado."},"inf_adicional_item":{"type":"string","description":"Informação adicional para o item no documento fiscal."},"inf_adicional_nf":{"type":"string","description":"Informação adicional para o documento fiscal."},"nao_gera_conta_receb":{"type":"string","description":"Indica que não deve gerar conta a receber para o item."},"nao_mov_estoque":{"type":"string","description":"Indica que não deve movimentar estoque."},"cst_icms":{"type":"string","description":"Código da Situação Tributária para o ICMS."},"modalidade_bc_icms":{"type":"string","description":"Modalidade da base de cálculo para o ICMS."},"reducao_bc_icms":{"type":"decimal","description":"Redução da base de cálculo de ICMS."},"aliquota_icms":{"type":"decimal","description":"Alíquota de ICMS."},"perc_diferimento_icms":{"type":"decimal","description":"Percentual de Diferimento de ICMS."},"motivo_desoneracao_icms":{"type":"string","description":"Motivo da Desoneração do ICMS."},"perc_fcp_icms":{"type":"decimal","description":"Percentual para o Fundo de Combate a Pobreza para o ICMS."},"csosn":{"type":"string","description":"CSOSN - Código da Situação da Operação do Simples Nacional."},"aliquota_icms_simples":{"type":"decimal","description":"Alíquota para cálculo do crédito do ICMS por empresa do Simples Nacional."},"modalidade_bc_st":{"type":"string","description":"Modalidade de cálculo para a base do ICMS-ST."},"margem_st":{"type":"decimal","description":"Margem de Valor Agregado para base de cálculo do ICMS-ST."},"aliquota_st":{"type":"decimal","description":"Alíquota do ICMS-ST."},"aliquota_icms_op":{"type":"decimal","description":"Alíquota do ICMS da operacação própria, para cálculo do ICMS-ST."},"carga_media_mt":{"type":"decimal","description":"Carga média para cálculo do ICMS-ST."},"reducao_bc_st":{"type":"decimal","description":"Redução da base de cálculo do ICMS-ST."},"zera_mva_cf":{"type":"string","description":"Indica que deve zerar o MVA na venda para consumo final."},"id_pauta_icms":{"type":"integer","description":"Código identificador do cadastro da pauta de ICMS."},"valor_pauta_icms":{"type":"decimal","description":"Valor da Pauta do ICMS-ST."},"perc_fcp_st":{"type":"decimal","description":"Percentual para o Fundo de Combate a Pobreza relativa ao ICMS-ST."},"al_icms_interes_destino":{"type":"decimal","description":"Alíquota para o ICMS interestadual para o estado de destino."},"al_icms_interestadual":{"type":"decimal","description":"Alíquota do ICMS próprio utilizada para o cálculo do ICMS interestadual."},"al_icms_interes_fcp":{"type":"decimal","description":"Alíquota para o fundo de combate a pobreza para o estado destino relativo ao ICMS Interestadual."},"al_icms_interes_partilha":{"type":"decimal","description":"Percentual de partilha do ICMS Interestadual."},"cst_ipi":{"type":"string","description":"Código da Situação Tributária para o IPI."},"tipo_calculo_ipi":{"type":"string","description":"Tipo de cálculo para o IPI."},"reducao_bc_ipi":{"type":"decimal","description":"Redução de base de cálculo para o IPI."},"aliquota_ipi":{"type":"decimal","description":"Alíquota do IPI."},"valor_trib_ipi":{"type":"decimal","description":"Valor tributável de IPI por unidade."},"enq_ipi":{"type":"string","description":"Enquadramento do IPI."},"cst_pis":{"type":"string","description":"Código da Situação Tributária do PIS."},"tipo_calculo_pis":{"type":"string","description":"Tipo do Cálculo do PIS."},"reducao_bc_pis":{"type":"decimal","description":"Redução de base de cálculo do PIS."},"aliquota_pis":{"type":"decimal","description":"Alíquota de PIS."},"valor_trib_pis":{"type":"decimal","description":"Valor tributável de PIS por unidade."},"margem_pis_st":{"type":"decimal","description":"Margem de cálculo para PIS-ST."},"aliquota_pis_st":{"type":"decimal","description":"Alíquota de PIS-ST."},"tipo_calculo_pis_st":{"type":"string","description":"Tipo de Cálculo para o PIS-ST."},"valor_trib_pis_st":{"type":"decimal","description":"Valor tributado de PIS-ST por unidade."},"cst_cofins":{"type":"string","description":"Código da Situação Tributária do PIS."},"tipo_calculo_cofins":{"type":"string","description":"Tipo do cálculo de COFINS."},"reducao_bc_cofins":{"type":"decimal","description":"Percentual de Redução de base de cálculo para COFINS."},"aliquota_cofins":{"type":"decimal","description":"Alíquota para o cálculo de COFINS."},"valor_trib_cofins":{"type":"decimal","description":"Valor tributado de COFINS por unidade."},"margem_cofins_st":{"type":"decimal","description":"Margem de Valor agregado para o cálculo do COFINS-ST."},"aliquota_cofins_st":{"type":"decimal","description":"Alíquota para o cálculo de COFINS-ST."},"tipo_calculo_cofins_st":{"type":"string","description":"Tipo de cálculo para o COFINS-ST."},"valor_trib_cofins_st":{"type":"decimal","description":"Valor tributário de COFINS-ST por unidade."},"cst_ibs_cbs":{"type":"string","description":"Código de Situação Tributária do IBS e CBS."},"class_trib":{"type":"string"},"aliquota_ibs_uf":{"type":"decimal","description":"Alíquota do IBS de competência das UF."},"perc_dif_ibs_uf":{"type":"decimal","description":"Percentual do Diferimento - IBS UF."},"perc_red_ibs_uf":{"type":"decimal","description":"Percentual da redução de alíquota do cClassTrib - IBS UF."},"aliquota_ibs_mu":{"type":"decimal","description":"Alíquota do IBS de competência do Município."},"perc_dif_ibs_mu":{"type":"decimal","description":"Percentual do diferimento - UBS Município."},"perc_red_ibs_mu":{"type":"decimal","description":"Percentual da redução de alíquota do cClassTrib - IBS Município."},"aliquota_cbs":{"type":"decimal","description":"Alíquota da CBS."},"perc_dif_cbs":{"type":"decimal","description":"Percentual do diferimento - CBS."},"perc_red_cbs":{"type":"decimal","description":"Percentual da redução de alíquota do cClassTrib - CBS."},"cst_reg_ibs_cst":{"type":"string","description":"Código da Situação Tributária Regular do IBS e CBS."},"class_trib_reg":{"type":"string","description":"Código de Classificação Tributária Regular do IBS e CBS."},"aliquota_reg_ibs_uf":{"type":"decimal","description":"Valor da alíquota Regular do IBS da UF."},"aliquota_reg_ibs_mu":{"type":"decimal","description":"Valor da alíquota Regular do IBS do Município."},"aliquota_reg_cbs":{"type":"decimal","description":"Valor da alíquota Regular da CBS."},"tipo_cred_prez":{"type":"string"}},"description":"Impostos do cenário fiscal para o produto e cliente."}},"title":"ListarImpostosCenario (retorno)"},"geral_cidades_PesquisarCidades":{"type":"object","title":"PesquisarCidades","description":"Obtém a lista das Cidades","required":["call","param"],"properties":{"call":{"type":"string","enum":["PesquisarCidades"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15},"registros_por_pagina":{"type":"integer","maxLength":15},"apenas_importado_api":{"type":"string","maxLength":1},"ordenar_por":{"type":"string","maxLength":100},"ordem_descrescente":{"type":"string","maxLength":1},"filtrar_por_data_de":{"type":"string","maxLength":10},"filtrar_por_data_ate":{"type":"string","maxLength":10},"filtrar_apenas_inclusao":{"type":"string","maxLength":1},"filtrar_apenas_alteracao":{"type":"string","maxLength":1},"filtrar_cidade_contendo":{"type":"string","maxLength":40},"filtrar_por_uf":{"type":"string","maxLength":2},"filtrar_por_cidade":{"type":"string","maxLength":40,"description":"Código da Cidade\n\nCódigo da Cidade ou Código IBGE."}}}}},"example":{"call":"PesquisarCidades","param":[{"pagina":1,"registros_por_pagina":50}]}},"geral_cidades_PesquisarCidades_retorno":{"type":"object","properties":{"pagina":{"type":"integer"},"total_de_paginas":{"type":"integer"},"registros":{"type":"integer"},"total_de_registros":{"type":"integer"},"lista_cidades":{"type":"array","items":{"type":"object","properties":{"cCod":{"type":"string","description":"Código da Cidade"},"cNome":{"type":"string","description":"Nome da Cidade"},"cUF":{"type":"string","description":"UF da cidade"},"nCodIBGE":{"type":"string","description":"Código IBGE da Cidade"},"nCodSIAFI":{"type":"integer","description":"Código SIAFI da Cidade"}}}}},"title":"PesquisarCidades (retorno)"},"geral_clienterestricao_ConsultarRestricao":{"type":"object","title":"ConsultarRestricao","description":"Consulta restrição de crédito de cliente.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarRestricao"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdCliente":{"type":"integer","maxLength":15,"description":"Código do cliente no Omie.\n\nInforme \"nIdCliente\" ou \"cCnpjCpf\", não os dois. Por nIdCliente, a consulta usa o CPF/CNPJ do cadastro do cliente."},"cCnpjCpf":{"type":"string","maxLength":20,"description":"CNPJ ou CPF a consultar, com ou sem formatação.\n\nInforme \"nIdCliente\" ou \"cCnpjCpf\", não os dois. Se nenhum cliente tiver esse documento, a consulta cria o cliente."},"cTipoConsulta":{"type":"string","maxLength":100,"description":"Tipo de consulta de restrição: o cCodigo de um item de tiposConsulta em ObterInfoRestricao.\n\nPara CPF: PF_BASIC, PF_ESSENCIAL, PF_POSITIVE, PF_PLUS ou PF_COMPLETE.\nPara CNPJ: PJ_BASIC, PJ_RISK, PJ_POSITIVE, PJ_BUSINESS ou PJ_LIMIT.\n\nCada tipo tem um valor, cobrado na fatura do aplicativo a cada consulta com sucesso."},"lForcarNovaConsulta":{"type":"boolean","description":"Forçar nova consulta de restrição?\n\nO preenchimento desta tag não é obrigatório. Caso não seja informada, assumirá o valor FALSE.\n\nInforme TRUE para forçar a execução de nova consulta de restrição (com cobrança) mesmo que já exista consulta com sucesso na data corrente para o mesmo CPF/CNPJ e o mesmo tipo.\n\nInforme FALSE para retornar a consulta do mesmo tipo já realizada hoje para o CPF/CNPJ, pelo mesmo usuário ou por integração, caso exista. Neste caso, não será gerada cobrança. Se não existir, uma nova consulta (com cobrança) será realizada automaticamente."}},"required":["cTipoConsulta","lForcarNovaConsulta"]}}},"example":{"call":"ConsultarRestricao","param":[{"cCnpjCpf":"11.222.333/0001-81","cTipoConsulta":"PJ_BASIC","lForcarNovaConsulta":false}]}},"geral_clienterestricao_ConsultarRestricao_retorno":{"type":"object","properties":{"cCodStatus":{"type":"string","description":"Código do status do processamento. \"0\" indica consulta realizada ou recuperada do histórico do dia. Outros valores: \"30\" serviço não ativado, \"100\" usuário de integração não autorizado, \"101\" falha na consulta (motivo em cDesStatus), \"403\" sem permissão, \"721\" CPF/CNPJ inválido, \"821\" cliente não encontrado, \"1000\" cliente não identificado."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Explica o resultado de \"cCodStatus\"."},"cUrlPesquisa":{"type":"string","description":"Link temporário para baixar o PDF da consulta de restrição."},"dPesquisa":{"type":"string","description":"Data em que a consulta foi realizada (dd/mm/aaaa)."},"hPesquisa":{"type":"string","description":"Hora em que a consulta foi realizada (hh:mm:ss)."},"cUsuario":{"type":"string","description":"Nome do usuário que realizou a consulta."},"cTipo":{"type":"string","description":"Tipo da consulta realizada, sem o prefixo de pessoa (ex.: BASIC, RISK, LIMIT)."},"cResultado":{"type":"string","description":"Resumo do resultado da consulta de restrição."}},"title":"ConsultarRestricao (retorno)"},"geral_clienterestricao_ObterInfoRestricao":{"type":"object","title":"ObterInfoRestricao","description":"","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterInfoRestricao"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdCliente":{"type":"integer","maxLength":15,"description":"Código do cliente no Omie.\n\nInforme uma das tags: \"nIdCliente\", \"cCnpjCpf\" ou \"xCodigo\". Por nIdCliente vem só o cadastro, sem os tipos de consulta."},"cCnpjCpf":{"type":"string","maxLength":20,"description":"CNPJ ou CPF do cliente, com ou sem formatação.\n\nInforme uma das tags: \"nIdCliente\", \"cCnpjCpf\" ou \"xCodigo\". Por CPF/CNPJ vêm também os tipos de consulta (PF ou PJ) e a última consulta."},"xCodigo":{"type":"string","description":"Busca livre: CPF/CNPJ (11 ou 14 dígitos) ou o início do nome fantasia ou da razão social. Traz até 50 clientes.\n\nNão pode ser usada junto com \"nIdCliente\" ou \"cCnpjCpf\"."}}}}},"example":{"call":"ObterInfoRestricao","param":[{"cCnpjCpf":"11.222.333/0001-81"}]}},"geral_clienterestricao_ObterInfoRestricao_retorno":{"type":"object","properties":{"listaClientes":{"type":"array","items":{"type":"object","properties":{"nIdCliente":{"type":"integer","description":"Código do cliente no Omie."},"cCnpjCpf":{"type":"string","description":"CNPJ ou CPF do cliente."},"cRazaoSocial":{"type":"string","description":"Razão social do cliente."},"cNomeFantasia":{"type":"string","description":"Nome fantasia do cliente; vem só para pessoa jurídica quando difere da razão social."},"cTipoPessoa":{"type":"string","description":"Tipo de pessoa do cliente: PF ou PJ."},"cTelefone":{"type":"string","description":"Telefone principal, com DDD entre parênteses quando cadastrado."},"cContato":{"type":"string","description":"Nome do contato."},"cEmail":{"type":"string","description":"E-mail do cliente."},"cEndereco":{"type":"string","description":"Logradouro."},"cNumero":{"type":"string","description":"Número do endereço."},"cComplemento":{"type":"string","description":"Complemento do endereço."},"cBairro":{"type":"string","description":"Bairro."},"cCidade":{"type":"string","description":"Cidade."},"cEstado":{"type":"string","description":"Sigla do estado."},"cCep":{"type":"string","description":"CEP."},"cCor":{"type":"string","description":"Não preenchido por esta API."},"cIcone":{"type":"string","description":"Não preenchido por esta API."}}},"description":"Clientes encontrados. Com mais de um, cCodStatus vem \"20\" para a pessoa escolher."},"listaTipoConsulta":{"type":"string","description":"Os mesmos tipos de consulta de tiposConsulta, em texto JSON (formato usado pela tela do ERP). Prefira tiposConsulta."},"ultimaConsulta":{"type":"object","properties":{"dPesquisa":{"type":"string","description":"Data da última consulta (dd/mm/aaaa)."},"hPesquisa":{"type":"string","description":"Hora da última consulta (hh:mm:ss)."},"cTipo":{"type":"string","description":"Nome do tipo de consulta realizado."},"cUsuario":{"type":"string","description":"Nome do usuário que fez a última consulta."},"cResultado":{"type":"string","description":"Resumo do resultado da última consulta."},"cUrlPesquisa":{"type":"string","description":"Link para baixar o PDF da última consulta."}},"description":"Última consulta com sucesso para o cliente encontrado. Vazia quando não há consulta ou a busca não foi por CPF/CNPJ."},"tiposConsulta":{"type":"array","items":{"type":"object","properties":{"cCodigo":{"type":"string","description":"Código do tipo de consulta, a informar em cTipoConsulta de ConsultarRestricao (ex.: PJ_BASIC)."},"cDescricao":{"type":"string","description":"Nome do tipo de consulta."},"cValor":{"type":"string","description":"Valor cobrado por consulta, formatado em reais (ex.: R$ 9,90)."},"cTipoPessoa":{"type":"string","description":"Tipo de pessoa atendido: PF ou PJ."},"cExemplo":{"type":"string","description":"Link de um exemplo do relatório deste tipo, quando houver."},"cConteudo":{"type":"string","description":"Cobertura de protestos do tipo (todos os estados ou um estado)."},"cRecomendacao":{"type":"boolean","description":"Indica se é o tipo recomendado pela Omie."},"cDetalhes":{"type":"array","items":{"type":"object","properties":{"cConteudo":{"type":"string","description":"Descrição do item incluído na consulta."},"cBold":{"type":"boolean","description":"Indica se deve ser negrito."},"nOrdem":{"type":"integer","description":"Ordem de exibição do item."}}},"description":"Itens que a consulta inclui."}}},"description":"Tipos de consulta disponíveis para o tipo de pessoa do CPF/CNPJ (PF ou PJ), com valor e conteúdo de cada um. Vem só quando a busca é por CPF/CNPJ."},"cCodStatus":{"type":"string","description":"Código do status do processamento. \"0\" indica sucesso e \"20\" indica que mais de um cliente foi encontrado (escolha um em listaClientes). Outros valores: \"30\" serviço não ativado, \"40\" nenhum filtro informado, \"403\" sem permissão, \"721\" CPF/CNPJ inválido, \"727\" xCodigo junto com outro filtro."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Explica o resultado de \"cCodStatus\"."}},"title":"ObterInfoRestricao (retorno)"},"geral_clientes_AlterarCliente":{"type":"object","title":"AlterarCliente","description":"Altera os dados do cliente","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarCliente"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_cliente_omie":{"type":"integer","maxLength":15,"description":"Código de cliente ou fornecedor."},"codigo_cliente_integracao":{"type":"string","maxLength":60,"description":"Código de integração com sistemas legados."},"razao_social":{"type":"string","maxLength":60,"description":"Razão social."},"cnpj_cpf":{"type":"string","maxLength":20,"description":"CNPJ ou CPF."},"nome_fantasia":{"type":"string","maxLength":100,"description":"Nome fantasia."},"telefone1_ddd":{"type":"string","maxLength":5,"description":"DDD do telefone."},"telefone1_numero":{"type":"string","maxLength":15,"description":"Telefone para contato."},"contato":{"type":"string","maxLength":100,"description":"Nome para contato."},"endereco":{"type":"string","maxLength":60,"description":"Endereço."},"endereco_numero":{"type":"string","maxLength":60,"description":"Número do endereço."},"bairro":{"type":"string","maxLength":60,"description":"Bairro."},"complemento":{"type":"string","maxLength":60,"description":"Complemento do endereço."},"estado":{"type":"string","maxLength":2,"description":"Sigla do estado."},"cidade":{"type":"string","maxLength":40,"description":"Código da cidade. Recebe o código IBGE ou o NOME da cidade."},"cep":{"type":"string","maxLength":10,"description":"CEP."},"codigo_pais":{"type":"string","maxLength":4,"description":"Código do país."},"separar_endereco":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Separar endereço (S/N)?"},"pesquisar_cep":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Pesquisar CEP (S/N)? Quando igual a S o sistema irá preencher os campos do endereço que estiverem vazios (logradouro, bairro e cidade) conforme os dados do CEP"},"telefone2_ddd":{"type":"string","maxLength":5,"description":"DDD do telefone 2."},"telefone2_numero":{"type":"string","maxLength":15,"description":"Número do telefone 2."},"fax_ddd":{"type":"string","maxLength":5,"description":"DDD do fax."},"fax_numero":{"type":"string","maxLength":15,"description":"Número do fax."},"email":{"type":"string","maxLength":500,"description":"E-mail."},"homepage":{"type":"string","maxLength":100,"description":"Website."},"inscricao_estadual":{"type":"string","maxLength":20,"description":"Inscrição estadual."},"inscricao_municipal":{"type":"string","maxLength":20,"description":"Inscrição municipal."},"inscricao_suframa":{"type":"string","maxLength":20,"description":"Inscrição Suframa."},"optante_simples_nacional":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Optante do Simples Nacional (S/N)?"},"tipo_atividade":{"type":"string","maxLength":1,"description":"Tipo da atividade."},"cnae":{"type":"string","maxLength":7,"description":"Código do CNAE."},"produtor_rural":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Produtor Rural (S/N)?"},"contribuinte":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Contribuinte (S/N)?"},"observacao":{"type":"string","description":"Observações internas."},"obs_detalhadas":{"type":"string","description":"Observações detalhadas."},"recomendacao_atraso":{"type":"string","maxLength":2,"description":"Código da instrução de protesto."},"tags":{"type":"array","items":{"type":"object","properties":{"tag":{"type":"string","maxLength":50}}},"description":"Tags do cliente ou fornecedor."},"pessoa_fisica":{"deprecated":true,"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Pessoa Física (S/N)? (Deprecated)"},"exterior":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Tomador de serviço localizado no exterior (S/N)?"},"logradouro":{"deprecated":true,"type":"string","maxLength":6,"description":"DEPRECATED"},"importado_api":{"deprecated":true,"type":"string","maxLength":1,"description":"DEPRECATED"},"bloqueado":{"deprecated":true,"type":"string","maxLength":1,"enum":["S","N"],"description":"DEPRECATED"},"cidade_ibge":{"type":"string","maxLength":7,"description":"Código do IBGE para a cidade."},"valor_limite_credito":{"type":"number","maxLength":18,"description":"Valor do limite de crédito total."},"bloquear_faturamento":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Bloquear o faturamento para o cliente (S/N)."},"recomendacoes":{"type":"object","properties":{"numero_parcelas":{"type":"string","maxLength":3,"description":"Número de parcelas padrão para as vendas."},"codigo_vendedor":{"type":"integer","maxLength":15,"description":"Código do vendedor padrão."},"email_fatura":{"type":"string","maxLength":200,"description":"Enviar a NF-e e boleto para outro e-mail?"},"gerar_boletos":{"type":"string","maxLength":1,"description":"Gerar boletos ao emitir NF-e?"},"codigo_transportadora":{"type":"integer","maxLength":15,"description":"Código da transportadora padrão."},"tipo_assinante":{"type":"string","maxLength":1,"description":"Tipo de assinante utilizado para notas fiscais via única (modelo 21 e 22)."}},"description":"Recomendações do cliente."},"enderecoEntrega":{"type":"object","properties":{"entRazaoSocial":{"type":"string","maxLength":60,"description":"Nome ou razão social"},"entCnpjCpf":{"type":"string","maxLength":20,"description":"CNPJ ou CPF do recebedor."},"entEndereco":{"type":"string","maxLength":60,"description":"Endereço."},"entNumero":{"type":"string","maxLength":60,"description":"Número do endereço."},"entComplemento":{"type":"string","maxLength":60,"description":"Complemento do endereço."},"entBairro":{"type":"string","maxLength":60,"description":"Bairro."},"entCEP":{"type":"string","maxLength":9,"description":"CEP."},"entEstado":{"type":"string","maxLength":2,"description":"Estado."},"entCidade":{"type":"string","maxLength":40,"description":"Cidade."},"entSepararEndereco":{"type":"string","maxLength":1,"example":"S","description":"Separar endereço. Valores possível S ou N, sendo N o padrão. Quando igual S separa do endereço o número o e complemento, caso existirem."},"entTelefone":{"type":"string","maxLength":15,"description":"Telefone."},"entIE":{"type":"string","maxLength":14,"description":"Inscrição estadual."}},"description":"Dados do endereço de entrega."},"nif":{"type":"string","maxLength":100,"description":"NIF - Número de Identificação Fiscal."},"documento_exterior":{"type":"string","maxLength":20,"description":"Documento no exterior para clientes estrangeiros."},"inativo":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Inativo (S/N)?"},"dadosBancarios":{"type":"object","properties":{"codigo_banco":{"type":"string","maxLength":3,"description":"Código do banco."},"agencia":{"type":"string","maxLength":10,"description":"Agência"},"conta_corrente":{"type":"string","maxLength":25,"description":"Número da conta corrente."},"doc_titular":{"type":"string","maxLength":20,"description":"CNPJ ou CPF do titular."},"nome_titular":{"type":"string","maxLength":60,"description":"Nome do titular."},"transf_padrao":{"type":"string","maxLength":1,"example":"S","description":"Definir transferência como forma de pagamento padrão?"},"cChavePix":{"type":"string","maxLength":60,"description":"Chave PIX."}},"description":"Dados bancários do cliente."},"caracteristicas":{"type":"array","items":{"type":"object","properties":{"campo":{"type":"string","maxLength":30,"description":"Nome da característica. Caso não encontre a característica um novo cadastro será adicionado.\n\nObrigatório em \"IncluirCliente\" e \"IncluirClientesPorLote\"; opcional nas demais operações que reutilizam esta estrutura, como \"AlterarCliente\" e \"UpsertCliente\"."},"conteudo":{"type":"string","maxLength":60,"description":"Conteúdo da característica. Caso o valor desse campo não seja informado a característica será excluída para o cliente ou fornecedor\n\nObrigatório em \"IncluirCliente\" e \"IncluirClientesPorLote\"; nas demais operações que reutilizam esta estrutura (ex.: \"AlterarCliente\"), omitir este campo é o comportamento válido para excluir a característica, conforme descrito acima."}}},"description":"Características do cliente ou fornecedor."},"enviar_anexos":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Enviar anexos por e-mail (S/N)? Esta função só poderá ser utilizada se o Portal Omie estiver ativo."},"info":{"type":"object","properties":{"dInc":{"type":"string","maxLength":10,"example":"31/12/2024","description":"Data da inclusão. No formato dd/mm/aaaa."},"hInc":{"type":"string","maxLength":8,"example":"23:59:59","description":"Hora da inclusão. No formato hh:mm:ss."},"uInc":{"type":"string","maxLength":10,"description":"Usuário da inclusão."},"dAlt":{"type":"string","maxLength":10,"example":"31/12/2024","description":"Data da alteração.\nNo formato dd/mm/aaaa."},"hAlt":{"type":"string","maxLength":8,"example":"23:59:59","description":"Hora da alteração.\nNo formato hh:mm:ss."},"uAlt":{"type":"string","maxLength":10,"description":"Usuário da alteração."},"cImpAPI":{"type":"string","maxLength":1,"example":"S","description":"Importado pela API (S/N)."}},"description":"Informações sobre o cadastro do cliente."},"bloquear_exclusao":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Bloqueia a exclusão do registro (S/N)?"}}}}},"example":{"call":"AlterarCliente","param":[{"codigo_cliente_integracao":"CodigoInterno0001","email":"primeiro@ccliente.com.br","razao_social":"Primeiro Cliente  Ltda Me","nome_fantasia":"Primeiro Cliente"}]}},"geral_clientes_AlterarCliente_retorno":{"type":"object","properties":{"codigo_cliente_omie":{"type":"integer"},"codigo_cliente_integracao":{"type":"string"},"codigo_status":{"type":"string"},"descricao_status":{"type":"string"}},"title":"AlterarCliente (retorno)"},"geral_clientes_AlterarSituacaoCliente":{"type":"object","title":"AlterarSituacaoCliente","description":"Ativa ou inativa o cadastro de um cliente ou fornecedor.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarSituacaoCliente"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_cliente_omie":{"type":"integer","maxLength":15,"description":"Código do cliente ou fornecedor.\nInforme esta tag ou a tag \"codigo_cliente_integracao\"."},"codigo_cliente_integracao":{"type":"string","maxLength":60,"description":"Código de integração com sistemas legados.\nInforme esta tag ou a tag \"codigo_cliente_omie\"."},"inativo":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Situação desejada para o cadastro.\n\"S\" inativa o cliente ou fornecedor e \"N\" o ativa."}},"required":["inativo"]}}},"example":{"call":"AlterarSituacaoCliente","param":[{"codigo_cliente_omie":0,"inativo":"N"}]}},"geral_clientes_AlterarSituacaoCliente_retorno":{"type":"object","properties":{"codigo_cliente_omie":{"type":"integer"},"codigo_cliente_integracao":{"type":"string"},"codigo_status":{"type":"string"},"descricao_status":{"type":"string"}},"title":"AlterarSituacaoCliente (retorno)"},"geral_clientes_AssociarCodIntCliente":{"type":"object","title":"AssociarCodIntCliente","description":"Associa um código de integração a um cliente cadastrado no Omie.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AssociarCodIntCliente"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_cliente_omie":{"type":"integer","maxLength":15},"codigo_cliente_integracao":{"type":"string","maxLength":60}},"required":["codigo_cliente_integracao"]}}},"example":{"call":"AssociarCodIntCliente","param":[{"codigo_cliente_omie":0,"codigo_cliente_integracao":""}]}},"geral_clientes_AssociarCodIntCliente_retorno":{"type":"object","properties":{"codigo_cliente_omie":{"type":"integer"},"codigo_cliente_integracao":{"type":"string"},"codigo_status":{"type":"string"},"descricao_status":{"type":"string"}},"title":"AssociarCodIntCliente (retorno)"},"geral_clientes_ConsultarCliente":{"type":"object","title":"ConsultarCliente","description":"Consulta os dados de um cliente","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarCliente"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_cliente_omie":{"type":"integer","maxLength":15},"codigo_cliente_integracao":{"type":"string","maxLength":60}}}}},"example":{"call":"ConsultarCliente","param":[{"codigo_cliente_omie":0,"codigo_cliente_integracao":""}]}},"geral_clientes_ConsultarCliente_retorno":{"type":"object","properties":{"codigo_cliente_omie":{"type":"integer","description":"Código de cliente ou fornecedor."},"codigo_cliente_integracao":{"type":"string","description":"Código de integração com sistemas legados."},"razao_social":{"type":"string","description":"Razão social."},"cnpj_cpf":{"type":"string","description":"CNPJ ou CPF."},"nome_fantasia":{"type":"string","description":"Nome fantasia."},"telefone1_ddd":{"type":"string","description":"DDD do telefone."},"telefone1_numero":{"type":"string","description":"Telefone para contato."},"contato":{"type":"string","description":"Nome para contato."},"endereco":{"type":"string","description":"Endereço."},"endereco_numero":{"type":"string","description":"Número do endereço."},"bairro":{"type":"string","description":"Bairro."},"complemento":{"type":"string","description":"Complemento do endereço."},"estado":{"type":"string","description":"Sigla do estado."},"cidade":{"type":"string","description":"Código da cidade. Recebe o código IBGE ou o NOME da cidade."},"cep":{"type":"string","description":"CEP."},"codigo_pais":{"type":"string","description":"Código do país."},"separar_endereco":{"type":"string","description":"Separar endereço (S/N)?"},"pesquisar_cep":{"type":"string","description":"Pesquisar CEP (S/N)? Quando igual a S o sistema irá preencher os campos do endereço que estiverem vazios (logradouro, bairro e cidade) conforme os dados do CEP"},"telefone2_ddd":{"type":"string","description":"DDD do telefone 2."},"telefone2_numero":{"type":"string","description":"Número do telefone 2."},"fax_ddd":{"type":"string","description":"DDD do fax."},"fax_numero":{"type":"string","description":"Número do fax."},"email":{"type":"string","description":"E-mail."},"homepage":{"type":"string","description":"Website."},"inscricao_estadual":{"type":"string","description":"Inscrição estadual."},"inscricao_municipal":{"type":"string","description":"Inscrição municipal."},"inscricao_suframa":{"type":"string","description":"Inscrição Suframa."},"optante_simples_nacional":{"type":"string","description":"Optante do Simples Nacional (S/N)?"},"tipo_atividade":{"type":"string","description":"Tipo da atividade."},"cnae":{"type":"string","description":"Código do CNAE."},"produtor_rural":{"type":"string","description":"Produtor Rural (S/N)?"},"contribuinte":{"type":"string","description":"Contribuinte (S/N)?"},"observacao":{"type":"string","description":"Observações internas."},"obs_detalhadas":{"type":"string","description":"Observações detalhadas."},"recomendacao_atraso":{"type":"string","description":"Código da instrução de protesto."},"tags":{"type":"array","items":{"type":"object","properties":{"tag":{"type":"string"}}},"description":"Tags do cliente ou fornecedor."},"pessoa_fisica":{"type":"string","description":"Pessoa Física (S/N)? (Deprecated)"},"exterior":{"type":"string","description":"Tomador de serviço localizado no exterior (S/N)?"},"logradouro":{"type":"string","description":"DEPRECATED"},"importado_api":{"type":"string","description":"DEPRECATED"},"bloqueado":{"type":"string","description":"DEPRECATED"},"cidade_ibge":{"type":"string","description":"Código do IBGE para a cidade."},"valor_limite_credito":{"type":"decimal","description":"Valor do limite de crédito total."},"bloquear_faturamento":{"type":"string","description":"Bloquear o faturamento para o cliente (S/N)."},"recomendacoes":{"type":"object","properties":{"numero_parcelas":{"type":"string","description":"Número de parcelas padrão para as vendas."},"codigo_vendedor":{"type":"integer","description":"Código do vendedor padrão."},"email_fatura":{"type":"string","description":"Enviar a NF-e e boleto para outro e-mail?"},"gerar_boletos":{"type":"string","description":"Gerar boletos ao emitir NF-e?"},"codigo_transportadora":{"type":"integer","description":"Código da transportadora padrão."},"tipo_assinante":{"type":"string","description":"Tipo de assinante utilizado para notas fiscais via única (modelo 21 e 22)."}},"description":"Recomendações do cliente."},"enderecoEntrega":{"type":"object","properties":{"entRazaoSocial":{"type":"string","description":"Nome ou razão social"},"entCnpjCpf":{"type":"string","description":"CNPJ ou CPF do recebedor."},"entEndereco":{"type":"string","description":"Endereço."},"entNumero":{"type":"string","description":"Número do endereço."},"entComplemento":{"type":"string","description":"Complemento do endereço."},"entBairro":{"type":"string","description":"Bairro."},"entCEP":{"type":"string","description":"CEP."},"entEstado":{"type":"string","description":"Estado."},"entCidade":{"type":"string","description":"Cidade."},"entSepararEndereco":{"type":"string","description":"Separar endereço. Valores possível S ou N, sendo N o padrão. Quando igual S separa do endereço o número o e complemento, caso existirem."},"entTelefone":{"type":"string","description":"Telefone."},"entIE":{"type":"string","description":"Inscrição estadual."}},"description":"Dados do endereço de entrega."},"nif":{"type":"string","description":"NIF - Número de Identificação Fiscal."},"documento_exterior":{"type":"string","description":"Documento no exterior para clientes estrangeiros."},"inativo":{"type":"string","description":"Inativo (S/N)?"},"dadosBancarios":{"type":"object","properties":{"codigo_banco":{"type":"string","description":"Código do banco."},"agencia":{"type":"string","description":"Agência"},"conta_corrente":{"type":"string","description":"Número da conta corrente."},"doc_titular":{"type":"string","description":"CNPJ ou CPF do titular."},"nome_titular":{"type":"string","description":"Nome do titular."},"transf_padrao":{"type":"string","description":"Definir transferência como forma de pagamento padrão?"},"cChavePix":{"type":"string","description":"Chave PIX."}},"description":"Dados bancários do cliente."},"caracteristicas":{"type":"array","items":{"type":"object","properties":{"campo":{"type":"string","description":"Nome da característica. Caso não encontre a característica um novo cadastro será adicionado. Obrigatório em \"IncluirCliente\" e \"IncluirClientesPorLote\"; opcional nas demais operações que reutilizam esta estrutura, como \"AlterarCliente\" e \"UpsertCliente\"."},"conteudo":{"type":"string","description":"Conteúdo da característica. Caso o valor desse campo não seja informado a característica será excluída para o cliente ou fornecedor Obrigatório em \"IncluirCliente\" e \"IncluirClientesPorLote\"; nas demais operações que reutilizam esta estrutura (ex.: \"AlterarCliente\"), omitir este campo é o comportamento válido para excluir a característica, conforme descrito acima."}}},"description":"Características do cliente ou fornecedor."},"enviar_anexos":{"type":"string","description":"Enviar anexos por e-mail (S/N)? Esta função só poderá ser utilizada se o Portal Omie estiver ativo."},"info":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da inclusão. No formato dd/mm/aaaa."},"hInc":{"type":"string","description":"Hora da inclusão. No formato hh:mm:ss."},"uInc":{"type":"string","description":"Usuário da inclusão."},"dAlt":{"type":"string","description":"Data da alteração. No formato dd/mm/aaaa."},"hAlt":{"type":"string","description":"Hora da alteração. No formato hh:mm:ss."},"uAlt":{"type":"string","description":"Usuário da alteração."},"cImpAPI":{"type":"string","description":"Importado pela API (S/N)."}},"description":"Informações sobre o cadastro do cliente."},"bloquear_exclusao":{"type":"string","description":"Bloqueia a exclusão do registro (S/N)?"}},"title":"ConsultarCliente (retorno)"},"geral_clientes_ExcluirCliente":{"type":"object","title":"ExcluirCliente","description":"Exclui um cliente da base de dados.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirCliente"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_cliente_omie":{"type":"integer","maxLength":15},"codigo_cliente_integracao":{"type":"string","maxLength":60}}}}},"example":{"call":"ExcluirCliente","param":[{"codigo_cliente_omie":0,"codigo_cliente_integracao":""}]}},"geral_clientes_ExcluirCliente_retorno":{"type":"object","properties":{"codigo_cliente_omie":{"type":"integer"},"codigo_cliente_integracao":{"type":"string"},"codigo_status":{"type":"string"},"descricao_status":{"type":"string"}},"title":"ExcluirCliente (retorno)"},"geral_clientes_IncluirCliente":{"type":"object","title":"IncluirCliente","description":"Inclui um novo cliente ou fornecedor","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirCliente"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_cliente_omie":{"type":"integer","maxLength":15,"description":"Código de cliente ou fornecedor."},"codigo_cliente_integracao":{"type":"string","maxLength":60,"description":"Código de integração com sistemas legados."},"razao_social":{"type":"string","maxLength":60,"description":"Razão social."},"cnpj_cpf":{"type":"string","maxLength":20,"example":"12.345.678/0001-01","description":"CNPJ ou CPF."},"nome_fantasia":{"type":"string","maxLength":100,"description":"Nome fantasia."},"telefone1_ddd":{"type":"string","maxLength":5,"description":"DDD do telefone."},"telefone1_numero":{"type":"string","maxLength":15,"description":"Telefone para contato."},"contato":{"type":"string","maxLength":100,"description":"Nome para contato."},"endereco":{"type":"string","maxLength":60,"description":"Endereço."},"endereco_numero":{"type":"string","maxLength":60,"description":"Número do endereço."},"bairro":{"type":"string","maxLength":60,"description":"Bairro."},"complemento":{"type":"string","maxLength":60,"description":"Complemento do endereço."},"estado":{"type":"string","maxLength":2,"description":"Sigla do estado."},"cidade":{"type":"string","maxLength":40,"description":"Código da cidade. Recebe o código IBGE ou o NOME da cidade."},"cep":{"type":"string","maxLength":10,"description":"CEP."},"codigo_pais":{"type":"string","maxLength":4,"description":"Código do país."},"separar_endereco":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Separar endereço (S/N)?"},"pesquisar_cep":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Pesquisar CEP (S/N)? Quando igual a S o sistema irá preencher os campos do endereço que estiverem vazios (logradouro, bairro e cidade) conforme os dados do CEP"},"telefone2_ddd":{"type":"string","maxLength":5,"description":"DDD do telefone 2."},"telefone2_numero":{"type":"string","maxLength":15,"description":"Número do telefone 2."},"fax_ddd":{"type":"string","maxLength":5,"description":"DDD do fax."},"fax_numero":{"type":"string","maxLength":15,"description":"Número do fax."},"email":{"type":"string","maxLength":500,"description":"E-mail."},"homepage":{"type":"string","maxLength":100,"description":"Website."},"inscricao_estadual":{"type":"string","maxLength":20,"description":"Inscrição estadual."},"inscricao_municipal":{"type":"string","maxLength":20,"description":"Inscrição municipal."},"inscricao_suframa":{"type":"string","maxLength":20,"description":"Inscrição Suframa."},"optante_simples_nacional":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Optante do Simples Nacional (S/N)?"},"tipo_atividade":{"type":"string","maxLength":1,"description":"Tipo da atividade."},"cnae":{"type":"string","maxLength":7,"description":"Código do CNAE."},"produtor_rural":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Produtor Rural (S/N)?"},"contribuinte":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Contribuinte (S/N)?"},"observacao":{"type":"string","description":"Observações internas."},"obs_detalhadas":{"type":"string","description":"Observações detalhadas."},"recomendacao_atraso":{"type":"string","maxLength":2,"description":"Código da instrução de protesto."},"tags":{"type":"array","items":{"type":"object","properties":{"tag":{"type":"string","maxLength":50}}},"description":"Tags do cliente ou fornecedor."},"pessoa_fisica":{"deprecated":true,"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Pessoa Física (S/N)? (Deprecated)"},"exterior":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Tomador de serviço localizado no exterior (S/N)?"},"logradouro":{"deprecated":true,"type":"string","maxLength":6,"description":"Logradouro (Deprecated)"},"importado_api":{"deprecated":true,"type":"string","maxLength":1,"description":"Importado via API (S/N)? (Deprecated)"},"bloqueado":{"deprecated":true,"type":"string","maxLength":1,"enum":["S","N"],"description":"Bloqueado (S/N)? (Deprecated)"},"cidade_ibge":{"type":"string","maxLength":7,"description":"Código do IBGE para a cidade."},"valor_limite_credito":{"type":"number","maxLength":18,"description":"Valor do limite de crédito total."},"bloquear_faturamento":{"type":"string","maxLength":1,"enum":["S","N"],"description":"Bloquear o faturamento para o cliente (S/N)?"},"recomendacoes":{"type":"object","properties":{"numero_parcelas":{"type":"string","maxLength":3,"description":"Número de parcelas padrão para as vendas."},"codigo_vendedor":{"type":"integer","maxLength":15,"description":"Código do vendedor padrão."},"email_fatura":{"type":"string","maxLength":200,"description":"Enviar a NF-e e boleto para outro e-mail?"},"gerar_boletos":{"type":"string","maxLength":1,"description":"Gerar boletos ao emitir NF-e?"},"codigo_transportadora":{"type":"integer","maxLength":15,"description":"Código da transportadora padrão."},"tipo_assinante":{"type":"string","maxLength":1,"description":"Tipo de assinante utilizado para notas fiscais via única (modelo 21 e 22)."}},"description":"Recomendações do cliente."},"enderecoEntrega":{"type":"object","properties":{"entRazaoSocial":{"type":"string","maxLength":60,"description":"Nome ou razão social"},"entCnpjCpf":{"type":"string","maxLength":20,"description":"CNPJ ou CPF do recebedor."},"entEndereco":{"type":"string","maxLength":60,"description":"Endereço."},"entNumero":{"type":"string","maxLength":60,"description":"Número do endereço."},"entComplemento":{"type":"string","maxLength":60,"description":"Complemento do endereço."},"entBairro":{"type":"string","maxLength":60,"description":"Bairro."},"entCEP":{"type":"string","maxLength":9,"description":"CEP."},"entEstado":{"type":"string","maxLength":2,"description":"Estado."},"entCidade":{"type":"string","maxLength":40,"description":"Cidade."},"entSepararEndereco":{"type":"string","maxLength":1,"example":"S","description":"Separar endereço. Valores possível S ou N, sendo N o padrão. Quando igual S separa do endereço o número o e complemento, caso existirem."},"entTelefone":{"type":"string","maxLength":15,"description":"Telefone."},"entIE":{"type":"string","maxLength":14,"description":"Inscrição estadual."}},"description":"Dados do endereço de entrega."},"nif":{"type":"string","maxLength":100,"description":"NIF - Número de Identificação Fiscal."},"documento_exterior":{"type":"string","maxLength":20,"description":"Documento no exterior para clientes estrangeiros."},"inativo":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Inativo (S/N)?"},"dadosBancarios":{"type":"object","properties":{"codigo_banco":{"type":"string","maxLength":3,"description":"Código do banco."},"agencia":{"type":"string","maxLength":10,"description":"Agência"},"conta_corrente":{"type":"string","maxLength":25,"description":"Número da conta corrente."},"doc_titular":{"type":"string","maxLength":20,"description":"CNPJ ou CPF do titular."},"nome_titular":{"type":"string","maxLength":60,"description":"Nome do titular."},"transf_padrao":{"type":"string","maxLength":1,"example":"S","description":"Definir transferência como forma de pagamento padrão?"},"cChavePix":{"type":"string","maxLength":60,"description":"Chave PIX."}},"description":"Dados bancários do cliente."},"caracteristicas":{"type":"array","items":{"type":"object","properties":{"campo":{"type":"string","maxLength":30,"description":"Nome da característica. Caso não encontre a característica um novo cadastro será adicionado.\n\nObrigatório em \"IncluirCliente\" e \"IncluirClientesPorLote\"; opcional nas demais operações que reutilizam esta estrutura, como \"AlterarCliente\" e \"UpsertCliente\"."},"conteudo":{"type":"string","maxLength":60,"description":"Conteúdo da característica. Caso o valor desse campo não seja informado a característica será excluída para o cliente ou fornecedor\n\nObrigatório em \"IncluirCliente\" e \"IncluirClientesPorLote\"; nas demais operações que reutilizam esta estrutura (ex.: \"AlterarCliente\"), omitir este campo é o comportamento válido para excluir a característica, conforme descrito acima."}}},"description":"Características do cliente ou fornecedor."},"enviar_anexos":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Enviar anexos por e-mail (S/N)? Esta função só poderá ser utilizada se o Portal Omie estiver ativo."},"info":{"type":"object","properties":{"dInc":{"type":"string","maxLength":10,"example":"31/12/2024","description":"Data da inclusão. No formato dd/mm/aaaa."},"hInc":{"type":"string","maxLength":8,"example":"23:59:59","description":"Hora da inclusão. No formato hh:mm:ss."},"uInc":{"type":"string","maxLength":10,"description":"Usuário da inclusão."},"dAlt":{"type":"string","maxLength":10,"example":"31/12/2024","description":"Data da alteração.\nNo formato dd/mm/aaaa."},"hAlt":{"type":"string","maxLength":8,"example":"23:59:59","description":"Hora da alteração.\nNo formato hh:mm:ss."},"uAlt":{"type":"string","maxLength":10,"description":"Usuário da alteração."},"cImpAPI":{"type":"string","maxLength":1,"example":"S","description":"Importado pela API (S/N)."}},"description":"Informações sobre o cadastro do cliente."},"bloquear_exclusao":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Bloqueia a exclusão do registro (S/N)?"}},"required":["codigo_cliente_integracao","razao_social"]}}},"example":{"call":"IncluirCliente","param":[{"codigo_cliente_integracao":"CodigoInterno0001","email":"primeiro@ccliente.com.br","razao_social":"Primeiro Cliente  Ltda Me","nome_fantasia":"Primeiro Cliente"}]}},"geral_clientes_IncluirCliente_retorno":{"type":"object","properties":{"codigo_cliente_omie":{"type":"integer"},"codigo_cliente_integracao":{"type":"string"},"codigo_status":{"type":"string"},"descricao_status":{"type":"string"}},"title":"IncluirCliente (retorno)"},"geral_clientes_ListarClientes":{"type":"object","title":"ListarClientes","description":"Lista os clientes cadastrados","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarClientes"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página."},"apenas_importado_api":{"type":"string","maxLength":1,"description":"Exibir apenas os registros gerados pela API"},"ordenar_por":{"type":"string","maxLength":100,"description":"DEPRECATED"},"ordem_decrescente":{"type":"string","maxLength":1,"description":"DEPRECATED"},"filtrar_por_data_de":{"type":"string","maxLength":10,"description":"Filtrar os registros a partir de uma data."},"filtrar_por_data_ate":{"type":"string","maxLength":10,"description":"Filtrar os registros até uma data."},"filtrar_por_hora_de":{"type":"string","maxLength":8,"description":"Filtro por hora a apartir de."},"filtrar_por_hora_ate":{"type":"string","maxLength":8,"description":"Filtro por hora até."},"filtrar_apenas_inclusao":{"type":"string","maxLength":1,"description":"Filtrar apenas os registros incluídos."},"filtrar_apenas_alteracao":{"type":"string","maxLength":1,"description":"Filtrar apenas os registros alterados."},"clientesFiltro":{"type":"object","properties":{"codigo_cliente_omie":{"type":"integer","maxLength":15,"description":"Código do cliente ou fornecedor."},"codigo_cliente_integracao":{"type":"string","maxLength":60,"description":"Código de integração com sistemas legados."},"cnpj_cpf":{"type":"string","maxLength":20,"example":"000.000.000-00","description":"CNPJ ou CPF."},"razao_social":{"type":"string","maxLength":60,"description":"Razão social."},"nome_fantasia":{"type":"string","maxLength":100,"description":"Nome fantasia ou nome comercial."},"endereco":{"deprecated":true,"type":"string","maxLength":60,"description":"Endereço (Deprecated)."},"bairro":{"deprecated":true,"type":"string","maxLength":60,"description":"Bairro (Deprecated)."},"cidade":{"deprecated":true,"type":"string","maxLength":40,"description":"Cidade (Deprecated)."},"estado":{"deprecated":true,"type":"string","maxLength":2,"example":"SP","description":"Sigla do estado (Deprecated)."},"cep":{"type":"string","maxLength":10,"description":"CEP."},"contato":{"deprecated":true,"type":"string","maxLength":100,"description":"Nome do contato (Deprecated)."},"email":{"deprecated":true,"type":"string","maxLength":500,"description":"E-mail (Deprecated)."},"homepage":{"deprecated":true,"type":"string","maxLength":100,"description":"Website (Deprecated)."},"inscricao_municipal":{"deprecated":true,"type":"string","maxLength":20,"description":"Inscrição Municipal (Deprecated)."},"inscricao_estadual":{"deprecated":true,"type":"string","maxLength":20,"description":"Inscrição Estadual (Deprecated)."},"inscricao_suframa":{"deprecated":true,"type":"string","maxLength":20,"description":"Inscrição Suframa (Deprecated)."},"pessoa_fisica":{"deprecated":true,"type":"string","maxLength":1,"enum":["S","N"],"description":"Pessoa Física (Deprecated)."},"optante_simples_nacional":{"deprecated":true,"type":"string","maxLength":1,"example":"S","description":"Optante do Simples Nacional (S/N) (Deprecated)."},"inativo":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Inativo (S/N)."},"tags":{"type":"array","items":{"type":"object","properties":{"tag":{"type":"string","maxLength":50}}},"description":"Tags do cliente ou fornecedor."}}},"clientesPorCodigo":{"type":"array","items":{"type":"object","properties":{"codigo_cliente_omie":{"type":"integer","maxLength":15,"description":"Código do cliente ou fornecedor."},"codigo_cliente_integracao":{"type":"string","maxLength":60,"description":"Código de integração com sistemas legados."}}},"description":"Lista de códigos para filtro de clientes."},"exibir_caracteristicas":{"type":"string","maxLength":1,"description":"Exibe as caracteristicas do cliente."},"exibir_obs":{"type":"string","maxLength":1,"description":"Exibir as observações do cliente (S/N).\n\n\nPreencher com \"S\" ou \"N\".\n\nDefault \"N\""},"ordem_descrescente":{"type":"string","maxLength":1,"description":"DEPRECATED"}}}}},"example":{"call":"ListarClientes","param":[{"pagina":1,"registros_por_pagina":50,"apenas_importado_api":"N"}]}},"geral_clientes_ListarClientes_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada"},"total_de_paginas":{"type":"integer","description":"Número total de páginas"},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"total de registros encontrados"},"clientes_cadastro":{"type":"array","items":{"type":"object","properties":{"codigo_cliente_omie":{"type":"integer","description":"Código de cliente ou fornecedor."},"codigo_cliente_integracao":{"type":"string","description":"Código de integração com sistemas legados. Obrigatório em \"UpsertClientesPorLote\"; opcional nas demais operações que reutilizam esta estrutura, como \"IncluirClientesPorLote\" e \"ListarClientes\"."},"razao_social":{"type":"string","description":"Razão social."},"cnpj_cpf":{"type":"string","description":"CNPJ ou CPF."},"nome_fantasia":{"type":"string","description":"Nome fantasia."},"telefone1_ddd":{"type":"string","description":"DDD do telefone."},"telefone1_numero":{"type":"string","description":"Telefone para contato."},"contato":{"type":"string","description":"Nome para contato."},"endereco":{"type":"string","description":"Endereço."},"endereco_numero":{"type":"string","description":"Número do endereço."},"bairro":{"type":"string","description":"Bairro."},"complemento":{"type":"string","description":"Complemento do endereço."},"estado":{"type":"string","description":"Sigla do estado."},"cidade":{"type":"string","description":"Código da cidade. Recebe o código IBGE ou o NOME da cidade."},"cep":{"type":"string","description":"CEP."},"codigo_pais":{"type":"string","description":"Código do país."},"separar_endereco":{"type":"string","description":"Separar endereço (S/N)?"},"pesquisar_cep":{"type":"string","description":"Pesquisar CEP (S/N)? Quando igual a S o sistema irá preencher os campos do endereço que estiverem vazios (logradouro, bairro e cidade) conforme os dados do CEP"},"telefone2_ddd":{"type":"string","description":"DDD do telefone 2."},"telefone2_numero":{"type":"string","description":"Número do telefone 2."},"fax_ddd":{"type":"string","description":"DDD do fax."},"fax_numero":{"type":"string","description":"Número do fax."},"email":{"type":"string","description":"E-mail."},"homepage":{"type":"string","description":"Website."},"inscricao_estadual":{"type":"string","description":"Inscrição estadual."},"inscricao_municipal":{"type":"string","description":"Inscrição municipal."},"inscricao_suframa":{"type":"string","description":"Inscrição Suframa."},"optante_simples_nacional":{"type":"string","description":"Optante do Simples Nacional (S/N)?"},"tipo_atividade":{"type":"string","description":"Tipo da atividade."},"cnae":{"type":"string","description":"Código do CNAE."},"produtor_rural":{"type":"string","description":"Produtor Rural (S/N)?"},"contribuinte":{"type":"string","description":"Contribuinte (S/N)?"},"observacao":{"type":"string","description":"Observações internas."},"obs_detalhadas":{"type":"string","description":"Observações detalhadas."},"recomendacao_atraso":{"type":"string","description":"Código da instrução de protesto."},"tags":{"type":"array","items":{"type":"object","properties":{"tag":{"type":"string"}}},"description":"Tags do cliente ou fornecedor."},"pessoa_fisica":{"type":"string","description":"Pessoa Física (S/N)? (Deprecated)"},"exterior":{"type":"string","description":"Tomador de serviço localizado no exterior (S/N)?"},"logradouro":{"type":"string","description":"DEPRECATED"},"importado_api":{"type":"string","description":"DEPRECATED"},"bloqueado":{"type":"string","description":"DEPRECATED"},"cidade_ibge":{"type":"string","description":"Código do IBGE para a cidade."},"valor_limite_credito":{"type":"decimal","description":"Valor do limite de crédito total."},"bloquear_faturamento":{"type":"string","description":"Bloquear o faturamento para o cliente (S/N)."},"recomendacoes":{"type":"object","properties":{"numero_parcelas":{"type":"string","description":"Número de parcelas padrão para as vendas."},"codigo_vendedor":{"type":"integer","description":"Código do vendedor padrão."},"email_fatura":{"type":"string","description":"Enviar a NF-e e boleto para outro e-mail?"},"gerar_boletos":{"type":"string","description":"Gerar boletos ao emitir NF-e?"},"codigo_transportadora":{"type":"integer","description":"Código da transportadora padrão."},"tipo_assinante":{"type":"string","description":"Tipo de assinante utilizado para notas fiscais via única (modelo 21 e 22)."}},"description":"Recomendações do cliente."},"enderecoEntrega":{"type":"object","properties":{"entRazaoSocial":{"type":"string","description":"Nome ou razão social"},"entCnpjCpf":{"type":"string","description":"CNPJ ou CPF do recebedor."},"entEndereco":{"type":"string","description":"Endereço."},"entNumero":{"type":"string","description":"Número do endereço."},"entComplemento":{"type":"string","description":"Complemento do endereço."},"entBairro":{"type":"string","description":"Bairro."},"entCEP":{"type":"string","description":"CEP."},"entEstado":{"type":"string","description":"Estado."},"entCidade":{"type":"string","description":"Cidade."},"entSepararEndereco":{"type":"string","description":"Separar endereço. Valores possível S ou N, sendo N o padrão. Quando igual S separa do endereço o número o e complemento, caso existirem."},"entTelefone":{"type":"string","description":"Telefone."},"entIE":{"type":"string","description":"Inscrição estadual."}},"description":"Dados do endereço de entrega."},"nif":{"type":"string","description":"NIF - Número de Identificação Fiscal."},"documento_exterior":{"type":"string","description":"Documento no exterior para clientes estrangeiros."},"inativo":{"type":"string","description":"Inativo (S/N)?"},"dadosBancarios":{"type":"object","properties":{"codigo_banco":{"type":"string","description":"Código do banco."},"agencia":{"type":"string","description":"Agência"},"conta_corrente":{"type":"string","description":"Número da conta corrente."},"doc_titular":{"type":"string","description":"CNPJ ou CPF do titular."},"nome_titular":{"type":"string","description":"Nome do titular."},"transf_padrao":{"type":"string","description":"Definir transferência como forma de pagamento padrão?"},"cChavePix":{"type":"string","description":"Chave PIX."}},"description":"Dados bancários do cliente."},"caracteristicas":{"type":"array","items":{"type":"object","properties":{"campo":{"type":"string","description":"Nome da característica. Caso não encontre a característica um novo cadastro será adicionado. Obrigatório em \"IncluirCliente\" e \"IncluirClientesPorLote\"; opcional nas demais operações que reutilizam esta estrutura, como \"AlterarCliente\" e \"UpsertCliente\"."},"conteudo":{"type":"string","description":"Conteúdo da característica. Caso o valor desse campo não seja informado a característica será excluída para o cliente ou fornecedor Obrigatório em \"IncluirCliente\" e \"IncluirClientesPorLote\"; nas demais operações que reutilizam esta estrutura (ex.: \"AlterarCliente\"), omitir este campo é o comportamento válido para excluir a característica, conforme descrito acima."}}},"description":"Características do cliente ou fornecedor."},"enviar_anexos":{"type":"string","description":"Enviar anexos por e-mail (S/N)? Esta função só poderá ser utilizada se o Portal Omie estiver ativo."},"info":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da inclusão. No formato dd/mm/aaaa."},"hInc":{"type":"string","description":"Hora da inclusão. No formato hh:mm:ss."},"uInc":{"type":"string","description":"Usuário da inclusão."},"dAlt":{"type":"string","description":"Data da alteração. No formato dd/mm/aaaa."},"hAlt":{"type":"string","description":"Hora da alteração. No formato hh:mm:ss."},"uAlt":{"type":"string","description":"Usuário da alteração."},"cImpAPI":{"type":"string","description":"Importado pela API (S/N)."}},"description":"Informações sobre o cadastro do cliente."},"bloquear_exclusao":{"type":"string","description":"Bloqueia a exclusão do registro (S/N)?"}}},"description":"Cadastro reduzido de produtos"}},"title":"ListarClientes (retorno)"},"geral_clientes_ListarClientesResumido":{"type":"object","title":"ListarClientesResumido","description":"Realiza pesquisa dos clientes","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarClientesResumido"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página."},"apenas_importado_api":{"type":"string","maxLength":1,"description":"Exibir apenas os registros gerados pela API"},"ordenar_por":{"type":"string","maxLength":100,"description":"DEPRECATED"},"ordem_decrescente":{"type":"string","maxLength":1,"description":"DEPRECATED"},"filtrar_por_data_de":{"type":"string","maxLength":10,"description":"Filtrar os registros a partir de uma data."},"filtrar_por_data_ate":{"type":"string","maxLength":10,"description":"Filtrar os registros até uma data."},"filtrar_por_hora_de":{"type":"string","maxLength":8,"description":"Filtro por hora a apartir de."},"filtrar_por_hora_ate":{"type":"string","maxLength":8,"description":"Filtro por hora até."},"filtrar_apenas_inclusao":{"type":"string","maxLength":1,"description":"Filtrar apenas os registros incluídos."},"filtrar_apenas_alteracao":{"type":"string","maxLength":1,"description":"Filtrar apenas os registros alterados."},"clientesFiltro":{"type":"object","properties":{"codigo_cliente_omie":{"type":"integer","maxLength":15,"description":"Código do cliente ou fornecedor."},"codigo_cliente_integracao":{"type":"string","maxLength":60,"description":"Código de integração com sistemas legados."},"cnpj_cpf":{"type":"string","maxLength":20,"example":"000.000.000-00","description":"CNPJ ou CPF."},"razao_social":{"type":"string","maxLength":60,"description":"Razão social."},"nome_fantasia":{"type":"string","maxLength":100,"description":"Nome fantasia ou nome comercial."},"endereco":{"deprecated":true,"type":"string","maxLength":60,"description":"Endereço (Deprecated)."},"bairro":{"deprecated":true,"type":"string","maxLength":60,"description":"Bairro (Deprecated)."},"cidade":{"deprecated":true,"type":"string","maxLength":40,"description":"Cidade (Deprecated)."},"estado":{"deprecated":true,"type":"string","maxLength":2,"example":"SP","description":"Sigla do estado (Deprecated)."},"cep":{"type":"string","maxLength":10,"description":"CEP."},"contato":{"deprecated":true,"type":"string","maxLength":100,"description":"Nome do contato (Deprecated)."},"email":{"deprecated":true,"type":"string","maxLength":500,"description":"E-mail (Deprecated)."},"homepage":{"deprecated":true,"type":"string","maxLength":100,"description":"Website (Deprecated)."},"inscricao_municipal":{"deprecated":true,"type":"string","maxLength":20,"description":"Inscrição Municipal (Deprecated)."},"inscricao_estadual":{"deprecated":true,"type":"string","maxLength":20,"description":"Inscrição Estadual (Deprecated)."},"inscricao_suframa":{"deprecated":true,"type":"string","maxLength":20,"description":"Inscrição Suframa (Deprecated)."},"pessoa_fisica":{"deprecated":true,"type":"string","maxLength":1,"enum":["S","N"],"description":"Pessoa Física (Deprecated)."},"optante_simples_nacional":{"deprecated":true,"type":"string","maxLength":1,"example":"S","description":"Optante do Simples Nacional (S/N) (Deprecated)."},"inativo":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Inativo (S/N)."},"tags":{"type":"array","items":{"type":"object","properties":{"tag":{"type":"string","maxLength":50}}},"description":"Tags do cliente ou fornecedor."}}},"clientesPorCodigo":{"type":"array","items":{"type":"object","properties":{"codigo_cliente_omie":{"type":"integer","maxLength":15,"description":"Código do cliente ou fornecedor."},"codigo_cliente_integracao":{"type":"string","maxLength":60,"description":"Código de integração com sistemas legados."}}},"description":"Lista de códigos para filtro de clientes."},"exibir_caracteristicas":{"type":"string","maxLength":1,"description":"Exibe as caracteristicas do cliente."},"exibir_obs":{"type":"string","maxLength":1,"description":"Exibir as observações do cliente (S/N).\n\n\nPreencher com \"S\" ou \"N\".\n\nDefault \"N\""},"ordem_descrescente":{"type":"string","maxLength":1,"description":"DEPRECATED"}}}}},"example":{"call":"ListarClientesResumido","param":[{"pagina":1,"registros_por_pagina":50,"apenas_importado_api":"N"}]}},"geral_clientes_ListarClientesResumido_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada"},"total_de_paginas":{"type":"integer","description":"Número total de páginas"},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"total de registros encontrados"},"clientes_cadastro_resumido":{"type":"array","items":{"type":"object","properties":{"codigo_cliente":{"type":"integer","description":"Código do cliente - gerado pelo Omie."},"codigo_cliente_integracao":{"type":"string"},"razao_social":{"type":"string","description":"Razão Social do cliente"},"nome_fantasia":{"type":"string","description":"Nome Fantasia do cliente"},"cnpj_cpf":{"type":"string","description":"CNPJ ou CPF do cliente."}}},"description":"Cadastro reduzido de clientes."}},"title":"ListarClientesResumido (retorno)"},"geral_clientes_UpsertCliente":{"type":"object","title":"UpsertCliente","description":"Realiza o UPSERT da tabela de clientes (INCLUSÃO/ALTERAÇÃO).","required":["call","param"],"properties":{"call":{"type":"string","enum":["UpsertCliente"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_cliente_omie":{"type":"integer","maxLength":15,"description":"Código de cliente ou fornecedor."},"codigo_cliente_integracao":{"type":"string","maxLength":60,"description":"Código de integração com sistemas legados."},"razao_social":{"type":"string","maxLength":60,"description":"Razão social."},"cnpj_cpf":{"type":"string","maxLength":20,"description":"CNPJ ou CPF."},"nome_fantasia":{"type":"string","maxLength":100,"description":"Nome fantasia."},"telefone1_ddd":{"type":"string","maxLength":5,"description":"DDD do telefone."},"telefone1_numero":{"type":"string","maxLength":15,"description":"Telefone para contato."},"contato":{"type":"string","maxLength":100,"description":"Nome para contato."},"endereco":{"type":"string","maxLength":60,"description":"Endereço."},"endereco_numero":{"type":"string","maxLength":60,"description":"Número do endereço."},"bairro":{"type":"string","maxLength":60,"description":"Bairro."},"complemento":{"type":"string","maxLength":60,"description":"Complemento do endereço."},"estado":{"type":"string","maxLength":2,"description":"Sigla do estado."},"cidade":{"type":"string","maxLength":40,"description":"Código da cidade. Recebe o código IBGE ou o NOME da cidade."},"cep":{"type":"string","maxLength":10,"description":"CEP."},"codigo_pais":{"type":"string","maxLength":4,"description":"Código do país."},"separar_endereco":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Separar endereço (S/N)?"},"pesquisar_cep":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Pesquisar CEP (S/N)? Quando igual a S o sistema irá preencher os campos do endereço que estiverem vazios (logradouro, bairro e cidade) conforme os dados do CEP"},"telefone2_ddd":{"type":"string","maxLength":5,"description":"DDD do telefone 2."},"telefone2_numero":{"type":"string","maxLength":15,"description":"Número do telefone 2."},"fax_ddd":{"type":"string","maxLength":5,"description":"DDD do fax."},"fax_numero":{"type":"string","maxLength":15,"description":"Número do fax."},"email":{"type":"string","maxLength":500,"description":"E-mail."},"homepage":{"type":"string","maxLength":100,"description":"Website."},"inscricao_estadual":{"type":"string","maxLength":20,"description":"Inscrição estadual."},"inscricao_municipal":{"type":"string","maxLength":20,"description":"Inscrição municipal."},"inscricao_suframa":{"type":"string","maxLength":20,"description":"Inscrição Suframa."},"optante_simples_nacional":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Optante do Simples Nacional (S/N)?"},"tipo_atividade":{"type":"string","maxLength":1,"description":"Tipo da atividade."},"cnae":{"type":"string","maxLength":7,"description":"Código do CNAE."},"produtor_rural":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Produtor Rural (S/N)?"},"contribuinte":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Contribuinte (S/N)?"},"observacao":{"type":"string","description":"Observações internas."},"obs_detalhadas":{"type":"string","description":"Observações detalhadas."},"recomendacao_atraso":{"type":"string","maxLength":2,"description":"Código da instrução de protesto."},"tags":{"type":"array","items":{"type":"object","properties":{"tag":{"type":"string","maxLength":50}}},"description":"Tags do cliente ou fornecedor."},"pessoa_fisica":{"deprecated":true,"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Pessoa Física (S/N)? (Deprecated)"},"exterior":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Tomador de serviço localizado no exterior (S/N)?"},"logradouro":{"deprecated":true,"type":"string","maxLength":6,"description":"DEPRECATED"},"importado_api":{"deprecated":true,"type":"string","maxLength":1,"description":"DEPRECATED"},"bloqueado":{"deprecated":true,"type":"string","maxLength":1,"enum":["S","N"],"description":"DEPRECATED"},"cidade_ibge":{"type":"string","maxLength":7,"description":"Código do IBGE para a cidade."},"valor_limite_credito":{"type":"number","maxLength":18,"description":"Valor do limite de crédito total."},"bloquear_faturamento":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Bloquear o faturamento para o cliente (S/N)."},"recomendacoes":{"type":"object","properties":{"numero_parcelas":{"type":"string","maxLength":3,"description":"Número de parcelas padrão para as vendas."},"codigo_vendedor":{"type":"integer","maxLength":15,"description":"Código do vendedor padrão."},"email_fatura":{"type":"string","maxLength":200,"description":"Enviar a NF-e e boleto para outro e-mail?"},"gerar_boletos":{"type":"string","maxLength":1,"description":"Gerar boletos ao emitir NF-e?"},"codigo_transportadora":{"type":"integer","maxLength":15,"description":"Código da transportadora padrão."},"tipo_assinante":{"type":"string","maxLength":1,"description":"Tipo de assinante utilizado para notas fiscais via única (modelo 21 e 22)."}},"description":"Recomendações do cliente."},"enderecoEntrega":{"type":"object","properties":{"entRazaoSocial":{"type":"string","maxLength":60,"description":"Nome ou razão social"},"entCnpjCpf":{"type":"string","maxLength":20,"description":"CNPJ ou CPF do recebedor."},"entEndereco":{"type":"string","maxLength":60,"description":"Endereço."},"entNumero":{"type":"string","maxLength":60,"description":"Número do endereço."},"entComplemento":{"type":"string","maxLength":60,"description":"Complemento do endereço."},"entBairro":{"type":"string","maxLength":60,"description":"Bairro."},"entCEP":{"type":"string","maxLength":9,"description":"CEP."},"entEstado":{"type":"string","maxLength":2,"description":"Estado."},"entCidade":{"type":"string","maxLength":40,"description":"Cidade."},"entSepararEndereco":{"type":"string","maxLength":1,"example":"S","description":"Separar endereço. Valores possível S ou N, sendo N o padrão. Quando igual S separa do endereço o número o e complemento, caso existirem."},"entTelefone":{"type":"string","maxLength":15,"description":"Telefone."},"entIE":{"type":"string","maxLength":14,"description":"Inscrição estadual."}},"description":"Dados do endereço de entrega."},"nif":{"type":"string","maxLength":100,"description":"NIF - Número de Identificação Fiscal."},"documento_exterior":{"type":"string","maxLength":20,"description":"Documento no exterior para clientes estrangeiros."},"inativo":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Inativo (S/N)?"},"dadosBancarios":{"type":"object","properties":{"codigo_banco":{"type":"string","maxLength":3,"description":"Código do banco."},"agencia":{"type":"string","maxLength":10,"description":"Agência"},"conta_corrente":{"type":"string","maxLength":25,"description":"Número da conta corrente."},"doc_titular":{"type":"string","maxLength":20,"description":"CNPJ ou CPF do titular."},"nome_titular":{"type":"string","maxLength":60,"description":"Nome do titular."},"transf_padrao":{"type":"string","maxLength":1,"example":"S","description":"Definir transferência como forma de pagamento padrão?"},"cChavePix":{"type":"string","maxLength":60,"description":"Chave PIX."}},"description":"Dados bancários do cliente."},"caracteristicas":{"type":"array","items":{"type":"object","properties":{"campo":{"type":"string","maxLength":30,"description":"Nome da característica. Caso não encontre a característica um novo cadastro será adicionado.\n\nObrigatório em \"IncluirCliente\" e \"IncluirClientesPorLote\"; opcional nas demais operações que reutilizam esta estrutura, como \"AlterarCliente\" e \"UpsertCliente\"."},"conteudo":{"type":"string","maxLength":60,"description":"Conteúdo da característica. Caso o valor desse campo não seja informado a característica será excluída para o cliente ou fornecedor\n\nObrigatório em \"IncluirCliente\" e \"IncluirClientesPorLote\"; nas demais operações que reutilizam esta estrutura (ex.: \"AlterarCliente\"), omitir este campo é o comportamento válido para excluir a característica, conforme descrito acima."}}},"description":"Características do cliente ou fornecedor."},"enviar_anexos":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Enviar anexos por e-mail (S/N)? Esta função só poderá ser utilizada se o Portal Omie estiver ativo."},"info":{"type":"object","properties":{"dInc":{"type":"string","maxLength":10,"example":"31/12/2024","description":"Data da inclusão. No formato dd/mm/aaaa."},"hInc":{"type":"string","maxLength":8,"example":"23:59:59","description":"Hora da inclusão. No formato hh:mm:ss."},"uInc":{"type":"string","maxLength":10,"description":"Usuário da inclusão."},"dAlt":{"type":"string","maxLength":10,"example":"31/12/2024","description":"Data da alteração.\nNo formato dd/mm/aaaa."},"hAlt":{"type":"string","maxLength":8,"example":"23:59:59","description":"Hora da alteração.\nNo formato hh:mm:ss."},"uAlt":{"type":"string","maxLength":10,"description":"Usuário da alteração."},"cImpAPI":{"type":"string","maxLength":1,"example":"S","description":"Importado pela API (S/N)."}},"description":"Informações sobre o cadastro do cliente."},"bloquear_exclusao":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Bloqueia a exclusão do registro (S/N)?"}}}}},"example":{"call":"UpsertCliente","param":[{"codigo_cliente_integracao":"CodigoInterno0001","email":"primeiro@ccliente.com.br","razao_social":"Primeiro Cliente  Ltda Me","nome_fantasia":"Primeiro Cliente"}]}},"geral_clientes_UpsertCliente_retorno":{"type":"object","properties":{"codigo_cliente_omie":{"type":"integer"},"codigo_cliente_integracao":{"type":"string"},"codigo_status":{"type":"string"},"descricao_status":{"type":"string"}},"title":"UpsertCliente (retorno)"},"geral_clientes_UpsertClienteCpfCnpj":{"type":"object","title":"UpsertClienteCpfCnpj","description":"Realiza o UPSERT da tabela de clientes (INCLUSÃO/ALTERAÇÃO) com base no CPF/CNPJ informado.","required":["call","param"],"properties":{"call":{"type":"string","enum":["UpsertClienteCpfCnpj"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_cliente_omie":{"type":"integer","maxLength":15,"description":"Código de cliente ou fornecedor."},"codigo_cliente_integracao":{"type":"string","maxLength":60,"description":"Código de integração com sistemas legados."},"razao_social":{"type":"string","maxLength":60,"description":"Razão social."},"cnpj_cpf":{"type":"string","maxLength":20,"description":"CNPJ ou CPF."},"nome_fantasia":{"type":"string","maxLength":100,"description":"Nome fantasia."},"telefone1_ddd":{"type":"string","maxLength":5,"description":"DDD do telefone."},"telefone1_numero":{"type":"string","maxLength":15,"description":"Telefone para contato."},"contato":{"type":"string","maxLength":100,"description":"Nome para contato."},"endereco":{"type":"string","maxLength":60,"description":"Endereço."},"endereco_numero":{"type":"string","maxLength":60,"description":"Número do endereço."},"bairro":{"type":"string","maxLength":60,"description":"Bairro."},"complemento":{"type":"string","maxLength":60,"description":"Complemento do endereço."},"estado":{"type":"string","maxLength":2,"description":"Sigla do estado."},"cidade":{"type":"string","maxLength":40,"description":"Código da cidade. Recebe o código IBGE ou o NOME da cidade."},"cep":{"type":"string","maxLength":10,"description":"CEP."},"codigo_pais":{"type":"string","maxLength":4,"description":"Código do país."},"separar_endereco":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Separar endereço (S/N)?"},"pesquisar_cep":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Pesquisar CEP (S/N)? Quando igual a S o sistema irá preencher os campos do endereço que estiverem vazios (logradouro, bairro e cidade) conforme os dados do CEP"},"telefone2_ddd":{"type":"string","maxLength":5,"description":"DDD do telefone 2."},"telefone2_numero":{"type":"string","maxLength":15,"description":"Número do telefone 2."},"fax_ddd":{"type":"string","maxLength":5,"description":"DDD do fax."},"fax_numero":{"type":"string","maxLength":15,"description":"Número do fax."},"email":{"type":"string","maxLength":500,"description":"E-mail."},"homepage":{"type":"string","maxLength":100,"description":"Website."},"inscricao_estadual":{"type":"string","maxLength":20,"description":"Inscrição estadual."},"inscricao_municipal":{"type":"string","maxLength":20,"description":"Inscrição municipal."},"inscricao_suframa":{"type":"string","maxLength":20,"description":"Inscrição Suframa."},"optante_simples_nacional":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Optante do Simples Nacional (S/N)?"},"tipo_atividade":{"type":"string","maxLength":1,"description":"Tipo da atividade."},"cnae":{"type":"string","maxLength":7,"description":"Código do CNAE."},"produtor_rural":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Produtor Rural (S/N)?"},"contribuinte":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Contribuinte (S/N)?"},"observacao":{"type":"string","description":"Observações internas."},"obs_detalhadas":{"type":"string","description":"Observações detalhadas."},"recomendacao_atraso":{"type":"string","maxLength":2,"description":"Código da instrução de protesto."},"tags":{"type":"array","items":{"type":"object","properties":{"tag":{"type":"string","maxLength":50}}},"description":"Tags do cliente ou fornecedor."},"pessoa_fisica":{"deprecated":true,"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Pessoa Física (S/N)? (Deprecated)"},"exterior":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Tomador de serviço localizado no exterior (S/N)?"},"logradouro":{"deprecated":true,"type":"string","maxLength":6,"description":"DEPRECATED"},"importado_api":{"deprecated":true,"type":"string","maxLength":1,"description":"DEPRECATED"},"bloqueado":{"deprecated":true,"type":"string","maxLength":1,"enum":["S","N"],"description":"DEPRECATED"},"cidade_ibge":{"type":"string","maxLength":7,"description":"Código do IBGE para a cidade."},"valor_limite_credito":{"type":"number","maxLength":18,"description":"Valor do limite de crédito total."},"bloquear_faturamento":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Bloquear o faturamento para o cliente (S/N)."},"recomendacoes":{"type":"object","properties":{"numero_parcelas":{"type":"string","maxLength":3,"description":"Número de parcelas padrão para as vendas."},"codigo_vendedor":{"type":"integer","maxLength":15,"description":"Código do vendedor padrão."},"email_fatura":{"type":"string","maxLength":200,"description":"Enviar a NF-e e boleto para outro e-mail?"},"gerar_boletos":{"type":"string","maxLength":1,"description":"Gerar boletos ao emitir NF-e?"},"codigo_transportadora":{"type":"integer","maxLength":15,"description":"Código da transportadora padrão."},"tipo_assinante":{"type":"string","maxLength":1,"description":"Tipo de assinante utilizado para notas fiscais via única (modelo 21 e 22)."}},"description":"Recomendações do cliente."},"enderecoEntrega":{"type":"object","properties":{"entRazaoSocial":{"type":"string","maxLength":60,"description":"Nome ou razão social"},"entCnpjCpf":{"type":"string","maxLength":20,"description":"CNPJ ou CPF do recebedor."},"entEndereco":{"type":"string","maxLength":60,"description":"Endereço."},"entNumero":{"type":"string","maxLength":60,"description":"Número do endereço."},"entComplemento":{"type":"string","maxLength":60,"description":"Complemento do endereço."},"entBairro":{"type":"string","maxLength":60,"description":"Bairro."},"entCEP":{"type":"string","maxLength":9,"description":"CEP."},"entEstado":{"type":"string","maxLength":2,"description":"Estado."},"entCidade":{"type":"string","maxLength":40,"description":"Cidade."},"entSepararEndereco":{"type":"string","maxLength":1,"example":"S","description":"Separar endereço. Valores possível S ou N, sendo N o padrão. Quando igual S separa do endereço o número o e complemento, caso existirem."},"entTelefone":{"type":"string","maxLength":15,"description":"Telefone."},"entIE":{"type":"string","maxLength":14,"description":"Inscrição estadual."}},"description":"Dados do endereço de entrega."},"nif":{"type":"string","maxLength":100,"description":"NIF - Número de Identificação Fiscal."},"documento_exterior":{"type":"string","maxLength":20,"description":"Documento no exterior para clientes estrangeiros."},"inativo":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Inativo (S/N)?"},"dadosBancarios":{"type":"object","properties":{"codigo_banco":{"type":"string","maxLength":3,"description":"Código do banco."},"agencia":{"type":"string","maxLength":10,"description":"Agência"},"conta_corrente":{"type":"string","maxLength":25,"description":"Número da conta corrente."},"doc_titular":{"type":"string","maxLength":20,"description":"CNPJ ou CPF do titular."},"nome_titular":{"type":"string","maxLength":60,"description":"Nome do titular."},"transf_padrao":{"type":"string","maxLength":1,"example":"S","description":"Definir transferência como forma de pagamento padrão?"},"cChavePix":{"type":"string","maxLength":60,"description":"Chave PIX."}},"description":"Dados bancários do cliente."},"caracteristicas":{"type":"array","items":{"type":"object","properties":{"campo":{"type":"string","maxLength":30,"description":"Nome da característica. Caso não encontre a característica um novo cadastro será adicionado.\n\nObrigatório em \"IncluirCliente\" e \"IncluirClientesPorLote\"; opcional nas demais operações que reutilizam esta estrutura, como \"AlterarCliente\" e \"UpsertCliente\"."},"conteudo":{"type":"string","maxLength":60,"description":"Conteúdo da característica. Caso o valor desse campo não seja informado a característica será excluída para o cliente ou fornecedor\n\nObrigatório em \"IncluirCliente\" e \"IncluirClientesPorLote\"; nas demais operações que reutilizam esta estrutura (ex.: \"AlterarCliente\"), omitir este campo é o comportamento válido para excluir a característica, conforme descrito acima."}}},"description":"Características do cliente ou fornecedor."},"enviar_anexos":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Enviar anexos por e-mail (S/N)? Esta função só poderá ser utilizada se o Portal Omie estiver ativo."},"info":{"type":"object","properties":{"dInc":{"type":"string","maxLength":10,"example":"31/12/2024","description":"Data da inclusão. No formato dd/mm/aaaa."},"hInc":{"type":"string","maxLength":8,"example":"23:59:59","description":"Hora da inclusão. No formato hh:mm:ss."},"uInc":{"type":"string","maxLength":10,"description":"Usuário da inclusão."},"dAlt":{"type":"string","maxLength":10,"example":"31/12/2024","description":"Data da alteração.\nNo formato dd/mm/aaaa."},"hAlt":{"type":"string","maxLength":8,"example":"23:59:59","description":"Hora da alteração.\nNo formato hh:mm:ss."},"uAlt":{"type":"string","maxLength":10,"description":"Usuário da alteração."},"cImpAPI":{"type":"string","maxLength":1,"example":"S","description":"Importado pela API (S/N)."}},"description":"Informações sobre o cadastro do cliente."},"bloquear_exclusao":{"type":"string","maxLength":1,"example":"S","enum":["S","N"],"description":"Bloqueia a exclusão do registro (S/N)?"}}}}},"example":{"call":"UpsertClienteCpfCnpj","param":[{"cnpj_cpf":"80.716.929/0001-50","email":"primeiro@ccliente.com.br","razao_social":"Primeiro Cliente  Ltda Me","nome_fantasia":"Primeiro Cliente"}]}},"geral_clientes_UpsertClienteCpfCnpj_retorno":{"type":"object","properties":{"codigo_cliente_omie":{"type":"integer"},"codigo_cliente_integracao":{"type":"string"},"codigo_status":{"type":"string"},"descricao_status":{"type":"string"}},"title":"UpsertClienteCpfCnpj (retorno)"},"geral_clientescaract_AlterarCaractCliente":{"type":"object","title":"AlterarCaractCliente","description":"Altera uma característica de um cliente.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarCaractCliente"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_cliente_omie":{"type":"integer","maxLength":15,"description":"Código do cliente ou fornecedor."},"codigo_cliente_integracao":{"type":"string","maxLength":60,"description":"Código de integração com sistemas legados."},"campo":{"type":"string","maxLength":30,"description":"Nome da característica. Deve conter o nome exato da característica a ser alterada.\nCaso não encontre a característica um novo cadastro será adicionado."},"conteudo":{"type":"string","maxLength":60,"description":"Conteúdo da característica."}},"required":["campo","conteudo"]}}},"example":{"call":"AlterarCaractCliente","param":[{"codigo_cliente_omie":0,"codigo_cliente_integracao":"","campo":"","conteudo":""}]}},"geral_clientescaract_AlterarCaractCliente_retorno":{"type":"object","properties":{"codigo_cliente_omie":{"type":"integer","description":"Código do cliente ou fornecedor."},"codigo_cliente_integracao":{"type":"string","description":"Código de integração com sistemas legados."},"codigo_status":{"type":"string","description":"Código do status de processamento."},"descricao_status":{"type":"string","description":"Descrição do status de processamento."}},"title":"AlterarCaractCliente (retorno)"},"geral_clientescaract_ConsultarCaractCliente":{"type":"object","title":"ConsultarCaractCliente","description":"Consultar todas as características do cliente ou fornecedor","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarCaractCliente"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_cliente_omie":{"type":"integer","maxLength":15,"description":"Código do cliente ou fornecedor."},"codigo_cliente_integracao":{"type":"string","maxLength":60,"description":"Código de integração com sistemas legados."}}}}},"example":{"call":"ConsultarCaractCliente","param":[{"codigo_cliente_omie":0,"codigo_cliente_integracao":""}]}},"geral_clientescaract_ConsultarCaractCliente_retorno":{"type":"object","properties":{"codigo_cliente_omie":{"type":"integer","description":"Código do cliente ou fornecedor."},"codigo_cliente_integracao":{"type":"string","description":"Código de integração com sistemas legados."},"caracteristicas":{"type":"array","items":{"type":"object","properties":{"campo":{"type":"string","description":"Nome da característica. Caso não encontre a característica um novo cadastro será adicionado."},"conteudo":{"type":"string","description":"Conteúdo da característica. Caso o valor desse campo não seja informado a característica será excluída para o cliente ou fornecedor."}}},"description":"Características do cliente ou fornecedor."}},"title":"ConsultarCaractCliente (retorno)"},"geral_clientescaract_ExcluirCaractCliente":{"type":"object","title":"ExcluirCaractCliente","description":"Exclui uma característica para o cliente ou fornecedor.\nPara remover todas as características de uma vez, use \"ExcluirTodasCaractCliente\".","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirCaractCliente"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_cliente_omie":{"type":"integer","maxLength":15,"description":"Código do cliente ou fornecedor."},"codigo_cliente_integracao":{"type":"string","maxLength":60,"description":"Código de integração com sistemas legados."},"campo":{"type":"string","maxLength":30,"description":"Nome da característica.\nCaso não encontre a característica um novo cadastro será adicionado."}},"required":["campo"]}}},"example":{"call":"ExcluirCaractCliente","param":[{"codigo_cliente_omie":0,"codigo_cliente_integracao":"","campo":""}]}},"geral_clientescaract_ExcluirCaractCliente_retorno":{"type":"object","properties":{"codigo_cliente_omie":{"type":"integer","description":"Código do cliente ou fornecedor."},"codigo_cliente_integracao":{"type":"string","description":"Código de integração com sistemas legados."},"codigo_status":{"type":"string","description":"Código do status de processamento."},"descricao_status":{"type":"string","description":"Descrição do status de processamento."}},"title":"ExcluirCaractCliente (retorno)"},"geral_clientescaract_ExcluirTodasCaractCliente":{"type":"object","title":"ExcluirTodasCaractCliente","description":"Exclui todas as características para o cliente ou fornecedor.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirTodasCaractCliente"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_cliente_omie":{"type":"integer","maxLength":15,"description":"Código do cliente ou fornecedor."},"codigo_cliente_integracao":{"type":"string","maxLength":60,"description":"Código de integração com sistemas legados."}}}}},"example":{"call":"ExcluirTodasCaractCliente","param":[{"codigo_cliente_omie":0,"codigo_cliente_integracao":""}]}},"geral_clientescaract_ExcluirTodasCaractCliente_retorno":{"type":"object","properties":{"codigo_cliente_omie":{"type":"integer","description":"Código do cliente ou fornecedor"},"codigo_cliente_integracao":{"type":"string","description":"Código de integração com sistemas legados."},"codigo_status":{"type":"string","description":"Código do status de processamento."},"descricao_status":{"type":"string","description":"Descrição do status de processamento."}},"title":"ExcluirTodasCaractCliente (retorno)"},"geral_clientescaract_IncluirCaractCliente":{"type":"object","title":"IncluirCaractCliente","description":"Inclui uma característica para o cliente ou fornecedor.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirCaractCliente"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_cliente_omie":{"type":"integer","maxLength":15,"description":"Código do cliente ou fornecedor."},"codigo_cliente_integracao":{"type":"string","maxLength":60,"description":"Código de integração com sistemas legados."},"campo":{"type":"string","maxLength":30,"description":"Nome da característica.\n\nCaso não encontre a característica um novo cadastro será adicionado."},"conteudo":{"type":"string","maxLength":60,"description":"Conteúdo da característica."}},"required":["campo","conteudo"]}}},"example":{"call":"IncluirCaractCliente","param":[{"codigo_cliente_omie":0,"codigo_cliente_integracao":"","campo":"","conteudo":""}]}},"geral_clientescaract_IncluirCaractCliente_retorno":{"type":"object","properties":{"codigo_cliente_omie":{"type":"integer","description":"Código do cliente ou fornecedor."},"codigo_cliente_integracao":{"type":"string","description":"Código de integração com sistemas legados."},"codigo_status":{"type":"string","description":"Código do status de processamento."},"descricao_status":{"type":"string","description":"Descrição do status de processamento."}},"title":"IncluirCaractCliente (retorno)"},"geral_clientetag_ExcluirTags":{"type":"object","title":"ExcluirTags","description":"Remove tags associadas a um cliente.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirTags"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodCliente":{"type":"integer","maxLength":15,"description":"Código do cliente.\n(Código interno utilizado apenas na API, não aparece na tela)."},"cCodIntCliente":{"type":"string","maxLength":60,"description":"Código de integração do cliente.\n(Utilizado para integração via API, não aparece na tela)"},"tags":{"type":"array","items":{"type":"object","properties":{"tag":{"type":"string","maxLength":50}}},"description":"Tags do Cliente ou Fornecedor"}}}}},"example":{"call":"ExcluirTags","param":[{"nCodCliente":0,"cCodIntCliente":"","tags":[{"tag":"Grupo A"},{"tag":"Grupo B"}]}]}},"geral_clientetag_ExcluirTags_retorno":{"type":"object","properties":{"nCodCliente":{"type":"integer","description":"Código do cliente. (Código interno utilizado apenas na API, não aparece na tela)."},"cCodIntCliente":{"type":"string","description":"Código de integração do cliente. (Utilizado para integração via API, não aparece na tela)"},"cCodStatus":{"type":"string","description":"Código do Status."},"cDesStatus":{"type":"string","description":"Descrição do Status."}},"title":"ExcluirTags (retorno)"},"geral_clientetag_ExcluirTodas":{"type":"object","title":"ExcluirTodas","description":"Remove todas as tags associadas a um cliente.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirTodas"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodCliente":{"type":"integer","maxLength":15,"description":"Código do cliente.\n(Código interno utilizado apenas na API, não aparece na tela)."},"cCodIntCliente":{"type":"string","maxLength":60,"description":"Código de integração do cliente.\n(Utilizado para integração via API, não aparece na tela)"}}}}},"example":{"call":"ExcluirTodas","param":[{"nCodCliente":0,"cCodIntCliente":""}]}},"geral_clientetag_ExcluirTodas_retorno":{"type":"object","properties":{"nCodCliente":{"type":"integer","description":"Código do cliente. (Código interno utilizado apenas na API, não aparece na tela)."},"cCodIntCliente":{"type":"string","description":"Código de integração do cliente. (Utilizado para integração via API, não aparece na tela)"},"cCodStatus":{"type":"string","description":"Código do Status."},"cDesStatus":{"type":"string","description":"Descrição do Status."}},"title":"ExcluirTodas (retorno)"},"geral_clientetag_IncluirTags":{"type":"object","title":"IncluirTags","description":"Associa tags a um cliente.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirTags"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodCliente":{"type":"integer","maxLength":15,"description":"Código do cliente.\n(Código interno utilizado apenas na API, não aparece na tela)."},"cCodIntCliente":{"type":"string","maxLength":60,"description":"Código de integração do cliente.\n(Utilizado para integração via API, não aparece na tela)"},"tags":{"type":"array","items":{"type":"object","properties":{"tag":{"type":"string","maxLength":50}}},"description":"Tags do Cliente ou Fornecedor"}}}}},"example":{"call":"IncluirTags","param":[{"nCodCliente":0,"cCodIntCliente":"","tags":[{"tag":"Grupo A"},{"tag":"Grupo B"}]}]}},"geral_clientetag_IncluirTags_retorno":{"type":"object","properties":{"nCodCliente":{"type":"integer","description":"Código do cliente. (Código interno utilizado apenas na API, não aparece na tela)."},"cCodIntCliente":{"type":"string","description":"Código de integração do cliente. (Utilizado para integração via API, não aparece na tela)"},"cCodStatus":{"type":"string","description":"Código do Status."},"cDesStatus":{"type":"string","description":"Descrição do Status."},"tagsLista":{"type":"array","items":{"type":"object","properties":{"tag":{"type":"string"},"nCodTag":{"type":"integer","description":"Código da Tag. Criada pelo Omie no momento da inclusão."}}},"description":"Tags do Cliente ou Fornecedor."}},"title":"IncluirTags (retorno)"},"geral_clientetag_ListarTags":{"type":"object","title":"ListarTags","description":"Lista as tags de um determinado cliente.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarTags"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodCliente":{"type":"integer","maxLength":15,"description":"Código do cliente.\n(Código interno utilizado apenas na API, não aparece na tela)."},"cCodIntCliente":{"type":"string","maxLength":60,"description":"Código de integração do cliente.\n(Utilizado para integração via API, não aparece na tela)"}}}}},"example":{"call":"ListarTags","param":[{"nCodCliente":0,"cCodIntCliente":""}]}},"geral_clientetag_ListarTags_retorno":{"type":"object","properties":{"nCodCliente":{"type":"integer","description":"Código do cliente. (Código interno utilizado apenas na API, não aparece na tela)."},"cCodIntCliente":{"type":"string","description":"Código de integração do cliente. (Utilizado para integração via API, não aparece na tela)"},"tagsLista":{"type":"array","items":{"type":"object","properties":{"tag":{"type":"string"},"nCodTag":{"type":"integer","description":"Código da Tag. Criada pelo Omie no momento da inclusão."}}},"description":"Tags do Cliente ou Fornecedor."}},"title":"ListarTags (retorno)"},"geral_contacorrente_AlterarContaCorrente":{"type":"object","title":"AlterarContaCorrente","description":"Altera a Conta Corrente","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarContaCorrente"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodCC":{"type":"integer","maxLength":15,"description":"Código da conta corrente."},"cCodCCInt":{"type":"string","maxLength":20,"description":"Código de Integração do parceiro."},"tipo_conta_corrente":{"type":"string","maxLength":2,"description":"Código da conta corrente no Omie.\n\nPode ser:\nAC - Administradora de Cartões\nAD - Adiantamento\nCA - Conta Aplicação\nCC - Conta Corrente\nCE - Conta Empréstimo\nCG - Conta Garantida\nCN - Crediário / Carnê\nCP - Conta Poupança\nCR - Cartão de Crédito\nCV - Carteira Virtual\nCX - Caixinha\nMT - Mútuo\nPG - Conta de Pagamento"},"codigo_banco":{"type":"string","maxLength":3,"description":"Código do Banco / Instituição Financeira,\n\nPode ser:\n\n001 - Banco do Brasil\n003 - Banco da Amazônia\n004 - Banco do Nordeste\n017 - BNY Mellon Banco S.A.\n021 - Banestes\n025 - Alfa\n029 - Banerj\n033 - Santander\n037 - Banpará\n041 - Banrisul\n047 - Banese\n069 - Banco Crefisa S.A.\n070 - BRB - Banco de Brasília\n077 - Banco Inter\n082 - Banco Topázio\n083 - China Brasil\n084 - Uniprime Norte do Paraná\n085 - Ailos (Cecred)\n089 - Credisan\n090 - Unicred\n091 - Unicred Central do Rio Grande do Sul\n093 - PoloCred\n094 - Finaxis\n095 - Confidence\n096 - Banco BM&F Bovespa\n097 - CrediSIS\n099 - Uniprime\n102 - XP Investimentos\n104 - Caixa Econômica Federal\n121 - Agiplan\n124 - Woori Bank\n125 - Brasil Plural\n128 - MS Bank\n132 - ICBC do Brasil\n133 - Cresol\n136 - Centrais Unicreds\n147 - Rico\n151 - Nossa Caixa\n177 - SC Guide\n197 - Stone\n208 - BTG Pactual\n212 - Original\n213 - ARBI\n218 - Banco Bonsucesso\n224 - Fibra\n233 - Banco Cifra\n237 - Bradesco\n243 - Banco Máxima\n246 - Banco ABC Brasil\n250 - BCV - Banco de Crédito e Varejo\n254 - ParanáBanco\n260 - Nubank\n274 - BMP Money Plus\n278 - Geração Futuro\n279 - Primacredi\n280 - LiftBank\n290 - PagBank (PagSeguro)\n301 - BPP Instituição de Pagamento\n318 - Banco BMG\n320 - BIC Banco Industrial e Comercial\n323 - Mercado Pago\n329 - QI Tech\n336 - C6 Bank\n341 - Itaú Unibanco\n354 - Necton\n364 - Gerencianet\n376 - J. P. Morgan\n389 - Banco Mercantil do Brasil\n399 - HSBC Bank\n422 - Safra\n453 - Banco Rural S.A.\n456 - Banco de Tokyo\n464 - Banco Sumitomo Mitsui Brasileiro\n473 - Caixa Geral\n487 - Deutsche Bank\n505 - Credit Suisse\n600 - Banco Luso Brasileiro\n604 - Banco Industrial do Brasil\n609 - Crebit\n610 - Lucree\n611 - Banco Paulista\n612 - Banco Guanabara\n613 - Omni Soluções Financeiras\n623 - Banco Panamericano S.A.\n630 - Omie.CASH\n633 - Rendimento\n634 - Banco Triângulo S.A.\n637 - Sofisa\n643 - Pine\n644 - Wall Securitizadora\n646 - Wirecard\n647 - B-Link Securitizadora\n648 - Servicoop\n649 - Select Administradora de Bens\n650 - SuperGet\n653 - Indusval\n654 - Banco Renner\n655 - Votorantim\n656 - DLM Invista\n657 - UnionPay\n658 - Zoop\n659 - Flash Benefícios\n660 - Warren\n661 - AvecPay\n662 - WabiPay\n663 - WabiPay\n664 - Credit Partners\n665 - Millennium Bcp\n666 - Porto Seguro\n667 - Fidussia\n668 - Silicon Valley Bank\n669 - ArgosBank\n670 - Brasil Cash\n671 - Metal Credit Securitizadora\n672 - FacilitaPay\n673 - Ceape\n674 - CBH - Compagnie Bancaire Helvetique\n675 - One7\n676 - Griffin Capital S/A\n677 - Midas Securitizadora\n678 - PeixePay\n679 - InfinitePay\n680 - Lado Serviços de Cobrança\n681 - Rodolfo Factoring\n682 - CR Factoring\n683 - Ben Benefícios\n684 - Loggi\n685 - BRDE\n686 - Cotação\n687 - Olist\n688 - Amazon\n689 - Investcamp\n690 - SulBrasil\n691 - Seven Investimentos\n692 - Lotus\n693 - Grupo Multiplica\n694 - Trevys Fidic\n696 - Valori Bank\n697 - Evo Pagamentos\n698 - Direct Cred\n699 - EngagED\n700 - Finpet\n707 - Banco Daycoval\n712 - Ourinvest\n719 - Banif\n735 - Neon / Pottencial\n741 - Banco Ribeirão Preto\n743 - Banco Semear\n745 - Citibank S.A.\n746 - Banco Modal\n747 - Rabobank International Brasil\n748 - Sicredi\n752 - BNP Paribas\n755 - Bank of America Merrill Lynch\n756 - Sicoob\n772 - Gol Securitizadora\n773 - Centerin Fomento\n774 - Sals-Fac Factoring\n775 - Social Bank\n776 - Conta Simples\n777 - Credicard\n778 - Credicard\n779 - Banricard\n780 - Akirede\n781 - Adiq\n782 - A55"},"descricao":{"type":"string","maxLength":40,"description":"Descrição da conta corrente."},"codigo_agencia":{"type":"string","maxLength":10,"description":"Código da Agência da Conta Corrente"},"numero_conta_corrente":{"type":"string","maxLength":25,"description":"Número da Conta Corrente"},"saldo_inicial":{"type":"number","maxLength":18,"description":"Saldo Inicial da Conta Corrente"},"saldo_data":{"type":"string","maxLength":10,"description":"Data do Saldo Inicial da Conta Corrente"},"valor_limite":{"type":"number","maxLength":18,"description":"Valor do Limite do Crédito"},"nao_fluxo":{"type":"string","maxLength":1,"description":"Não exibir no Fluxo de Caixa"},"nao_resumo":{"type":"string","maxLength":1,"description":"Não exibir no Resumo de Finanças"},"observacao":{"type":"string","description":"Observação"},"cobr_sn":{"type":"string","maxLength":1,"description":"Indica se realiza Cobrança Bancária para a conta corrente [S/N]"},"per_juros":{"type":"number","maxLength":10,"description":"Percentual de Juros ao Mês"},"per_multa":{"type":"number","maxLength":10,"description":"Percentual de Multa"},"bol_instr1":{"type":"string","maxLength":80,"description":"Mensagem de Instrução do Boleto - Linha 1"},"bol_instr2":{"type":"string","maxLength":80,"description":"Mensagem de Instrução do Boleto - Linha 2"},"bol_instr3":{"type":"string","maxLength":80,"description":"Mensagem de Instrução do Boleto - Linha 3"},"bol_instr4":{"type":"string","maxLength":80,"description":"Mensagem de Instrução do Boleto - Linha 4"},"bol_sn":{"type":"string","maxLength":1,"description":"Indica se emite Boletos de Cobrança [S/N]"},"pix_sn":{"type":"string","maxLength":1,"description":"Indica se emite PIX [S/N]"},"cnab_esp":{"type":"string","maxLength":2,"description":"Espécie padrão para a Remessa de Cobrança"},"cobr_esp":{"type":"string","maxLength":3,"description":"Espécie padrão para o Boleto de Cobrança"},"dias_rcomp":{"type":"integer","maxLength":2,"description":"Dias para Compensação dos Recebimentos"},"modalidade":{"type":"string","maxLength":3,"description":"Modalidade da Cobrança"},"cancinstr":{"type":"string","maxLength":3,"description":"Código de Instrução de Cancelamento, Baixa ou Devolução"},"pdv_enviar":{"type":"string","maxLength":1,"description":"Utiliza a Conta Corrente no OmiePDV"},"pdv_sincr_analitica":{"type":"string","maxLength":1,"description":"Sincronização Analítica para a Conta Corrente (Venda a Venda)"},"pdv_dias_venc":{"type":"integer","maxLength":3,"description":"Dias para Vencimento"},"pdv_num_parcelas":{"type":"integer","maxLength":2,"description":"Número de Parcelas"},"pdv_tipo_tef":{"type":"integer","maxLength":2,"description":"Tipo de TEF: 1-Nenhum 3-Paygo X-SITEF"},"pdv_cod_adm":{"type":"integer","maxLength":15,"description":"Código da Adminstradora de Cartão"},"pdv_limite_pacelas":{"type":"integer","maxLength":2,"description":"Limite máximo de parcelas"},"pdv_taxa_loja":{"type":"number","maxLength":6,"description":"Taxa de Juros da Loja"},"pdv_taxa_adm":{"type":"number","maxLength":6,"description":"Taxa da operadora"},"pdv_categoria":{"type":"string","maxLength":20,"description":"Código da Categoria para o PDV."},"pdv_bandeira":{"type":"string","maxLength":70,"description":"Bandeira do Cartão.\n\nUtilize a tag \"cCodigo\" do método \"ListarBandeira\" da API\n/api/v1/geral/bandeiracartao/\npara obter essa informação."},"cCnpjInstFinanc":{"type":"string","maxLength":20,"description":"CNPJ da instituição financeira."},"cTipoCartao":{"type":"string","maxLength":1,"description":"Tipo de Cartão para Administradoras de Cartão.\n\nPode ser:\n\n0 - Débito e Crédito.\n1 - Débito.\n2 - Crédito."},"cEstabelecimento":{"type":"string","maxLength":70,"description":"Indica o código do estabelecimento."},"nome_gerente":{"type":"string","maxLength":40,"description":"Nome do gerente da conta corrente."},"ddd":{"type":"string","maxLength":5,"description":"DDD do Telefone de Contato do Gerente da Agência"},"telefone":{"type":"string","maxLength":15,"description":"Telefone de Contato do Gerente da Agência"},"email":{"type":"string","maxLength":200,"description":"E-mail do Gerente da Conta Corrente"},"endereco":{"type":"string","maxLength":50,"description":"Endereço da Agência"},"numero":{"type":"string","maxLength":5,"description":"Número do Endereço"},"bairro":{"type":"string","maxLength":60,"description":"Bairro"},"complemento":{"type":"string","maxLength":15,"description":"Complemento do Número do Endereço"},"estado":{"type":"string","maxLength":2,"description":"Estado da Agência"},"cidade":{"type":"string","maxLength":40,"description":"Cidade da Agência"},"cep":{"type":"string","maxLength":9,"description":"CEP da Agência"},"codigo_pais":{"type":"string","maxLength":4,"description":"Código do País"},"data_inc":{"type":"string","maxLength":10,"description":"Data de Inclusão"},"hora_inc":{"type":"string","maxLength":8,"description":"Hora de Inclusão"},"user_inc":{"type":"string","maxLength":10,"description":"Usuário da Inclusão"},"data_alt":{"type":"string","maxLength":10,"description":"Data de alteração"},"hora_alt":{"type":"string","maxLength":8,"description":"Hora de Alteração"},"user_alt":{"type":"string","maxLength":10,"description":"Usuário de Alteração"},"importado_api":{"type":"string","maxLength":1,"description":"Registro importado pela API"},"bloqueado":{"type":"string","maxLength":1,"description":"Registro Bloqueado pela API"},"inativo":{"type":"string","maxLength":1,"description":"Indica se o cadastro da conta corrente está inativo (S/N)."}}}}},"example":{"call":"AlterarContaCorrente","param":[{"cCodCCInt":"MyCC0001","tipo_conta_corrente":"CX","codigo_banco":"999","descricao":"Caixinha","saldo_inicial":0}]}},"geral_contacorrente_AlterarContaCorrente_retorno":{"type":"object","properties":{"nCodCC":{"type":"integer"},"cCodCCInt":{"type":"string"},"cCodStatus":{"type":"string","description":"Código do status"},"cDesStatus":{"type":"string","description":"Descrição do Status"}},"title":"AlterarContaCorrente (retorno)"},"geral_contacorrente_ConsultarContaCorrente":{"type":"object","title":"ConsultarContaCorrente","description":"Realiza a consulta de uma conta corrente","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarContaCorrente"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodCC":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente"},"cCodCCInt":{"type":"string","maxLength":20,"description":"Código de Integração da Conta Corrente"}}}}},"example":{"call":"ConsultarContaCorrente","param":[{"nCodCC":0,"cCodCCInt":""}]}},"geral_contacorrente_ConsultarContaCorrente_retorno":{"type":"object","properties":{"nCodCC":{"type":"integer","description":"Código da conta corrente."},"cCodCCInt":{"type":"string","description":"Código de Integração do parceiro."},"tipo_conta_corrente":{"type":"string","description":"Código da conta corrente no Omie. Pode ser: AC - Administradora de Cartões AD - Adiantamento CA - Conta Aplicação CC - Conta Corrente CE - Conta Empréstimo CG - Conta Garantida CN - Crediário / Carnê CP - Conta Poupança CR - Cartão de Crédito CV - Carteira Virtual CX - Caixinha MT - Mútuo PG - Conta de Pagamento"},"codigo_banco":{"type":"string","description":"Código do Banco / Instituição Financeira, Pode ser: 001 - Banco do Brasil 003 - Banco da Amazônia 004 - Banco do Nordeste 017 - BNY Mellon Banco S.A. 021 - Banestes 025 - Alfa 029 - Banerj 033 - Santander 037 - Banpará 041 - Banrisul 047 - Banese 069 - Banco Crefisa S.A. 070 - BRB - Banco de Brasília 077 - Banco Inter 082 - Banco Topázio 083 - China Brasil 084 - Uniprime Norte do Paraná 085 - Ailos (Cecred) 089 - Credisan 090 - Unicred 091 - Unicred Central do Rio Grande do Sul 093 - PoloCred 094 - Finaxis 095 - Confidence 096 - Banco BM&F Bovespa 097 - CrediSIS 099 - Uniprime 102 - XP Investimentos 104 - Caixa Econômica Federal 121 - Agiplan 124 - Woori Bank 125 - Brasil Plural 128 - MS Bank 132 - ICBC do Brasil 133 - Cresol 136 - Centrais Unicreds 147 - Rico 151 - Nossa Caixa 177 - SC Guide 197 - Stone 208 - BTG Pactual 212 - Original 213 - ARBI 218 - Banco Bonsucesso 224 - Fibra 233 - Banco Cifra 237 - Bradesco 243 - Banco Máxima 246 - Banco ABC Brasil 250 - BCV - Banco de Crédito e Varejo 254 - ParanáBanco 260 - Nubank 274 - BMP Money Plus 278 - Geração Futuro 279 - Primacredi 280 - LiftBank 290 - PagBank (PagSeguro) 301 - BPP Instituição de Pagamento 318 - Banco BMG 320 - BIC Banco Industrial e Comercial 323 - Mercado Pago 329 - QI Tech 336 - C6 Bank 341 - Itaú Unibanco 354 - Necton 364 - Gerencianet 376 - J. P. Morgan 389 - Banco Mercantil do Brasil 399 - HSBC Bank 422 - Safra 453 - Banco Rural S.A. 456 - Banco de Tokyo 464 - Banco Sumitomo Mitsui Brasileiro 473 - Caixa Geral 487 - Deutsche Bank 505 - Credit Suisse 600 - Banco Luso Brasileiro 604 - Banco Industrial do Brasil 609 - Crebit 610 - Lucree 611 - Banco Paulista 612 - Banco Guanabara 613 - Omni Soluções Financeiras 623 - Banco Panamericano S.A. 630 - Omie.CASH 633 - Rendimento 634 - Banco Triângulo S.A. 637 - Sofisa 643 - Pine 644 - Wall Securitizadora 646 - Wirecard 647 - B-Link Securitizadora 648 - Servicoop 649 - Select Administradora de Bens 650 - SuperGet 653 - Indusval 654 - Banco Renner 655 - Votorantim 656 - DLM Invista 657 - UnionPay 658 - Zoop 659 - Flash Benefícios 660 - Warren 661 - AvecPay 662 - WabiPay 663 - WabiPay 664 - Credit Partners 665 - Millennium Bcp 666 - Porto Seguro 667 - Fidussia 668 - Silicon Valley Bank 669 - ArgosBank 670 - Brasil Cash 671 - Metal Credit Securitizadora 672 - FacilitaPay 673 - Ceape 674 - CBH - Compagnie Bancaire Helvetique 675 - One7 676 - Griffin Capital S/A 677 - Midas Securitizadora 678 - PeixePay 679 - InfinitePay 680 - Lado Serviços de Cobrança 681 - Rodolfo Factoring 682 - CR Factoring 683 - Ben Benefícios 684 - Loggi 685 - BRDE 686 - Cotação 687 - Olist 688 - Amazon 689 - Investcamp 690 - SulBrasil 691 - Seven Investimentos 692 - Lotus 693 - Grupo Multiplica 694 - Trevys Fidic 696 - Valori Bank 697 - Evo Pagamentos 698 - Direct Cred 699 - EngagED 700 - Finpet 707 - Banco Daycoval 712 - Ourinvest 719 - Banif 735 - Neon / Pottencial 741 - Banco Ribeirão Preto 743 - Banco Semear 745 - Citibank S.A. 746 - Banco Modal 747 - Rabobank International Brasil 748 - Sicredi 752 - BNP Paribas 755 - Bank of America Merrill Lynch 756 - Sicoob 772 - Gol Securitizadora 773 - Centerin Fomento 774 - Sals-Fac Factoring 775 - Social Bank 776 - Conta Simples 777 - Credicard 778 - Credicard 779 - Banricard 780 - Akirede 781 - Adiq 782 - A55"},"descricao":{"type":"string","description":"Descrição da conta corrente."},"codigo_agencia":{"type":"string","description":"Código da Agência da Conta Corrente"},"numero_conta_corrente":{"type":"string","description":"Número da Conta Corrente"},"saldo_inicial":{"type":"decimal","description":"Saldo Inicial da Conta Corrente"},"saldo_data":{"type":"string","description":"Data do Saldo Inicial da Conta Corrente"},"valor_limite":{"type":"decimal","description":"Valor do Limite do Crédito"},"nao_fluxo":{"type":"string","description":"Não exibir no Fluxo de Caixa"},"nao_resumo":{"type":"string","description":"Não exibir no Resumo de Finanças"},"observacao":{"type":"string","description":"Observação"},"cobr_sn":{"type":"string","description":"Indica se realiza Cobrança Bancária para a conta corrente [S/N]"},"per_juros":{"type":"decimal","description":"Percentual de Juros ao Mês"},"per_multa":{"type":"decimal","description":"Percentual de Multa"},"bol_instr1":{"type":"string","description":"Mensagem de Instrução do Boleto - Linha 1"},"bol_instr2":{"type":"string","description":"Mensagem de Instrução do Boleto - Linha 2"},"bol_instr3":{"type":"string","description":"Mensagem de Instrução do Boleto - Linha 3"},"bol_instr4":{"type":"string","description":"Mensagem de Instrução do Boleto - Linha 4"},"bol_sn":{"type":"string","description":"Indica se emite Boletos de Cobrança [S/N]"},"pix_sn":{"type":"string","description":"Indica se emite PIX [S/N]"},"cnab_esp":{"type":"string","description":"Espécie padrão para a Remessa de Cobrança"},"cobr_esp":{"type":"string","description":"Espécie padrão para o Boleto de Cobrança"},"dias_rcomp":{"type":"integer","description":"Dias para Compensação dos Recebimentos"},"modalidade":{"type":"string","description":"Modalidade da Cobrança"},"cancinstr":{"type":"string","description":"Código de Instrução de Cancelamento, Baixa ou Devolução"},"pdv_enviar":{"type":"string","description":"Utiliza a Conta Corrente no OmiePDV"},"pdv_sincr_analitica":{"type":"string","description":"Sincronização Analítica para a Conta Corrente (Venda a Venda)"},"pdv_dias_venc":{"type":"integer","description":"Dias para Vencimento"},"pdv_num_parcelas":{"type":"integer","description":"Número de Parcelas"},"pdv_tipo_tef":{"type":"integer","description":"Tipo de TEF: 1-Nenhum 3-Paygo X-SITEF"},"pdv_cod_adm":{"type":"integer","description":"Código da Adminstradora de Cartão"},"pdv_limite_pacelas":{"type":"integer","description":"Limite máximo de parcelas"},"pdv_taxa_loja":{"type":"decimal","description":"Taxa de Juros da Loja"},"pdv_taxa_adm":{"type":"decimal","description":"Taxa da operadora"},"pdv_categoria":{"type":"string","description":"Código da Categoria para o PDV."},"pdv_bandeira":{"type":"string","description":"Bandeira do Cartão. Utilize a tag \"cCodigo\" do método \"ListarBandeira\" da API /api/v1/geral/bandeiracartao/ para obter essa informação."},"cCnpjInstFinanc":{"type":"string","description":"CNPJ da instituição financeira."},"cTipoCartao":{"type":"string","description":"Tipo de Cartão para Administradoras de Cartão. Pode ser: 0 - Débito e Crédito. 1 - Débito. 2 - Crédito."},"cEstabelecimento":{"type":"string","description":"Indica o código do estabelecimento."},"nome_gerente":{"type":"string","description":"Nome do gerente da conta corrente."},"ddd":{"type":"string","description":"DDD do Telefone de Contato do Gerente da Agência"},"telefone":{"type":"string","description":"Telefone de Contato do Gerente da Agência"},"email":{"type":"string","description":"E-mail do Gerente da Conta Corrente"},"endereco":{"type":"string","description":"Endereço da Agência"},"numero":{"type":"string","description":"Número do Endereço"},"bairro":{"type":"string","description":"Bairro"},"complemento":{"type":"string","description":"Complemento do Número do Endereço"},"estado":{"type":"string","description":"Estado da Agência"},"cidade":{"type":"string","description":"Cidade da Agência"},"cep":{"type":"string","description":"CEP da Agência"},"codigo_pais":{"type":"string","description":"Código do País"},"data_inc":{"type":"string","description":"Data de Inclusão"},"hora_inc":{"type":"string","description":"Hora de Inclusão"},"user_inc":{"type":"string","description":"Usuário da Inclusão"},"data_alt":{"type":"string","description":"Data de alteração"},"hora_alt":{"type":"string","description":"Hora de Alteração"},"user_alt":{"type":"string","description":"Usuário de Alteração"},"importado_api":{"type":"string","description":"Registro importado pela API"},"bloqueado":{"type":"string","description":"Registro Bloqueado pela API"},"inativo":{"type":"string","description":"Indica se o cadastro da conta corrente está inativo (S/N)."}},"title":"ConsultarContaCorrente (retorno)"},"geral_contacorrente_ExcluirContaCorrente":{"type":"object","title":"ExcluirContaCorrente","description":"Excluir a Conta Corrente","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirContaCorrente"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodCC":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente"},"cCodCCInt":{"type":"string","maxLength":20,"description":"Código de Integração da Conta Corrente"}}}}},"example":{"call":"ExcluirContaCorrente","param":[{"nCodCC":0,"cCodCCInt":""}]}},"geral_contacorrente_ExcluirContaCorrente_retorno":{"type":"object","properties":{"nCodCC":{"type":"integer"},"cCodCCInt":{"type":"string"},"cCodStatus":{"type":"string","description":"Código do status"},"cDesStatus":{"type":"string","description":"Descrição do Status"}},"title":"ExcluirContaCorrente (retorno)"},"geral_contacorrente_IncluirContaCorrente":{"type":"object","title":"IncluirContaCorrente","description":"Inclui uma conta corrente","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirContaCorrente"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodCC":{"type":"integer","maxLength":15,"description":"Código da conta corrente."},"cCodCCInt":{"type":"string","maxLength":20,"description":"Código de Integração do parceiro."},"tipo_conta_corrente":{"type":"string","maxLength":2,"description":"Código da conta corrente no Omie.\n\nPode ser:\nAC - Administradora de Cartões\nAD - Adiantamento\nCA - Conta Aplicação\nCC - Conta Corrente\nCE - Conta Empréstimo\nCG - Conta Garantida\nCN - Crediário / Carnê\nCP - Conta Poupança\nCR - Cartão de Crédito\nCV - Carteira Virtual\nCX - Caixinha\nMT - Mútuo\nPG - Conta de Pagamento"},"codigo_banco":{"type":"string","maxLength":3,"description":"Código do Banco / Instituição Financeira,\n\nPode ser:\n\n001 - Banco do Brasil\n003 - Banco da Amazônia\n004 - Banco do Nordeste\n017 - BNY Mellon Banco S.A.\n021 - Banestes\n025 - Alfa\n029 - Banerj\n033 - Santander\n037 - Banpará\n041 - Banrisul\n047 - Banese\n069 - Banco Crefisa S.A.\n070 - BRB - Banco de Brasília\n077 - Banco Inter\n082 - Banco Topázio\n083 - China Brasil\n084 - Uniprime Norte do Paraná\n085 - Ailos (Cecred)\n089 - Credisan\n090 - Unicred\n091 - Unicred Central do Rio Grande do Sul\n093 - PoloCred\n094 - Finaxis\n095 - Confidence\n096 - Banco BM&F Bovespa\n097 - CrediSIS\n099 - Uniprime\n102 - XP Investimentos\n104 - Caixa Econômica Federal\n121 - Agiplan\n124 - Woori Bank\n125 - Brasil Plural\n128 - MS Bank\n132 - ICBC do Brasil\n133 - Cresol\n136 - Centrais Unicreds\n147 - Rico\n151 - Nossa Caixa\n177 - SC Guide\n197 - Stone\n208 - BTG Pactual\n212 - Original\n213 - ARBI\n218 - Banco Bonsucesso\n224 - Fibra\n233 - Banco Cifra\n237 - Bradesco\n243 - Banco Máxima\n246 - Banco ABC Brasil\n250 - BCV - Banco de Crédito e Varejo\n254 - ParanáBanco\n260 - Nubank\n274 - BMP Money Plus\n278 - Geração Futuro\n279 - Primacredi\n280 - LiftBank\n290 - PagBank (PagSeguro)\n301 - BPP Instituição de Pagamento\n318 - Banco BMG\n320 - BIC Banco Industrial e Comercial\n323 - Mercado Pago\n329 - QI Tech\n336 - C6 Bank\n341 - Itaú Unibanco\n354 - Necton\n364 - Gerencianet\n376 - J. P. Morgan\n389 - Banco Mercantil do Brasil\n399 - HSBC Bank\n422 - Safra\n453 - Banco Rural S.A.\n456 - Banco de Tokyo\n464 - Banco Sumitomo Mitsui Brasileiro\n473 - Caixa Geral\n487 - Deutsche Bank\n505 - Credit Suisse\n600 - Banco Luso Brasileiro\n604 - Banco Industrial do Brasil\n609 - Crebit\n610 - Lucree\n611 - Banco Paulista\n612 - Banco Guanabara\n613 - Omni Soluções Financeiras\n623 - Banco Panamericano S.A.\n630 - Omie.CASH\n633 - Rendimento\n634 - Banco Triângulo S.A.\n637 - Sofisa\n643 - Pine\n644 - Wall Securitizadora\n646 - Wirecard\n647 - B-Link Securitizadora\n648 - Servicoop\n649 - Select Administradora de Bens\n650 - SuperGet\n653 - Indusval\n654 - Banco Renner\n655 - Votorantim\n656 - DLM Invista\n657 - UnionPay\n658 - Zoop\n659 - Flash Benefícios\n660 - Warren\n661 - AvecPay\n662 - WabiPay\n663 - WabiPay\n664 - Credit Partners\n665 - Millennium Bcp\n666 - Porto Seguro\n667 - Fidussia\n668 - Silicon Valley Bank\n669 - ArgosBank\n670 - Brasil Cash\n671 - Metal Credit Securitizadora\n672 - FacilitaPay\n673 - Ceape\n674 - CBH - Compagnie Bancaire Helvetique\n675 - One7\n676 - Griffin Capital S/A\n677 - Midas Securitizadora\n678 - PeixePay\n679 - InfinitePay\n680 - Lado Serviços de Cobrança\n681 - Rodolfo Factoring\n682 - CR Factoring\n683 - Ben Benefícios\n684 - Loggi\n685 - BRDE\n686 - Cotação\n687 - Olist\n688 - Amazon\n689 - Investcamp\n690 - SulBrasil\n691 - Seven Investimentos\n692 - Lotus\n693 - Grupo Multiplica\n694 - Trevys Fidic\n696 - Valori Bank\n697 - Evo Pagamentos\n698 - Direct Cred\n699 - EngagED\n700 - Finpet\n707 - Banco Daycoval\n712 - Ourinvest\n719 - Banif\n735 - Neon / Pottencial\n741 - Banco Ribeirão Preto\n743 - Banco Semear\n745 - Citibank S.A.\n746 - Banco Modal\n747 - Rabobank International Brasil\n748 - Sicredi\n752 - BNP Paribas\n755 - Bank of America Merrill Lynch\n756 - Sicoob\n772 - Gol Securitizadora\n773 - Centerin Fomento\n774 - Sals-Fac Factoring\n775 - Social Bank\n776 - Conta Simples\n777 - Credicard\n778 - Credicard\n779 - Banricard\n780 - Akirede\n781 - Adiq\n782 - A55"},"descricao":{"type":"string","maxLength":40,"description":"Descrição da conta corrente."},"codigo_agencia":{"type":"string","maxLength":10,"description":"Código da Agência da Conta Corrente"},"numero_conta_corrente":{"type":"string","maxLength":25,"description":"Número da Conta Corrente"},"saldo_inicial":{"type":"number","maxLength":18,"description":"Saldo Inicial da Conta Corrente"},"saldo_data":{"type":"string","maxLength":10,"description":"Data do Saldo Inicial da Conta Corrente"},"valor_limite":{"type":"number","maxLength":18,"description":"Valor do Limite do Crédito"},"nao_fluxo":{"type":"string","maxLength":1,"description":"Não exibir no Fluxo de Caixa"},"nao_resumo":{"type":"string","maxLength":1,"description":"Não exibir no Resumo de Finanças"},"observacao":{"type":"string","description":"Observação"},"cobr_sn":{"type":"string","maxLength":1,"description":"Indica se realiza Cobrança Bancária para a conta corrente [S/N]"},"per_juros":{"type":"number","maxLength":10,"description":"Percentual de Juros ao Mês"},"per_multa":{"type":"number","maxLength":10,"description":"Percentual de Multa"},"bol_instr1":{"type":"string","maxLength":80,"description":"Mensagem de Instrução do Boleto - Linha 1"},"bol_instr2":{"type":"string","maxLength":80,"description":"Mensagem de Instrução do Boleto - Linha 2"},"bol_instr3":{"type":"string","maxLength":80,"description":"Mensagem de Instrução do Boleto - Linha 3"},"bol_instr4":{"type":"string","maxLength":80,"description":"Mensagem de Instrução do Boleto - Linha 4"},"bol_sn":{"type":"string","maxLength":1,"description":"Indica se emite Boletos de Cobrança [S/N]"},"pix_sn":{"type":"string","maxLength":1,"description":"Indica se emite PIX [S/N]"},"cnab_esp":{"type":"string","maxLength":2,"description":"Espécie padrão para a Remessa de Cobrança"},"cobr_esp":{"type":"string","maxLength":3,"description":"Espécie padrão para o Boleto de Cobrança"},"dias_rcomp":{"type":"integer","maxLength":2,"description":"Dias para Compensação dos Recebimentos"},"modalidade":{"type":"string","maxLength":3,"description":"Modalidade da Cobrança"},"cancinstr":{"type":"string","maxLength":3,"description":"Código de Instrução de Cancelamento, Baixa ou Devolução"},"pdv_enviar":{"type":"string","maxLength":1,"description":"Utiliza a Conta Corrente no OmiePDV"},"pdv_sincr_analitica":{"type":"string","maxLength":1,"description":"Sincronização Analítica para a Conta Corrente (Venda a Venda)"},"pdv_dias_venc":{"type":"integer","maxLength":3,"description":"Dias para Vencimento"},"pdv_num_parcelas":{"type":"integer","maxLength":2,"description":"Número de Parcelas"},"pdv_tipo_tef":{"type":"integer","maxLength":2,"description":"Tipo de TEF: 1-Nenhum 3-Paygo X-SITEF"},"pdv_cod_adm":{"type":"integer","maxLength":15,"description":"Código da Adminstradora de Cartão"},"pdv_limite_pacelas":{"type":"integer","maxLength":2,"description":"Limite máximo de parcelas"},"pdv_taxa_loja":{"type":"number","maxLength":6,"description":"Taxa de Juros da Loja"},"pdv_taxa_adm":{"type":"number","maxLength":6,"description":"Taxa da operadora"},"pdv_categoria":{"type":"string","maxLength":20,"description":"Código da Categoria para o PDV."},"pdv_bandeira":{"type":"string","maxLength":70,"description":"Bandeira do Cartão.\n\nUtilize a tag \"cCodigo\" do método \"ListarBandeira\" da API\n/api/v1/geral/bandeiracartao/\npara obter essa informação."},"cCnpjInstFinanc":{"type":"string","maxLength":20,"description":"CNPJ da instituição financeira."},"cTipoCartao":{"type":"string","maxLength":1,"description":"Tipo de Cartão para Administradoras de Cartão.\n\nPode ser:\n\n0 - Débito e Crédito.\n1 - Débito.\n2 - Crédito."},"cEstabelecimento":{"type":"string","maxLength":70,"description":"Indica o código do estabelecimento."},"nome_gerente":{"type":"string","maxLength":40,"description":"Nome do gerente da conta corrente."},"ddd":{"type":"string","maxLength":5,"description":"DDD do Telefone de Contato do Gerente da Agência"},"telefone":{"type":"string","maxLength":15,"description":"Telefone de Contato do Gerente da Agência"},"email":{"type":"string","maxLength":200,"description":"E-mail do Gerente da Conta Corrente"},"endereco":{"type":"string","maxLength":50,"description":"Endereço da Agência"},"numero":{"type":"string","maxLength":5,"description":"Número do Endereço"},"bairro":{"type":"string","maxLength":60,"description":"Bairro"},"complemento":{"type":"string","maxLength":15,"description":"Complemento do Número do Endereço"},"estado":{"type":"string","maxLength":2,"description":"Estado da Agência"},"cidade":{"type":"string","maxLength":40,"description":"Cidade da Agência"},"cep":{"type":"string","maxLength":9,"description":"CEP da Agência"},"codigo_pais":{"type":"string","maxLength":4,"description":"Código do País"},"data_inc":{"type":"string","maxLength":10,"description":"Data de Inclusão"},"hora_inc":{"type":"string","maxLength":8,"description":"Hora de Inclusão"},"user_inc":{"type":"string","maxLength":10,"description":"Usuário da Inclusão"},"data_alt":{"type":"string","maxLength":10,"description":"Data de alteração"},"hora_alt":{"type":"string","maxLength":8,"description":"Hora de Alteração"},"user_alt":{"type":"string","maxLength":10,"description":"Usuário de Alteração"},"importado_api":{"type":"string","maxLength":1,"description":"Registro importado pela API"},"bloqueado":{"type":"string","maxLength":1,"description":"Registro Bloqueado pela API"},"inativo":{"type":"string","maxLength":1,"description":"Indica se o cadastro da conta corrente está inativo (S/N)."}},"required":["codigo_banco","descricao","tipo_conta_corrente"]}}},"example":{"call":"IncluirContaCorrente","param":[{"cCodCCInt":"MyCC0001","tipo_conta_corrente":"CX","codigo_banco":"999","descricao":"Caixinha","saldo_inicial":0}]}},"geral_contacorrente_IncluirContaCorrente_retorno":{"type":"object","properties":{"nCodCC":{"type":"integer"},"cCodCCInt":{"type":"string"},"cCodStatus":{"type":"string","description":"Código do status"},"cDesStatus":{"type":"string","description":"Descrição do Status"}},"title":"IncluirContaCorrente (retorno)"},"geral_contacorrente_ListarContasCorrentes":{"type":"object","title":"ListarContasCorrentes","description":"Listar Contas Correntes","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarContasCorrentes"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo":{"type":"integer","maxLength":15},"codigo_integracao":{"type":"string","maxLength":20},"pagina":{"type":"integer","maxLength":15},"registros_por_pagina":{"type":"integer","maxLength":15},"apenas_importado_api":{"type":"string","maxLength":1},"ordenar_por":{"type":"string","maxLength":100},"ordem_descrescente":{"type":"string","maxLength":1},"filtrar_por_data_de":{"type":"string","maxLength":10},"filtrar_por_data_ate":{"type":"string","maxLength":10},"filtrar_apenas_inclusao":{"type":"string","maxLength":1},"filtrar_apenas_alteracao":{"type":"string","maxLength":1},"filtrar_apenas_ativo":{"type":"string","maxLength":1,"description":"Filtra apenas as contas correntes ativas."},"filtrar_por_descricao":{"type":"string","maxLength":100,"description":"Filtrar apenas contas correntes por descrição"}}}}},"example":{"call":"ListarContasCorrentes","param":[{"pagina":1,"registros_por_pagina":100,"apenas_importado_api":"N"}]}},"geral_contacorrente_ListarContasCorrentes_retorno":{"type":"object","properties":{"pagina":{"type":"integer"},"total_de_paginas":{"type":"integer"},"registros":{"type":"integer"},"total_de_registros":{"type":"integer"},"ListarContasCorrentes":{"type":"array","items":{"type":"object","properties":{"nCodCC":{"type":"integer","description":"Código da conta corrente."},"cCodCCInt":{"type":"string","description":"Código de Integração do parceiro."},"tipo_conta_corrente":{"type":"string","description":"Código da conta corrente no Omie. Pode ser: AC - Administradora de Cartões AD - Adiantamento CA - Conta Aplicação CC - Conta Corrente CE - Conta Empréstimo CG - Conta Garantida CN - Crediário / Carnê CP - Conta Poupança CR - Cartão de Crédito CV - Carteira Virtual CX - Caixinha MT - Mútuo PG - Conta de Pagamento"},"codigo_banco":{"type":"string","description":"Código do Banco / Instituição Financeira, Pode ser: 001 - Banco do Brasil 003 - Banco da Amazônia 004 - Banco do Nordeste 017 - BNY Mellon Banco S.A. 021 - Banestes 025 - Alfa 029 - Banerj 033 - Santander 037 - Banpará 041 - Banrisul 047 - Banese 069 - Banco Crefisa S.A. 070 - BRB - Banco de Brasília 077 - Banco Inter 082 - Banco Topázio 083 - China Brasil 084 - Uniprime Norte do Paraná 085 - Ailos (Cecred) 089 - Credisan 090 - Unicred 091 - Unicred Central do Rio Grande do Sul 093 - PoloCred 094 - Finaxis 095 - Confidence 096 - Banco BM&F Bovespa 097 - CrediSIS 099 - Uniprime 102 - XP Investimentos 104 - Caixa Econômica Federal 121 - Agiplan 124 - Woori Bank 125 - Brasil Plural 128 - MS Bank 132 - ICBC do Brasil 133 - Cresol 136 - Centrais Unicreds 147 - Rico 151 - Nossa Caixa 177 - SC Guide 197 - Stone 208 - BTG Pactual 212 - Original 213 - ARBI 218 - Banco Bonsucesso 224 - Fibra 233 - Banco Cifra 237 - Bradesco 243 - Banco Máxima 246 - Banco ABC Brasil 250 - BCV - Banco de Crédito e Varejo 254 - ParanáBanco 260 - Nubank 274 - BMP Money Plus 278 - Geração Futuro 279 - Primacredi 280 - LiftBank 290 - PagBank (PagSeguro) 301 - BPP Instituição de Pagamento 318 - Banco BMG 320 - BIC Banco Industrial e Comercial 323 - Mercado Pago 329 - QI Tech 336 - C6 Bank 341 - Itaú Unibanco 354 - Necton 364 - Gerencianet 376 - J. P. Morgan 389 - Banco Mercantil do Brasil 399 - HSBC Bank 422 - Safra 453 - Banco Rural S.A. 456 - Banco de Tokyo 464 - Banco Sumitomo Mitsui Brasileiro 473 - Caixa Geral 487 - Deutsche Bank 505 - Credit Suisse 600 - Banco Luso Brasileiro 604 - Banco Industrial do Brasil 609 - Crebit 610 - Lucree 611 - Banco Paulista 612 - Banco Guanabara 613 - Omni Soluções Financeiras 623 - Banco Panamericano S.A. 630 - Omie.CASH 633 - Rendimento 634 - Banco Triângulo S.A. 637 - Sofisa 643 - Pine 644 - Wall Securitizadora 646 - Wirecard 647 - B-Link Securitizadora 648 - Servicoop 649 - Select Administradora de Bens 650 - SuperGet 653 - Indusval 654 - Banco Renner 655 - Votorantim 656 - DLM Invista 657 - UnionPay 658 - Zoop 659 - Flash Benefícios 660 - Warren 661 - AvecPay 662 - WabiPay 663 - WabiPay 664 - Credit Partners 665 - Millennium Bcp 666 - Porto Seguro 667 - Fidussia 668 - Silicon Valley Bank 669 - ArgosBank 670 - Brasil Cash 671 - Metal Credit Securitizadora 672 - FacilitaPay 673 - Ceape 674 - CBH - Compagnie Bancaire Helvetique 675 - One7 676 - Griffin Capital S/A 677 - Midas Securitizadora 678 - PeixePay 679 - InfinitePay 680 - Lado Serviços de Cobrança 681 - Rodolfo Factoring 682 - CR Factoring 683 - Ben Benefícios 684 - Loggi 685 - BRDE 686 - Cotação 687 - Olist 688 - Amazon 689 - Investcamp 690 - SulBrasil 691 - Seven Investimentos 692 - Lotus 693 - Grupo Multiplica 694 - Trevys Fidic 696 - Valori Bank 697 - Evo Pagamentos 698 - Direct Cred 699 - EngagED 700 - Finpet 707 - Banco Daycoval 712 - Ourinvest 719 - Banif 735 - Neon / Pottencial 741 - Banco Ribeirão Preto 743 - Banco Semear 745 - Citibank S.A. 746 - Banco Modal 747 - Rabobank International Brasil 748 - Sicredi 752 - BNP Paribas 755 - Bank of America Merrill Lynch 756 - Sicoob 772 - Gol Securitizadora 773 - Centerin Fomento 774 - Sals-Fac Factoring 775 - Social Bank 776 - Conta Simples 777 - Credicard 778 - Credicard 779 - Banricard 780 - Akirede 781 - Adiq 782 - A55"},"descricao":{"type":"string","description":"Descrição da conta corrente."},"codigo_agencia":{"type":"string","description":"Código da Agência da Conta Corrente"},"numero_conta_corrente":{"type":"string","description":"Número da Conta Corrente"},"saldo_inicial":{"type":"decimal","description":"Saldo Inicial da Conta Corrente"},"saldo_data":{"type":"string","description":"Data do Saldo Inicial da Conta Corrente"},"valor_limite":{"type":"decimal","description":"Valor do Limite do Crédito"},"nao_fluxo":{"type":"string","description":"Não exibir no Fluxo de Caixa"},"nao_resumo":{"type":"string","description":"Não exibir no Resumo de Finanças"},"observacao":{"type":"string","description":"Observação"},"cobr_sn":{"type":"string","description":"Indica se realiza Cobrança Bancária para a conta corrente [S/N]"},"per_juros":{"type":"decimal","description":"Percentual de Juros ao Mês"},"per_multa":{"type":"decimal","description":"Percentual de Multa"},"bol_instr1":{"type":"string","description":"Mensagem de Instrução do Boleto - Linha 1"},"bol_instr2":{"type":"string","description":"Mensagem de Instrução do Boleto - Linha 2"},"bol_instr3":{"type":"string","description":"Mensagem de Instrução do Boleto - Linha 3"},"bol_instr4":{"type":"string","description":"Mensagem de Instrução do Boleto - Linha 4"},"bol_sn":{"type":"string","description":"Indica se emite Boletos de Cobrança [S/N]"},"pix_sn":{"type":"string","description":"Indica se emite PIX [S/N]"},"cnab_esp":{"type":"string","description":"Espécie padrão para a Remessa de Cobrança"},"cobr_esp":{"type":"string","description":"Espécie padrão para o Boleto de Cobrança"},"dias_rcomp":{"type":"integer","description":"Dias para Compensação dos Recebimentos"},"modalidade":{"type":"string","description":"Modalidade da Cobrança"},"cancinstr":{"type":"string","description":"Código de Instrução de Cancelamento, Baixa ou Devolução"},"pdv_enviar":{"type":"string","description":"Utiliza a Conta Corrente no OmiePDV"},"pdv_sincr_analitica":{"type":"string","description":"Sincronização Analítica para a Conta Corrente (Venda a Venda)"},"pdv_dias_venc":{"type":"integer","description":"Dias para Vencimento"},"pdv_num_parcelas":{"type":"integer","description":"Número de Parcelas"},"pdv_tipo_tef":{"type":"integer","description":"Tipo de TEF: 1-Nenhum 3-Paygo X-SITEF"},"pdv_cod_adm":{"type":"integer","description":"Código da Adminstradora de Cartão"},"pdv_limite_pacelas":{"type":"integer","description":"Limite máximo de parcelas"},"pdv_taxa_loja":{"type":"decimal","description":"Taxa de Juros da Loja"},"pdv_taxa_adm":{"type":"decimal","description":"Taxa da operadora"},"pdv_categoria":{"type":"string","description":"Código da Categoria para o PDV."},"pdv_bandeira":{"type":"string","description":"Bandeira do Cartão. Utilize a tag \"cCodigo\" do método \"ListarBandeira\" da API /api/v1/geral/bandeiracartao/ para obter essa informação."},"cCnpjInstFinanc":{"type":"string","description":"CNPJ da instituição financeira."},"cTipoCartao":{"type":"string","description":"Tipo de Cartão para Administradoras de Cartão. Pode ser: 0 - Débito e Crédito. 1 - Débito. 2 - Crédito."},"cEstabelecimento":{"type":"string","description":"Indica o código do estabelecimento."},"nome_gerente":{"type":"string","description":"Nome do gerente da conta corrente."},"ddd":{"type":"string","description":"DDD do Telefone de Contato do Gerente da Agência"},"telefone":{"type":"string","description":"Telefone de Contato do Gerente da Agência"},"email":{"type":"string","description":"E-mail do Gerente da Conta Corrente"},"endereco":{"type":"string","description":"Endereço da Agência"},"numero":{"type":"string","description":"Número do Endereço"},"bairro":{"type":"string","description":"Bairro"},"complemento":{"type":"string","description":"Complemento do Número do Endereço"},"estado":{"type":"string","description":"Estado da Agência"},"cidade":{"type":"string","description":"Cidade da Agência"},"cep":{"type":"string","description":"CEP da Agência"},"codigo_pais":{"type":"string","description":"Código do País"},"data_inc":{"type":"string","description":"Data de Inclusão"},"hora_inc":{"type":"string","description":"Hora de Inclusão"},"user_inc":{"type":"string","description":"Usuário da Inclusão"},"data_alt":{"type":"string","description":"Data de alteração"},"hora_alt":{"type":"string","description":"Hora de Alteração"},"user_alt":{"type":"string","description":"Usuário de Alteração"},"importado_api":{"type":"string","description":"Registro importado pela API"},"bloqueado":{"type":"string","description":"Registro Bloqueado pela API"},"inativo":{"type":"string","description":"Indica se o cadastro da conta corrente está inativo (S/N)."}}},"description":"Lista de contas correntes."}},"title":"ListarContasCorrentes (retorno)"},"geral_contacorrente_ListarResumoContasCorrentes":{"type":"object","title":"ListarResumoContasCorrentes","description":"Listar resumida de Contas correntes.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarResumoContasCorrentes"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo":{"type":"integer","maxLength":15},"codigo_integracao":{"type":"string","maxLength":20},"pagina":{"type":"integer","maxLength":15},"registros_por_pagina":{"type":"integer","maxLength":15},"apenas_importado_api":{"type":"string","maxLength":1},"ordenar_por":{"type":"string","maxLength":100},"ordem_descrescente":{"type":"string","maxLength":1},"filtrar_por_data_de":{"type":"string","maxLength":10},"filtrar_por_data_ate":{"type":"string","maxLength":10},"filtrar_apenas_inclusao":{"type":"string","maxLength":1},"filtrar_apenas_alteracao":{"type":"string","maxLength":1},"filtrar_apenas_ativo":{"type":"string","maxLength":1,"description":"Filtrar apenas contas correntes ativas"}}}}},"example":{"call":"ListarResumoContasCorrentes","param":[{"pagina":1,"registros_por_pagina":100,"apenas_importado_api":"N"}]}},"geral_contacorrente_ListarResumoContasCorrentes_retorno":{"type":"object","properties":{"pagina":{"type":"integer"},"total_de_paginas":{"type":"integer"},"registros":{"type":"integer"},"total_de_registros":{"type":"integer"},"conta_corrente_lista":{"type":"array","items":{"type":"object","properties":{"nCodCC":{"type":"integer","description":"Código da conta corrente no Omie."},"cCodCCInt":{"type":"string","description":"Código de Integração do Parceiro."},"descricao":{"type":"string","description":"Descrição da conta corrente."},"codigo_banco":{"type":"string","description":"Código do banco. Pode ser: 001 - Banco do Brasil 003 - Banco da Amazônia 004 - Banco do Nordeste 017 - BNY Mellon Banco S.A. 021 - Banestes 025 - Alfa 029 - Banerj 033 - Santander 037 - Banpará 041 - Banrisul 047 - Banese 069 - Banco Crefisa S.A. 070 - BRB - Banco de Brasília 077 - Banco Inter 082 - Banco Topázio 083 - China Brasil 084 - Uniprime Norte do Paraná 085 - Ailos (Cecred) 089 - Credisan 090 - Unicred 091 - Unicred Central do Rio Grande do Sul 093 - PoloCred 094 - Finaxis 095 - Confidence 096 - Banco BM&F Bovespa 097 - CrediSIS 099 - Uniprime 102 - XP Investimentos 104 - Caixa Econômica Federal 121 - Agiplan 124 - Woori Bank 125 - Brasil Plural 128 - MS Bank 132 - ICBC do Brasil 133 - Cresol 136 - Centrais Unicreds 147 - Rico 151 - Nossa Caixa 177 - SC Guide 197 - Stone 208 - BTG Pactual 212 - Original 213 - ARBI 218 - Banco Bonsucesso 224 - Fibra 233 - Banco Cifra 237 - Bradesco 243 - Banco Máxima 246 - Banco ABC Brasil 250 - BCV - Banco de Crédito e Varejo 254 - ParanáBanco 260 - Nubank 274 - BMP Money Plus 278 - Geração Futuro 279 - Primacredi 280 - LiftBank 290 - PagBank (PagSeguro) 301 - BPP Instituição de Pagamento 318 - Banco BMG 320 - BIC Banco Industrial e Comercial 323 - Mercado Pago 329 - QI Tech 336 - C6 Bank 341 - Itaú Unibanco 354 - Necton 364 - Gerencianet 376 - J. P. Morgan 389 - Banco Mercantil do Brasil 399 - HSBC Bank 422 - Safra 453 - Banco Rural S.A. 456 - Banco de Tokyo 464 - Banco Sumitomo Mitsui Brasileiro 473 - Caixa Geral 487 - Deutsche Bank 505 - Credit Suisse 600 - Banco Luso Brasileiro 604 - Banco Industrial do Brasil 609 - Crebit 610 - Lucree 611 - Banco Paulista 612 - Banco Guanabara 613 - Omni Soluções Financeiras 623 - Banco Panamericano S.A. 630 - Omie.CASH 633 - Rendimento 634 - Banco Triângulo S.A. 637 - Sofisa 643 - Pine 644 - Wall Securitizadora 646 - Wirecard 647 - B-Link Securitizadora 648 - Servicoop 649 - Select Administradora de Bens 650 - SuperGet 653 - Indusval 654 - Banco Renner 655 - Votorantim 656 - DLM Invista 657 - UnionPay 658 - Zoop 659 - Flash Benefícios 660 - Warren 661 - AvecPay 662 - WabiPay 663 - WabiPay 664 - Credit Partners 665 - Millennium Bcp 666 - Porto Seguro 667 - Fidussia 668 - Silicon Valley Bank 669 - ArgosBank 670 - Brasil Cash 671 - Metal Credit Securitizadora 672 - FacilitaPay 673 - Ceape 674 - CBH - Compagnie Bancaire Helvetique 675 - One7 676 - Griffin Capital S/A 677 - Midas Securitizadora 678 - PeixePay 679 - InfinitePay 680 - Lado Serviços de Cobrança 681 - Rodolfo Factoring 682 - CR Factoring 683 - Ben Benefícios 684 - Loggi 685 - BRDE 686 - Cotação 687 - Olist 688 - Amazon 689 - Investcamp 690 - SulBrasil 691 - Seven Investimentos 692 - Lotus 693 - Grupo Multiplica 694 - Trevys Fidic 696 - Valori Bank 697 - Evo Pagamentos 698 - Direct Cred 699 - EngagED 700 - Finpet 707 - Banco Daycoval 712 - Ourinvest 719 - Banif 735 - Neon / Pottencial 741 - Banco Ribeirão Preto 743 - Banco Semear 745 - Citibank S.A. 746 - Banco Modal 747 - Rabobank International Brasil 748 - Sicredi 752 - BNP Paribas 755 - Bank of America Merrill Lynch 756 - Sicoob 772 - Gol Securitizadora 773 - Centerin Fomento 774 - Sals-Fac Factoring 775 - Social Bank 776 - Conta Simples 777 - Credicard 778 - Credicard 779 - Banricard 780 - Akirede 781 - Adiq 782 - A55"},"codigo_agencia":{"type":"string","description":"Código da Agência"},"conta_corrente":{"type":"string","description":"Número da conta corrente."},"nome_gerente":{"type":"string","description":"Nome do Gerente da Conta Corrente."},"tipo":{"type":"string","description":"Tipo da Conta Corrente. Pode ser: AC - Administradora de Cartões AD - Adiantamento CA - Conta Aplicação CC - Conta Corrente CE - Conta Empréstimo CG - Conta Garantida CN - Crediário / Carnê CP - Conta Poupança CR - Cartão de Crédito CV - Carteira Virtual CX - Caixinha MT - Mútuo PG - Conta de Pagamento"},"tipo_comunicacao":{"type":"string"},"cSincrAnalitica":{"type":"string","description":"Sincroniza os Movimentos de Forma Análitica para o PDV"},"nTpTef":{"type":"integer","description":"Tipo de TEF"},"nTaxaAdm":{"type":"decimal","description":"Taxa da Administradora de Cartões"},"nDiasVenc":{"type":"integer","description":"Dias para vencimento"},"nNumParc":{"type":"integer","description":"Número máximo de parcelas do Cartão de Credito"},"nCodAdm":{"type":"integer","description":"Código da Administradora de Cartões"},"cUtilPDV":{"type":"string","description":"Utiliza a Conta Corrente no OmiePDV"},"cCategoria":{"type":"string","description":"Código da Categoria para o PDV."},"cModalidade":{"type":"string"},"saldo_inicial":{"type":"decimal","description":"Saldo Inicial da Conta Corrente"},"saldo_data":{"type":"string","description":"Data do Saldo Inicial da Conta Corrente"},"valor_limite":{"type":"decimal","description":"Valor do Limite do Crédito"},"cTipoCartao":{"type":"string","description":"Tipo de Cartão para Administradoras de Cartão. Pode ser: 0 - Débito e Crédito. 1 - Débito. 2 - Crédito."}}},"description":"Lista de contas correntes"}},"title":"ListarResumoContasCorrentes (retorno)"},"geral_contacorrente_UpsertContaCorrente":{"type":"object","title":"UpsertContaCorrente","description":"Upsert da Conta Corrente","required":["call","param"],"properties":{"call":{"type":"string","enum":["UpsertContaCorrente"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodCC":{"type":"integer","maxLength":15,"description":"Código da conta corrente."},"cCodCCInt":{"type":"string","maxLength":20,"description":"Código de Integração do parceiro."},"tipo_conta_corrente":{"type":"string","maxLength":2,"description":"Código da conta corrente no Omie.\n\nPode ser:\nAC - Administradora de Cartões\nAD - Adiantamento\nCA - Conta Aplicação\nCC - Conta Corrente\nCE - Conta Empréstimo\nCG - Conta Garantida\nCN - Crediário / Carnê\nCP - Conta Poupança\nCR - Cartão de Crédito\nCV - Carteira Virtual\nCX - Caixinha\nMT - Mútuo\nPG - Conta de Pagamento"},"codigo_banco":{"type":"string","maxLength":3,"description":"Código do Banco / Instituição Financeira,\n\nPode ser:\n\n001 - Banco do Brasil\n003 - Banco da Amazônia\n004 - Banco do Nordeste\n017 - BNY Mellon Banco S.A.\n021 - Banestes\n025 - Alfa\n029 - Banerj\n033 - Santander\n037 - Banpará\n041 - Banrisul\n047 - Banese\n069 - Banco Crefisa S.A.\n070 - BRB - Banco de Brasília\n077 - Banco Inter\n082 - Banco Topázio\n083 - China Brasil\n084 - Uniprime Norte do Paraná\n085 - Ailos (Cecred)\n089 - Credisan\n090 - Unicred\n091 - Unicred Central do Rio Grande do Sul\n093 - PoloCred\n094 - Finaxis\n095 - Confidence\n096 - Banco BM&F Bovespa\n097 - CrediSIS\n099 - Uniprime\n102 - XP Investimentos\n104 - Caixa Econômica Federal\n121 - Agiplan\n124 - Woori Bank\n125 - Brasil Plural\n128 - MS Bank\n132 - ICBC do Brasil\n133 - Cresol\n136 - Centrais Unicreds\n147 - Rico\n151 - Nossa Caixa\n177 - SC Guide\n197 - Stone\n208 - BTG Pactual\n212 - Original\n213 - ARBI\n218 - Banco Bonsucesso\n224 - Fibra\n233 - Banco Cifra\n237 - Bradesco\n243 - Banco Máxima\n246 - Banco ABC Brasil\n250 - BCV - Banco de Crédito e Varejo\n254 - ParanáBanco\n260 - Nubank\n274 - BMP Money Plus\n278 - Geração Futuro\n279 - Primacredi\n280 - LiftBank\n290 - PagBank (PagSeguro)\n301 - BPP Instituição de Pagamento\n318 - Banco BMG\n320 - BIC Banco Industrial e Comercial\n323 - Mercado Pago\n329 - QI Tech\n336 - C6 Bank\n341 - Itaú Unibanco\n354 - Necton\n364 - Gerencianet\n376 - J. P. Morgan\n389 - Banco Mercantil do Brasil\n399 - HSBC Bank\n422 - Safra\n453 - Banco Rural S.A.\n456 - Banco de Tokyo\n464 - Banco Sumitomo Mitsui Brasileiro\n473 - Caixa Geral\n487 - Deutsche Bank\n505 - Credit Suisse\n600 - Banco Luso Brasileiro\n604 - Banco Industrial do Brasil\n609 - Crebit\n610 - Lucree\n611 - Banco Paulista\n612 - Banco Guanabara\n613 - Omni Soluções Financeiras\n623 - Banco Panamericano S.A.\n630 - Omie.CASH\n633 - Rendimento\n634 - Banco Triângulo S.A.\n637 - Sofisa\n643 - Pine\n644 - Wall Securitizadora\n646 - Wirecard\n647 - B-Link Securitizadora\n648 - Servicoop\n649 - Select Administradora de Bens\n650 - SuperGet\n653 - Indusval\n654 - Banco Renner\n655 - Votorantim\n656 - DLM Invista\n657 - UnionPay\n658 - Zoop\n659 - Flash Benefícios\n660 - Warren\n661 - AvecPay\n662 - WabiPay\n663 - WabiPay\n664 - Credit Partners\n665 - Millennium Bcp\n666 - Porto Seguro\n667 - Fidussia\n668 - Silicon Valley Bank\n669 - ArgosBank\n670 - Brasil Cash\n671 - Metal Credit Securitizadora\n672 - FacilitaPay\n673 - Ceape\n674 - CBH - Compagnie Bancaire Helvetique\n675 - One7\n676 - Griffin Capital S/A\n677 - Midas Securitizadora\n678 - PeixePay\n679 - InfinitePay\n680 - Lado Serviços de Cobrança\n681 - Rodolfo Factoring\n682 - CR Factoring\n683 - Ben Benefícios\n684 - Loggi\n685 - BRDE\n686 - Cotação\n687 - Olist\n688 - Amazon\n689 - Investcamp\n690 - SulBrasil\n691 - Seven Investimentos\n692 - Lotus\n693 - Grupo Multiplica\n694 - Trevys Fidic\n696 - Valori Bank\n697 - Evo Pagamentos\n698 - Direct Cred\n699 - EngagED\n700 - Finpet\n707 - Banco Daycoval\n712 - Ourinvest\n719 - Banif\n735 - Neon / Pottencial\n741 - Banco Ribeirão Preto\n743 - Banco Semear\n745 - Citibank S.A.\n746 - Banco Modal\n747 - Rabobank International Brasil\n748 - Sicredi\n752 - BNP Paribas\n755 - Bank of America Merrill Lynch\n756 - Sicoob\n772 - Gol Securitizadora\n773 - Centerin Fomento\n774 - Sals-Fac Factoring\n775 - Social Bank\n776 - Conta Simples\n777 - Credicard\n778 - Credicard\n779 - Banricard\n780 - Akirede\n781 - Adiq\n782 - A55"},"descricao":{"type":"string","maxLength":40,"description":"Descrição da conta corrente."},"codigo_agencia":{"type":"string","maxLength":10,"description":"Código da Agência da Conta Corrente"},"numero_conta_corrente":{"type":"string","maxLength":25,"description":"Número da Conta Corrente"},"saldo_inicial":{"type":"number","maxLength":18,"description":"Saldo Inicial da Conta Corrente"},"saldo_data":{"type":"string","maxLength":10,"description":"Data do Saldo Inicial da Conta Corrente"},"valor_limite":{"type":"number","maxLength":18,"description":"Valor do Limite do Crédito"},"nao_fluxo":{"type":"string","maxLength":1,"description":"Não exibir no Fluxo de Caixa"},"nao_resumo":{"type":"string","maxLength":1,"description":"Não exibir no Resumo de Finanças"},"observacao":{"type":"string","description":"Observação"},"cobr_sn":{"type":"string","maxLength":1,"description":"Indica se realiza Cobrança Bancária para a conta corrente [S/N]"},"per_juros":{"type":"number","maxLength":10,"description":"Percentual de Juros ao Mês"},"per_multa":{"type":"number","maxLength":10,"description":"Percentual de Multa"},"bol_instr1":{"type":"string","maxLength":80,"description":"Mensagem de Instrução do Boleto - Linha 1"},"bol_instr2":{"type":"string","maxLength":80,"description":"Mensagem de Instrução do Boleto - Linha 2"},"bol_instr3":{"type":"string","maxLength":80,"description":"Mensagem de Instrução do Boleto - Linha 3"},"bol_instr4":{"type":"string","maxLength":80,"description":"Mensagem de Instrução do Boleto - Linha 4"},"bol_sn":{"type":"string","maxLength":1,"description":"Indica se emite Boletos de Cobrança [S/N]"},"pix_sn":{"type":"string","maxLength":1,"description":"Indica se emite PIX [S/N]"},"cnab_esp":{"type":"string","maxLength":2,"description":"Espécie padrão para a Remessa de Cobrança"},"cobr_esp":{"type":"string","maxLength":3,"description":"Espécie padrão para o Boleto de Cobrança"},"dias_rcomp":{"type":"integer","maxLength":2,"description":"Dias para Compensação dos Recebimentos"},"modalidade":{"type":"string","maxLength":3,"description":"Modalidade da Cobrança"},"cancinstr":{"type":"string","maxLength":3,"description":"Código de Instrução de Cancelamento, Baixa ou Devolução"},"pdv_enviar":{"type":"string","maxLength":1,"description":"Utiliza a Conta Corrente no OmiePDV"},"pdv_sincr_analitica":{"type":"string","maxLength":1,"description":"Sincronização Analítica para a Conta Corrente (Venda a Venda)"},"pdv_dias_venc":{"type":"integer","maxLength":3,"description":"Dias para Vencimento"},"pdv_num_parcelas":{"type":"integer","maxLength":2,"description":"Número de Parcelas"},"pdv_tipo_tef":{"type":"integer","maxLength":2,"description":"Tipo de TEF: 1-Nenhum 3-Paygo X-SITEF"},"pdv_cod_adm":{"type":"integer","maxLength":15,"description":"Código da Adminstradora de Cartão"},"pdv_limite_pacelas":{"type":"integer","maxLength":2,"description":"Limite máximo de parcelas"},"pdv_taxa_loja":{"type":"number","maxLength":6,"description":"Taxa de Juros da Loja"},"pdv_taxa_adm":{"type":"number","maxLength":6,"description":"Taxa da operadora"},"pdv_categoria":{"type":"string","maxLength":20,"description":"Código da Categoria para o PDV."},"pdv_bandeira":{"type":"string","maxLength":70,"description":"Bandeira do Cartão.\n\nUtilize a tag \"cCodigo\" do método \"ListarBandeira\" da API\n/api/v1/geral/bandeiracartao/\npara obter essa informação."},"cCnpjInstFinanc":{"type":"string","maxLength":20,"description":"CNPJ da instituição financeira."},"cTipoCartao":{"type":"string","maxLength":1,"description":"Tipo de Cartão para Administradoras de Cartão.\n\nPode ser:\n\n0 - Débito e Crédito.\n1 - Débito.\n2 - Crédito."},"cEstabelecimento":{"type":"string","maxLength":70,"description":"Indica o código do estabelecimento."},"nome_gerente":{"type":"string","maxLength":40,"description":"Nome do gerente da conta corrente."},"ddd":{"type":"string","maxLength":5,"description":"DDD do Telefone de Contato do Gerente da Agência"},"telefone":{"type":"string","maxLength":15,"description":"Telefone de Contato do Gerente da Agência"},"email":{"type":"string","maxLength":200,"description":"E-mail do Gerente da Conta Corrente"},"endereco":{"type":"string","maxLength":50,"description":"Endereço da Agência"},"numero":{"type":"string","maxLength":5,"description":"Número do Endereço"},"bairro":{"type":"string","maxLength":60,"description":"Bairro"},"complemento":{"type":"string","maxLength":15,"description":"Complemento do Número do Endereço"},"estado":{"type":"string","maxLength":2,"description":"Estado da Agência"},"cidade":{"type":"string","maxLength":40,"description":"Cidade da Agência"},"cep":{"type":"string","maxLength":9,"description":"CEP da Agência"},"codigo_pais":{"type":"string","maxLength":4,"description":"Código do País"},"data_inc":{"type":"string","maxLength":10,"description":"Data de Inclusão"},"hora_inc":{"type":"string","maxLength":8,"description":"Hora de Inclusão"},"user_inc":{"type":"string","maxLength":10,"description":"Usuário da Inclusão"},"data_alt":{"type":"string","maxLength":10,"description":"Data de alteração"},"hora_alt":{"type":"string","maxLength":8,"description":"Hora de Alteração"},"user_alt":{"type":"string","maxLength":10,"description":"Usuário de Alteração"},"importado_api":{"type":"string","maxLength":1,"description":"Registro importado pela API"},"bloqueado":{"type":"string","maxLength":1,"description":"Registro Bloqueado pela API"},"inativo":{"type":"string","maxLength":1,"description":"Indica se o cadastro da conta corrente está inativo (S/N)."}}}}},"example":{"call":"UpsertContaCorrente","param":[{"cCodCCInt":"MyCC0001","tipo_conta_corrente":"CX","codigo_banco":"999","descricao":"Caixinha","saldo_inicial":0}]}},"geral_contacorrente_UpsertContaCorrente_retorno":{"type":"object","properties":{"nCodCC":{"type":"integer"},"cCodCCInt":{"type":"string"},"cCodStatus":{"type":"string","description":"Código do status"},"cDesStatus":{"type":"string","description":"Descrição do Status"}},"title":"UpsertContaCorrente (retorno)"},"geral_contacorrente_UpsertContaCorrentePorLote":{"type":"object","title":"UpsertContaCorrentePorLote","description":"Upsert por lote de Conta Corrente","required":["call","param"],"properties":{"call":{"type":"string","enum":["UpsertContaCorrentePorLote"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"lote":{"type":"integer","maxLength":15,"description":"Número do Lote"},"fin_conta_corrente_cadastro":{"type":"array","items":{"type":"object","properties":{"nCodCC":{"type":"integer","maxLength":15,"description":"Código da conta corrente."},"cCodCCInt":{"type":"string","maxLength":20,"description":"Código de Integração do parceiro."},"tipo_conta_corrente":{"type":"string","maxLength":2,"description":"Código da conta corrente no Omie.\n\nPode ser:\nAC - Administradora de Cartões\nAD - Adiantamento\nCA - Conta Aplicação\nCC - Conta Corrente\nCE - Conta Empréstimo\nCG - Conta Garantida\nCN - Crediário / Carnê\nCP - Conta Poupança\nCR - Cartão de Crédito\nCV - Carteira Virtual\nCX - Caixinha\nMT - Mútuo\nPG - Conta de Pagamento"},"codigo_banco":{"type":"string","maxLength":3,"description":"Código do Banco / Instituição Financeira,\n\nPode ser:\n\n001 - Banco do Brasil\n003 - Banco da Amazônia\n004 - Banco do Nordeste\n017 - BNY Mellon Banco S.A.\n021 - Banestes\n025 - Alfa\n029 - Banerj\n033 - Santander\n037 - Banpará\n041 - Banrisul\n047 - Banese\n069 - Banco Crefisa S.A.\n070 - BRB - Banco de Brasília\n077 - Banco Inter\n082 - Banco Topázio\n083 - China Brasil\n084 - Uniprime Norte do Paraná\n085 - Ailos (Cecred)\n089 - Credisan\n090 - Unicred\n091 - Unicred Central do Rio Grande do Sul\n093 - PoloCred\n094 - Finaxis\n095 - Confidence\n096 - Banco BM&F Bovespa\n097 - CrediSIS\n099 - Uniprime\n102 - XP Investimentos\n104 - Caixa Econômica Federal\n121 - Agiplan\n124 - Woori Bank\n125 - Brasil Plural\n128 - MS Bank\n132 - ICBC do Brasil\n133 - Cresol\n136 - Centrais Unicreds\n147 - Rico\n151 - Nossa Caixa\n177 - SC Guide\n197 - Stone\n208 - BTG Pactual\n212 - Original\n213 - ARBI\n218 - Banco Bonsucesso\n224 - Fibra\n233 - Banco Cifra\n237 - Bradesco\n243 - Banco Máxima\n246 - Banco ABC Brasil\n250 - BCV - Banco de Crédito e Varejo\n254 - ParanáBanco\n260 - Nubank\n274 - BMP Money Plus\n278 - Geração Futuro\n279 - Primacredi\n280 - LiftBank\n290 - PagBank (PagSeguro)\n301 - BPP Instituição de Pagamento\n318 - Banco BMG\n320 - BIC Banco Industrial e Comercial\n323 - Mercado Pago\n329 - QI Tech\n336 - C6 Bank\n341 - Itaú Unibanco\n354 - Necton\n364 - Gerencianet\n376 - J. P. Morgan\n389 - Banco Mercantil do Brasil\n399 - HSBC Bank\n422 - Safra\n453 - Banco Rural S.A.\n456 - Banco de Tokyo\n464 - Banco Sumitomo Mitsui Brasileiro\n473 - Caixa Geral\n487 - Deutsche Bank\n505 - Credit Suisse\n600 - Banco Luso Brasileiro\n604 - Banco Industrial do Brasil\n609 - Crebit\n610 - Lucree\n611 - Banco Paulista\n612 - Banco Guanabara\n613 - Omni Soluções Financeiras\n623 - Banco Panamericano S.A.\n630 - Omie.CASH\n633 - Rendimento\n634 - Banco Triângulo S.A.\n637 - Sofisa\n643 - Pine\n644 - Wall Securitizadora\n646 - Wirecard\n647 - B-Link Securitizadora\n648 - Servicoop\n649 - Select Administradora de Bens\n650 - SuperGet\n653 - Indusval\n654 - Banco Renner\n655 - Votorantim\n656 - DLM Invista\n657 - UnionPay\n658 - Zoop\n659 - Flash Benefícios\n660 - Warren\n661 - AvecPay\n662 - WabiPay\n663 - WabiPay\n664 - Credit Partners\n665 - Millennium Bcp\n666 - Porto Seguro\n667 - Fidussia\n668 - Silicon Valley Bank\n669 - ArgosBank\n670 - Brasil Cash\n671 - Metal Credit Securitizadora\n672 - FacilitaPay\n673 - Ceape\n674 - CBH - Compagnie Bancaire Helvetique\n675 - One7\n676 - Griffin Capital S/A\n677 - Midas Securitizadora\n678 - PeixePay\n679 - InfinitePay\n680 - Lado Serviços de Cobrança\n681 - Rodolfo Factoring\n682 - CR Factoring\n683 - Ben Benefícios\n684 - Loggi\n685 - BRDE\n686 - Cotação\n687 - Olist\n688 - Amazon\n689 - Investcamp\n690 - SulBrasil\n691 - Seven Investimentos\n692 - Lotus\n693 - Grupo Multiplica\n694 - Trevys Fidic\n696 - Valori Bank\n697 - Evo Pagamentos\n698 - Direct Cred\n699 - EngagED\n700 - Finpet\n707 - Banco Daycoval\n712 - Ourinvest\n719 - Banif\n735 - Neon / Pottencial\n741 - Banco Ribeirão Preto\n743 - Banco Semear\n745 - Citibank S.A.\n746 - Banco Modal\n747 - Rabobank International Brasil\n748 - Sicredi\n752 - BNP Paribas\n755 - Bank of America Merrill Lynch\n756 - Sicoob\n772 - Gol Securitizadora\n773 - Centerin Fomento\n774 - Sals-Fac Factoring\n775 - Social Bank\n776 - Conta Simples\n777 - Credicard\n778 - Credicard\n779 - Banricard\n780 - Akirede\n781 - Adiq\n782 - A55"},"descricao":{"type":"string","maxLength":40,"description":"Descrição da conta corrente."},"codigo_agencia":{"type":"string","maxLength":10,"description":"Código da Agência da Conta Corrente"},"numero_conta_corrente":{"type":"string","maxLength":25,"description":"Número da Conta Corrente"},"saldo_inicial":{"type":"number","maxLength":18,"description":"Saldo Inicial da Conta Corrente"},"saldo_data":{"type":"string","maxLength":10,"description":"Data do Saldo Inicial da Conta Corrente"},"valor_limite":{"type":"number","maxLength":18,"description":"Valor do Limite do Crédito"},"nao_fluxo":{"type":"string","maxLength":1,"description":"Não exibir no Fluxo de Caixa"},"nao_resumo":{"type":"string","maxLength":1,"description":"Não exibir no Resumo de Finanças"},"observacao":{"type":"string","description":"Observação"},"cobr_sn":{"type":"string","maxLength":1,"description":"Indica se realiza Cobrança Bancária para a conta corrente [S/N]"},"per_juros":{"type":"number","maxLength":10,"description":"Percentual de Juros ao Mês"},"per_multa":{"type":"number","maxLength":10,"description":"Percentual de Multa"},"bol_instr1":{"type":"string","maxLength":80,"description":"Mensagem de Instrução do Boleto - Linha 1"},"bol_instr2":{"type":"string","maxLength":80,"description":"Mensagem de Instrução do Boleto - Linha 2"},"bol_instr3":{"type":"string","maxLength":80,"description":"Mensagem de Instrução do Boleto - Linha 3"},"bol_instr4":{"type":"string","maxLength":80,"description":"Mensagem de Instrução do Boleto - Linha 4"},"bol_sn":{"type":"string","maxLength":1,"description":"Indica se emite Boletos de Cobrança [S/N]"},"pix_sn":{"type":"string","maxLength":1,"description":"Indica se emite PIX [S/N]"},"cnab_esp":{"type":"string","maxLength":2,"description":"Espécie padrão para a Remessa de Cobrança"},"cobr_esp":{"type":"string","maxLength":3,"description":"Espécie padrão para o Boleto de Cobrança"},"dias_rcomp":{"type":"integer","maxLength":2,"description":"Dias para Compensação dos Recebimentos"},"modalidade":{"type":"string","maxLength":3,"description":"Modalidade da Cobrança"},"cancinstr":{"type":"string","maxLength":3,"description":"Código de Instrução de Cancelamento, Baixa ou Devolução"},"pdv_enviar":{"type":"string","maxLength":1,"description":"Utiliza a Conta Corrente no OmiePDV"},"pdv_sincr_analitica":{"type":"string","maxLength":1,"description":"Sincronização Analítica para a Conta Corrente (Venda a Venda)"},"pdv_dias_venc":{"type":"integer","maxLength":3,"description":"Dias para Vencimento"},"pdv_num_parcelas":{"type":"integer","maxLength":2,"description":"Número de Parcelas"},"pdv_tipo_tef":{"type":"integer","maxLength":2,"description":"Tipo de TEF: 1-Nenhum 3-Paygo X-SITEF"},"pdv_cod_adm":{"type":"integer","maxLength":15,"description":"Código da Adminstradora de Cartão"},"pdv_limite_pacelas":{"type":"integer","maxLength":2,"description":"Limite máximo de parcelas"},"pdv_taxa_loja":{"type":"number","maxLength":6,"description":"Taxa de Juros da Loja"},"pdv_taxa_adm":{"type":"number","maxLength":6,"description":"Taxa da operadora"},"pdv_categoria":{"type":"string","maxLength":20,"description":"Código da Categoria para o PDV."},"pdv_bandeira":{"type":"string","maxLength":70,"description":"Bandeira do Cartão.\n\nUtilize a tag \"cCodigo\" do método \"ListarBandeira\" da API\n/api/v1/geral/bandeiracartao/\npara obter essa informação."},"cCnpjInstFinanc":{"type":"string","maxLength":20,"description":"CNPJ da instituição financeira."},"cTipoCartao":{"type":"string","maxLength":1,"description":"Tipo de Cartão para Administradoras de Cartão.\n\nPode ser:\n\n0 - Débito e Crédito.\n1 - Débito.\n2 - Crédito."},"cEstabelecimento":{"type":"string","maxLength":70,"description":"Indica o código do estabelecimento."},"nome_gerente":{"type":"string","maxLength":40,"description":"Nome do gerente da conta corrente."},"ddd":{"type":"string","maxLength":5,"description":"DDD do Telefone de Contato do Gerente da Agência"},"telefone":{"type":"string","maxLength":15,"description":"Telefone de Contato do Gerente da Agência"},"email":{"type":"string","maxLength":200,"description":"E-mail do Gerente da Conta Corrente"},"endereco":{"type":"string","maxLength":50,"description":"Endereço da Agência"},"numero":{"type":"string","maxLength":5,"description":"Número do Endereço"},"bairro":{"type":"string","maxLength":60,"description":"Bairro"},"complemento":{"type":"string","maxLength":15,"description":"Complemento do Número do Endereço"},"estado":{"type":"string","maxLength":2,"description":"Estado da Agência"},"cidade":{"type":"string","maxLength":40,"description":"Cidade da Agência"},"cep":{"type":"string","maxLength":9,"description":"CEP da Agência"},"codigo_pais":{"type":"string","maxLength":4,"description":"Código do País"},"data_inc":{"type":"string","maxLength":10,"description":"Data de Inclusão"},"hora_inc":{"type":"string","maxLength":8,"description":"Hora de Inclusão"},"user_inc":{"type":"string","maxLength":10,"description":"Usuário da Inclusão"},"data_alt":{"type":"string","maxLength":10,"description":"Data de alteração"},"hora_alt":{"type":"string","maxLength":8,"description":"Hora de Alteração"},"user_alt":{"type":"string","maxLength":10,"description":"Usuário de Alteração"},"importado_api":{"type":"string","maxLength":1,"description":"Registro importado pela API"},"bloqueado":{"type":"string","maxLength":1,"description":"Registro Bloqueado pela API"},"inativo":{"type":"string","maxLength":1,"description":"Indica se o cadastro da conta corrente está inativo (S/N)."}}},"description":"Lista de Contas Correntes"}}}}},"example":{"call":"UpsertContaCorrentePorLote","param":[{"lote":1,"fin_conta_corrente_cadastro":[{"cCodCCInt":"MyCC0001","tipo_conta_corrente":"CX","codigo_banco":"999","descricao":"Caixinha","saldo_inicial":0}]}]}},"geral_contacorrente_UpsertContaCorrentePorLote_retorno":{"type":"object","properties":{"lote":{"type":"integer"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDesStatus":{"type":"string"}},"title":"UpsertContaCorrentePorLote (retorno)"},"geral_departamentos_AlterarDepartamento":{"type":"object","title":"AlterarDepartamento","description":"Altera os dados de um departamento existente","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarDepartamento"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo":{"type":"string","maxLength":40,"description":"Código do Departamento ou Centro de Custo"},"descricao":{"type":"string","maxLength":50,"description":"Nome do Departamento ou Centro de Custo"}},"required":["codigo"]}}},"example":{"call":"AlterarDepartamento","param":[{"descricao":"","codigo":"000000000723648"}]}},"geral_departamentos_AlterarDepartamento_retorno":{"type":"object","properties":{"codigo":{"type":"string","description":"Código do Departamento ou Centro de Custo"},"descricao":{"type":"string","description":"Nome do Departamento ou Centro de Custo"},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro durante o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodigoStatus\"."}},"title":"AlterarDepartamento (retorno)"},"geral_departamentos_ConsultarDepartamento":{"type":"object","title":"ConsultarDepartamento","description":"Consulta um código de departamento.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarDepartamento"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo":{"type":"string","maxLength":40,"description":"Código do Departamento"}},"required":["codigo"]}}},"example":{"call":"ConsultarDepartamento","param":[{"codigo":""}]}},"geral_departamentos_ConsultarDepartamento_retorno":{"type":"object","properties":{"codigo":{"type":"string","description":"Código do Departamento ou Centro de Custo"},"descricao":{"type":"string","description":"Nome do Departamento ou Centro de Custo"},"estrutura":{"type":"string","description":"Utilizado para estruturação dos Departamentos no modo \"diagrama\""},"inativo":{"type":"string","description":"Indica que o Departamento ou Centro de Custo está inativo"},"nivel_totalizador":{"type":"string","description":"Indica que o Departamento ou Centro de Custo é um nível totalizador"}},"title":"ConsultarDepartamento (retorno)"},"geral_departamentos_ExcluirDepartamento":{"type":"object","title":"ExcluirDepartamento","description":"Exclui um departamento do cadastro","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirDepartamento"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo":{"type":"string","maxLength":40,"description":"Código do Departamento ou Centro de Custo"}},"required":["codigo"]}}},"example":{"call":"ExcluirDepartamento","param":[{"codigo":""}]}},"geral_departamentos_ExcluirDepartamento_retorno":{"type":"object","properties":{"codigo":{"type":"string","description":"Código do Departamento ou Centro de Custo"},"descricao":{"type":"string","description":"Nome do Departamento ou Centro de Custo"},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro durante o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodigoStatus\"."}},"title":"ExcluirDepartamento (retorno)"},"geral_departamentos_IncluirDepartamento":{"type":"object","title":"IncluirDepartamento","description":"Inclui um novo departamento no cadastro","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirDepartamento"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo":{"type":"string","maxLength":40,"description":"Código do Departamento ou Centro de Custo pai no qual você deseja\nincluir o novo departamento."},"descricao":{"type":"string","maxLength":50,"description":"Nome do Departamento ou Centro de Custo"}},"required":["codigo"]}}},"example":{"call":"IncluirDepartamento","param":[{"descricao":"","codigo":"000000000723648"}]}},"geral_departamentos_IncluirDepartamento_retorno":{"type":"object","properties":{"codigo":{"type":"string","description":"Código do Departamento ou Centro de Custo"},"descricao":{"type":"string","description":"Nome do Departamento ou Centro de Custo"},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro durante o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodigoStatus\"."}},"title":"IncluirDepartamento (retorno)"},"geral_departamentos_ListarDepartamentos":{"type":"object","title":"ListarDepartamentos","description":"Lista os departamentos cadastrados no Omie.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarDepartamentos"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página de registros."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Quantidade de registros por página retornados na consulta."},"apenas_importado_api":{"deprecated":true,"type":"string","maxLength":1,"description":"DEPRECATED"},"ordenar_por":{"deprecated":true,"type":"string","maxLength":100,"description":"DEPRECATED"},"ordem_descrescente":{"deprecated":true,"type":"string","maxLength":1,"description":"DEPRECATED"},"filtrar_por_data_de":{"deprecated":true,"type":"string","maxLength":10,"description":"DEPRECATED"},"filtrar_por_data_ate":{"deprecated":true,"type":"string","maxLength":10,"description":"DEPRECATED"},"filtrar_apenas_inclusao":{"deprecated":true,"type":"string","maxLength":1,"description":"DEPRECATED"},"filtrar_apenas_alteracao":{"deprecated":true,"type":"string","maxLength":1,"description":"DEPRECATED"}}}}},"example":{"call":"ListarDepartamentos","param":[{"pagina":1,"registros_por_pagina":50}]}},"geral_departamentos_ListarDepartamentos_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página de registros."},"total_de_paginas":{"type":"integer","description":"Quantidade total de páginas disponíveis para a consulta."},"registros":{"type":"integer","description":"Quantidade de registros retornados nesta página."},"total_de_registros":{"type":"integer","description":"Quantidade total de registros encontrados pela consulta."},"departamentos":{"type":"array","items":{"type":"object","properties":{"codigo":{"type":"string","description":"Código do Departamento ou Centro de Custo"},"descricao":{"type":"string","description":"Nome do Departamento ou Centro de Custo"},"estrutura":{"type":"string","description":"Utilizado para estruturação dos Departamentos no modo \"diagrama\""},"inativo":{"type":"string","description":"Indica que o Departamento ou Centro de Custo está inativo"},"nivel_totalizador":{"type":"string","description":"Indica que o Departamento ou Centro de Custo é um nível totalizador"}}}}},"title":"ListarDepartamentos (retorno)"},"geral_dre_ListarCadastroDRE":{"type":"object","title":"ListarCadastroDRE","description":"Lista as contas do DRE","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarCadastroDRE"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"apenasContasAtivas":{"type":"string","maxLength":1,"description":"Listar apenas as contas ativas: S ou N."}}}}},"example":{"call":"ListarCadastroDRE","param":[{"apenasContasAtivas":"N"}]}},"geral_dre_ListarCadastroDRE_retorno":{"type":"object","properties":{"totalRegistros":{"type":"integer","description":"total de registros encontrados"},"dreLista":{"type":"array","items":{"type":"object","properties":{"codigoDRE":{"type":"string","description":"Código da Conta do DRE."},"descricaoDRE":{"type":"string","description":"Descrição da Conta do DRE."},"naoExibirDRE":{"type":"string","description":"Indica se a Conta está marcada para não exibir no DRE."},"nivelDRE":{"type":"integer","description":"Nível da Conta da DRE."},"sinalDRE":{"type":"string","description":"Sinal da Conta para o DRE."},"totalizaDRE":{"type":"string","description":"Indica se a Conta do DRE é Totalizadora."}}},"description":"Cadastro de Contas do DRE."}},"title":"ListarCadastroDRE (retorno)"},"geral_empresas_ConsultarEmpresa":{"type":"object","title":"ConsultarEmpresa","description":"Realiza a consulta de um registro especifico","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarEmpresa"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_empresa":{"type":"integer","maxLength":15,"description":"Código da empresa no Omie"}},"required":["codigo_empresa"]}}},"example":{"call":"ConsultarEmpresa","param":[{"codigo_empresa":0}]}},"geral_empresas_ConsultarEmpresa_retorno":{"type":"object","properties":{"ct_name":{"type":"string","description":"Certificado - Nome"},"alt_user":{"type":"string","description":"Usuário de alteração"},"contato":{"type":"string","description":"Contato"},"ct_tm_from":{"type":"string","description":"Certificado - Valido até (hora)"},"ct_tm_to":{"type":"string","description":"Certificado - Válido até (hora)"},"estab":{"type":"string","description":"Tipo de estabelecimento = M.atriz, F.ilial ou U.nico"},"got_ativo":{"type":"string","description":"Indica se a Empresa está ativa em algum módulo do GOT (Fiscal, Contábil, Folha) [S/N]"},"got_idmatr":{"type":"integer","description":"GOT - ID service da matriz"},"got_svcid":{"type":"integer","description":"Service ID do APP do Contador"},"dtabertura":{"type":"string","description":"Data de Abertura da Empresa"},"inc_user":{"type":"string","description":"Usuário de inclusão"},"recibo_tit":{"type":"string","description":"Título para o Recibo de Prestação de Serviço"},"mdfe_sn":{"type":"string","description":"Gera o Manifesto de Documentos Fiscais Eletrônico [S/N]"},"nfce_sn":{"type":"string","description":"Gera Nota Fiscal Consumidor Final (S/N)"},"nfe_off":{"type":"string","description":"Permite desmarcar a opção de emitir NF-e na SEFAZ mesmo depois de marcada [S/N]"},"nfse_off":{"type":"string","description":"Permite desmarcar a opção de emitir NFS-e na Prefeitura mesmo depois de marcada [S/N]"},"regapu":{"type":"string","description":"Código do regime de apuração"},"nire":{"type":"string","description":"Número de Identificação do Registro da Empresa (Junta Comercial)"},"recbru_12":{"type":"decimal","description":"Receita Bruta em 12 Meses"},"tp_ativ":{"type":"string","description":"Tipo da Atividade"},"proc_cert":{"type":"string","description":"(S/N) Tem procuração para o certificado digital"},"prc_gcgcpf":{"type":"string","description":"CNPJ ou CPF da procuração do certificado digital"},"dtnire":{"type":"string","description":"Data do NIRE"},"ct_eskey":{"type":"string","description":"Certificado digital do eSocial"},"ct_espass":{"type":"string","description":"Certificado digital do eSocial (senha)"},"ct_esvlpss":{"type":"string","description":"Certificado digiral VALPASS"},"un_cert":{"type":"string","description":"(S/N) Usar mesmo certificado digital"},"ct_esidkey":{"type":"integer","description":"ID do Arquivo do Certificado digital eSocial"},"csc_idh":{"type":"string","description":"Identificador do Código de Segurança do Contribuinte (CSC) usado em ambiente Homologação"},"csc_idp":{"type":"string","description":"Identificador do Código de Segurança do Contribuinte (CSC) usado em ambiente Produção"},"nfsenac_sn":{"type":"string","description":"Gera Nota Fiscal de Serviço Eletrônica NACIONAL [S/N]"},"frete_sn":{"type":"string","description":"Identifica que a empresa utiliza cotação de frete."},"ctrprev_aj":{"type":"string","description":"Parâmetro para calcular as previsões do contrato da forma correta"},"ct_esisuer":{"type":"string","description":"Certificado Emitido por (eSocial)"},"ct_esname":{"type":"string","description":"Certificado Digital eSocial - Nome"},"ct_essubj":{"type":"string","description":"Certificado digital eSocial - Emitido para"},"ct_estmfrm":{"type":"string","description":"Certificado Digital eSocial Valido até"},"ct_estmto":{"type":"string","description":"Certificado Digital eSocial Valido até"},"ct_esdtfrm":{"type":"string","description":"Certificado Digital eSocial válido até"},"ct_esdtto":{"type":"string","description":"Certificado digital eSocial valido até"},"qualificpj":{"type":"string","description":"Qualificação da Pessoa Jurídica."},"viaunica":{"type":"string","description":"Identifica que a empresa é emissora de Nota Fiscal Via Única (Modelo 06, 21 e 22)"},"vu_padrao":{"type":"string","description":"Padrão de NFS-e utilizado para documentos Via Única (modelo 06/21/22)"},"recbr_ano":{"type":"decimal","description":"Receita Bruta do Ano Calendário"},"got_cert":{"type":"string","description":"(S/N) Usar o certificado digital do escritório OneFlow"},"got_certpr":{"type":"string","description":"(S/N) Usar o certificado digital do procurador do escritório OneFlow."},"codigo_empresa":{"type":"integer","description":"Código da Empresa"},"codigo_empresa_integracao":{"type":"string","description":"Código de Integração"},"cnpj":{"type":"string","description":"CNPJ da Empresa"},"razao_social":{"type":"string","description":"Razão Social"},"nome_fantasia":{"type":"string","description":"Nome Fantasia"},"logradouro":{"type":"string","description":"Logradouro"},"endereco":{"type":"string","description":"Endereço da Empresa"},"endereco_numero":{"type":"string","description":"Número do Endereço"},"complemento":{"type":"string","description":"Complemento do Número do Endereço"},"bairro":{"type":"string","description":"Bairro"},"cidade":{"type":"string","description":"Código da Cidade"},"estado":{"type":"string","description":"Estado da Empresa"},"cep":{"type":"string","description":"CEP"},"codigo_pais":{"type":"string","description":"Código do País"},"data_adesao_sn":{"type":"string","description":"Data de Adesão ao Simples Nacional"},"telefone1_ddd":{"type":"string","description":"DDD"},"telefone1_numero":{"type":"string","description":"Telefones da Empresa"},"telefone2_ddd":{"type":"string","description":"DDD Telefone 2"},"telefone2_numero":{"type":"string","description":"Telefone 2"},"fax_ddd":{"type":"string","description":"DDD Fax"},"fax_numero":{"type":"string","description":"Fax da Empresa"},"email":{"type":"string","description":"E-mail da Empresa"},"website":{"type":"string","description":"WebSite"},"cnae":{"type":"string","description":"Código do CNAE - Fiscal"},"cnae_municipal":{"type":"string","description":"Código do CNAE - Municipal"},"inscricao_estadual":{"type":"string","description":"Inscrição Estadual"},"inscricao_municipal":{"type":"string","description":"Inscrição Municipal"},"inscricao_suframa":{"type":"string","description":"Inscrição no SUFRAMA"},"regime_tributario":{"type":"string","description":"Regime Tributário"},"inativa":{"type":"string","description":"Indica que a empresa está inativa"},"gera_nfse":{"type":"string","description":"Gera Nota Fiscal de Serviço Eletrônica para o Município [S/N]"},"optante_simples_nacional":{"type":"string","description":"Indica que a empresa é optante pelo Simples Nacional"},"sped_codigo_incidencia_tributaria":{"type":"string","description":"SPED PIS/COFINS - Código Indicador da Incidência Tributária no Período"},"sped_codigo_tipo_contribuicao":{"type":"string","description":"SPED PIS/COFINS - Código indicador do Tipo de Contribuição Apurada no Período"},"sped_cpf_contador":{"type":"string","description":"SPED - CPF do Contador Responsável pela Empresa"},"sped_crc_contador":{"type":"string","description":"SPED - CRC do Contador Responsável pela Empresa"},"sped_usa_contabilidade_terceirizada":{"type":"string","description":"SPED - Indica se a Empresa utiliza Contabilidade Terceirizada"},"sped_email_contador":{"type":"string","description":"SPED - Email do Contador da Empresa"},"sped_codigo_indicador_apropriacao_credito":{"type":"string","description":"SPED PIS/COFINS - Código Indicador de Método de Apropriação de Créditos Comuns"},"sped_codigo_tipo_atividade":{"type":"string","description":"SPED PIS/COFINS - Código Indicador de Tipo de Atividade Preponderante"},"sped_natureza_pessoa_juridica":{"type":"string","description":"SPED PIS/COFINS - Indicador da Natureza da Pessoa Jurídica"},"sped_codigo_criterio_escrituracao":{"type":"string","description":"SPED PIS/COFINS - Código Indicador do Critério de Escrituração e Apuração"},"sped_junta_comercial":{"type":"string","description":"SPED - Indica se o Local do Registro é Junta Comercial"},"sped_matriz":{"type":"string","description":"SPED - Indica se a empresa é Matriz"},"sped_nome_contador":{"type":"string","description":"SPED - Nome do Contador Responsável pela Empresa"},"sped_registro_junta_comercial":{"type":"string","description":"SPED - Número do Registro da Empresa na Junta Comercial ou no Cartório"},"efd_atividade_industrial":{"type":"string","description":"EFD - Indica se a atividade é industrial ou equiparado a indústria"},"efd_perfil_arquivo_fiscal":{"type":"string","description":"Perfil de Apresentação do Arquivo Fiscal - EFD"},"ecd_codigo_cadastral":{"type":"string","description":"SPED / ECD - Código cadastral na Instituição Responsável"},"ecd_codigo_instituicao_responsavel":{"type":"string","description":"SPED / ECD - Código da Instituição Responsável pela Administração do Cadastro"},"gera_nfe":{"type":"string","description":"Gera Nota Fiscal Eletrônica Âmbito Nacional (DANFE) [S/N]"},"inclusao_data":{"type":"string","description":"Data de inclusão"},"inclusao_hora":{"type":"string","description":"Hora de inclusão."},"alteracao_data":{"type":"string","description":"Data de alteração"},"alteracao_hora":{"type":"string","description":"Hora de alteração"},"bloqueado":{"type":"string","description":"Registro bloqueado pela API"},"importado_api":{"type":"string","description":"Importado da API."},"pdv_sincr_analitica":{"type":"string","description":"Sincronizar Estoque de Forma Analítica (Venda a Venda)"},"dt_adesao_simpnac":{"type":"string","description":"Data de Adesão do Simples Nacional"},"ie_st":{"type":"string","description":"Inscrição Estadual para ST"},"recibo_ide":{"type":"string","description":"Identificação do Profissional (contador, advogado, etc) para o Recibo de Prestação de Serviço"},"gera_recibo":{"type":"string","description":"Gera Recibo de Prestação de Serviço [S/N]"},"recibo_tipo":{"type":"string","description":"Tipo (modelo) do Recibo de Prestação de Serviço"},"recibo_num_vias":{"type":"string","description":"Indica se o Recibo de Prestação de Serviço será gerado em 2 vias"},"csc_id_homologacao":{"type":"string","description":"Identificador do Código de Segurança do Contribuinte em ambiente homologação"},"csc_homologacao":{"type":"string","description":"Código de Segurança do Contribuinte em ambiente de homologação"},"csc_id_producao":{"type":"string","description":"Identificador do Código de Segurança do Contribuinte em ambiente produção"},"csc_producao":{"type":"string","description":"Código de Segurança do Contribuinte em ambiente de produção"}},"title":"ConsultarEmpresa (retorno)"},"geral_empresas_ListarEmpresas":{"type":"object","title":"ListarEmpresas","description":"Lista as empresas cadastradas no Omie.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarEmpresas"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"apenas_importado_api":{"deprecated":true,"type":"string","maxLength":1,"description":"DEPRECATED"},"ordenar_por":{"deprecated":true,"type":"string","maxLength":100,"description":"DEPRECATED"},"ordem_descrescente":{"deprecated":true,"type":"string","maxLength":1,"description":"DEPRECATED"},"filtrar_por_data_de":{"deprecated":true,"type":"string","maxLength":10,"description":"DEPRECATED"},"filtrar_por_data_ate":{"deprecated":true,"type":"string","maxLength":10,"description":"DEPRECATED"},"filtrar_apenas_inclusao":{"deprecated":true,"type":"string","maxLength":1,"description":"DEPRECATED"},"filtrar_apenas_alteracao":{"deprecated":true,"type":"string","maxLength":1,"description":"DEPRECATED"}}}}},"example":{"call":"ListarEmpresas","param":[{"pagina":1,"registros_por_pagina":100,"apenas_importado_api":"N"}]}},"geral_empresas_ListarEmpresas_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada"},"total_de_paginas":{"type":"integer","description":"Número total de páginas"},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"total de registros encontrados"},"empresas_cadastro":{"type":"array","items":{"type":"object","properties":{"ct_name":{"type":"string","description":"Certificado - Nome"},"alt_user":{"type":"string","description":"Usuário de alteração"},"contato":{"type":"string","description":"Contato"},"ct_tm_from":{"type":"string","description":"Certificado - Valido até (hora)"},"ct_tm_to":{"type":"string","description":"Certificado - Válido até (hora)"},"estab":{"type":"string","description":"Tipo de estabelecimento = M.atriz, F.ilial ou U.nico"},"got_ativo":{"type":"string","description":"Indica se a Empresa está ativa em algum módulo do GOT (Fiscal, Contábil, Folha) [S/N]"},"got_idmatr":{"type":"integer","description":"GOT - ID service da matriz"},"got_svcid":{"type":"integer","description":"Service ID do APP do Contador"},"dtabertura":{"type":"string","description":"Data de Abertura da Empresa"},"inc_user":{"type":"string","description":"Usuário de inclusão"},"recibo_tit":{"type":"string","description":"Título para o Recibo de Prestação de Serviço"},"mdfe_sn":{"type":"string","description":"Gera o Manifesto de Documentos Fiscais Eletrônico [S/N]"},"nfce_sn":{"type":"string","description":"Gera Nota Fiscal Consumidor Final (S/N)"},"nfe_off":{"type":"string","description":"Permite desmarcar a opção de emitir NF-e na SEFAZ mesmo depois de marcada [S/N]"},"nfse_off":{"type":"string","description":"Permite desmarcar a opção de emitir NFS-e na Prefeitura mesmo depois de marcada [S/N]"},"regapu":{"type":"string","description":"Código do regime de apuração"},"nire":{"type":"string","description":"Número de Identificação do Registro da Empresa (Junta Comercial)"},"recbru_12":{"type":"decimal","description":"Receita Bruta em 12 Meses"},"tp_ativ":{"type":"string","description":"Tipo da Atividade"},"proc_cert":{"type":"string","description":"(S/N) Tem procuração para o certificado digital"},"prc_gcgcpf":{"type":"string","description":"CNPJ ou CPF da procuração do certificado digital"},"dtnire":{"type":"string","description":"Data do NIRE"},"ct_eskey":{"type":"string","description":"Certificado digital do eSocial"},"ct_espass":{"type":"string","description":"Certificado digital do eSocial (senha)"},"ct_esvlpss":{"type":"string","description":"Certificado digiral VALPASS"},"un_cert":{"type":"string","description":"(S/N) Usar mesmo certificado digital"},"ct_esidkey":{"type":"integer","description":"ID do Arquivo do Certificado digital eSocial"},"csc_idh":{"type":"string","description":"Identificador do Código de Segurança do Contribuinte (CSC) usado em ambiente Homologação"},"csc_idp":{"type":"string","description":"Identificador do Código de Segurança do Contribuinte (CSC) usado em ambiente Produção"},"nfsenac_sn":{"type":"string","description":"Gera Nota Fiscal de Serviço Eletrônica NACIONAL [S/N]"},"frete_sn":{"type":"string","description":"Identifica que a empresa utiliza cotação de frete."},"ctrprev_aj":{"type":"string","description":"Parâmetro para calcular as previsões do contrato da forma correta"},"ct_esisuer":{"type":"string","description":"Certificado Emitido por (eSocial)"},"ct_esname":{"type":"string","description":"Certificado Digital eSocial - Nome"},"ct_essubj":{"type":"string","description":"Certificado digital eSocial - Emitido para"},"ct_estmfrm":{"type":"string","description":"Certificado Digital eSocial Valido até"},"ct_estmto":{"type":"string","description":"Certificado Digital eSocial Valido até"},"ct_esdtfrm":{"type":"string","description":"Certificado Digital eSocial válido até"},"ct_esdtto":{"type":"string","description":"Certificado digital eSocial valido até"},"qualificpj":{"type":"string","description":"Qualificação da Pessoa Jurídica."},"viaunica":{"type":"string","description":"Identifica que a empresa é emissora de Nota Fiscal Via Única (Modelo 06, 21 e 22)"},"vu_padrao":{"type":"string","description":"Padrão de NFS-e utilizado para documentos Via Única (modelo 06/21/22)"},"recbr_ano":{"type":"decimal","description":"Receita Bruta do Ano Calendário"},"got_cert":{"type":"string","description":"(S/N) Usar o certificado digital do escritório OneFlow"},"got_certpr":{"type":"string","description":"(S/N) Usar o certificado digital do procurador do escritório OneFlow."},"codigo_empresa":{"type":"integer","description":"Código da Empresa"},"codigo_empresa_integracao":{"type":"string","description":"Código de Integração"},"cnpj":{"type":"string","description":"CNPJ da Empresa"},"razao_social":{"type":"string","description":"Razão Social"},"nome_fantasia":{"type":"string","description":"Nome Fantasia"},"logradouro":{"type":"string","description":"Logradouro"},"endereco":{"type":"string","description":"Endereço da Empresa"},"endereco_numero":{"type":"string","description":"Número do Endereço"},"complemento":{"type":"string","description":"Complemento do Número do Endereço"},"bairro":{"type":"string","description":"Bairro"},"cidade":{"type":"string","description":"Código da Cidade"},"estado":{"type":"string","description":"Estado da Empresa"},"cep":{"type":"string","description":"CEP"},"codigo_pais":{"type":"string","description":"Código do País"},"data_adesao_sn":{"type":"string","description":"Data de Adesão ao Simples Nacional"},"telefone1_ddd":{"type":"string","description":"DDD"},"telefone1_numero":{"type":"string","description":"Telefones da Empresa"},"telefone2_ddd":{"type":"string","description":"DDD Telefone 2"},"telefone2_numero":{"type":"string","description":"Telefone 2"},"fax_ddd":{"type":"string","description":"DDD Fax"},"fax_numero":{"type":"string","description":"Fax da Empresa"},"email":{"type":"string","description":"E-mail da Empresa"},"website":{"type":"string","description":"WebSite"},"cnae":{"type":"string","description":"Código do CNAE - Fiscal"},"cnae_municipal":{"type":"string","description":"Código do CNAE - Municipal"},"inscricao_estadual":{"type":"string","description":"Inscrição Estadual"},"inscricao_municipal":{"type":"string","description":"Inscrição Municipal"},"inscricao_suframa":{"type":"string","description":"Inscrição no SUFRAMA"},"regime_tributario":{"type":"string","description":"Regime Tributário"},"inativa":{"type":"string","description":"Indica que a empresa está inativa"},"gera_nfse":{"type":"string","description":"Gera Nota Fiscal de Serviço Eletrônica para o Município [S/N]"},"optante_simples_nacional":{"type":"string","description":"Indica que a empresa é optante pelo Simples Nacional"},"sped_codigo_incidencia_tributaria":{"type":"string","description":"SPED PIS/COFINS - Código Indicador da Incidência Tributária no Período"},"sped_codigo_tipo_contribuicao":{"type":"string","description":"SPED PIS/COFINS - Código indicador do Tipo de Contribuição Apurada no Período"},"sped_cpf_contador":{"type":"string","description":"SPED - CPF do Contador Responsável pela Empresa"},"sped_crc_contador":{"type":"string","description":"SPED - CRC do Contador Responsável pela Empresa"},"sped_usa_contabilidade_terceirizada":{"type":"string","description":"SPED - Indica se a Empresa utiliza Contabilidade Terceirizada"},"sped_email_contador":{"type":"string","description":"SPED - Email do Contador da Empresa"},"sped_codigo_indicador_apropriacao_credito":{"type":"string","description":"SPED PIS/COFINS - Código Indicador de Método de Apropriação de Créditos Comuns"},"sped_codigo_tipo_atividade":{"type":"string","description":"SPED PIS/COFINS - Código Indicador de Tipo de Atividade Preponderante"},"sped_natureza_pessoa_juridica":{"type":"string","description":"SPED PIS/COFINS - Indicador da Natureza da Pessoa Jurídica"},"sped_codigo_criterio_escrituracao":{"type":"string","description":"SPED PIS/COFINS - Código Indicador do Critério de Escrituração e Apuração"},"sped_junta_comercial":{"type":"string","description":"SPED - Indica se o Local do Registro é Junta Comercial"},"sped_matriz":{"type":"string","description":"SPED - Indica se a empresa é Matriz"},"sped_nome_contador":{"type":"string","description":"SPED - Nome do Contador Responsável pela Empresa"},"sped_registro_junta_comercial":{"type":"string","description":"SPED - Número do Registro da Empresa na Junta Comercial ou no Cartório"},"efd_atividade_industrial":{"type":"string","description":"EFD - Indica se a atividade é industrial ou equiparado a indústria"},"efd_perfil_arquivo_fiscal":{"type":"string","description":"Perfil de Apresentação do Arquivo Fiscal - EFD"},"ecd_codigo_cadastral":{"type":"string","description":"SPED / ECD - Código cadastral na Instituição Responsável"},"ecd_codigo_instituicao_responsavel":{"type":"string","description":"SPED / ECD - Código da Instituição Responsável pela Administração do Cadastro"},"gera_nfe":{"type":"string","description":"Gera Nota Fiscal Eletrônica Âmbito Nacional (DANFE) [S/N]"},"inclusao_data":{"type":"string","description":"Data de inclusão"},"inclusao_hora":{"type":"string","description":"Hora de inclusão."},"alteracao_data":{"type":"string","description":"Data de alteração"},"alteracao_hora":{"type":"string","description":"Hora de alteração"},"bloqueado":{"type":"string","description":"Registro bloqueado pela API"},"importado_api":{"type":"string","description":"Importado da API."},"pdv_sincr_analitica":{"type":"string","description":"Sincronizar Estoque de Forma Analítica (Venda a Venda)"},"dt_adesao_simpnac":{"type":"string","description":"Data de Adesão do Simples Nacional"},"ie_st":{"type":"string","description":"Inscrição Estadual para ST"},"recibo_ide":{"type":"string","description":"Identificação do Profissional (contador, advogado, etc) para o Recibo de Prestação de Serviço"},"gera_recibo":{"type":"string","description":"Gera Recibo de Prestação de Serviço [S/N]"},"recibo_tipo":{"type":"string","description":"Tipo (modelo) do Recibo de Prestação de Serviço"},"recibo_num_vias":{"type":"string","description":"Indica se o Recibo de Prestação de Serviço será gerado em 2 vias"},"csc_id_homologacao":{"type":"string","description":"Identificador do Código de Segurança do Contribuinte em ambiente homologação"},"csc_homologacao":{"type":"string","description":"Código de Segurança do Contribuinte em ambiente de homologação"},"csc_id_producao":{"type":"string","description":"Identificador do Código de Segurança do Contribuinte em ambiente produção"},"csc_producao":{"type":"string","description":"Código de Segurança do Contribuinte em ambiente de produção"}}},"description":"Cadastro de Empresas"}},"title":"ListarEmpresas (retorno)"},"geral_estados_ListarEstados":{"type":"object","title":"ListarEstados","description":"Listar Estados.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarEstados"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"filtrar_por_codigo":{"type":"string","description":"Código do Estado (IBGE)."},"filtrar_por_descricao":{"type":"string","description":"Descrição do Estado."},"filtrar_por_sigla":{"type":"string","description":"Sigla do Estado."}}}}},"example":{"call":"ListarEstados","param":[{"filtrar_por_codigo":"","filtrar_por_descricao":"","filtrar_por_sigla":""}]}},"geral_estados_ListarEstados_retorno":{"type":"object","properties":{"lista_estados":{"type":"array","items":{"type":"object","properties":{"cCodigo":{"type":"string","description":"Código da Estado (IBGE)."},"cDescricao":{"type":"string","description":"Descrição do Estado."},"cSigla":{"type":"string","description":"Sigla do Estado."}}},"description":"Lista de Estados."}},"title":"ListarEstados (retorno)"},"geral_familias_AlterarFamilia":{"type":"object","title":"AlterarFamilia","description":"Altera uma familia de produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarFamilia"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo":{"type":"integer","maxLength":15,"description":"Código da Familia de Produto."},"codInt":{"type":"string","maxLength":20,"description":"Código de Integração da Familia de Produto."},"codFamilia":{"type":"string","maxLength":50,"description":"Código da Familia."},"nomeFamilia":{"type":"string","maxLength":50,"description":"Nome da Familia de Produto."},"inativo":{"type":"string","maxLength":1,"description":"Indica se a Familia de Produto está inativa [S/N]."}}}}},"example":{"call":"AlterarFamilia","param":[{"codigo":0,"codInt":"FA1790776279","codFamilia":"","nomeFamilia":"","inativo":"N"}]}},"geral_familias_AlterarFamilia_retorno":{"type":"object","properties":{"codigo":{"type":"integer","description":"Código da Familia de Produto."},"codInt":{"type":"string","description":"Código de Integração da Familia de Produto."},"cCodStatus":{"type":"string","description":"Código do Status."},"cDesStatus":{"type":"string","description":"Descrição do Status da Remessa."}},"title":"AlterarFamilia (retorno)"},"geral_familias_ConsultarFamilia":{"type":"object","title":"ConsultarFamilia","description":"Consulta uma familia de produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarFamilia"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo":{"type":"integer","maxLength":15,"description":"Código da Familia de Produtos."},"codInt":{"type":"string","maxLength":20,"description":"Código de Integração da Familia de Produtos."}}}}},"example":{"call":"ConsultarFamilia","param":[{"codigo":0,"codInt":""}]}},"geral_familias_ConsultarFamilia_retorno":{"type":"object","properties":{"codigo":{"type":"integer","description":"Código da Familia de Produto."},"codInt":{"type":"string","description":"Código de Integração da Familia de Produto."},"codFamilia":{"type":"string","description":"Código da Familia."},"nomeFamilia":{"type":"string","description":"Nome da Familia de Produto."},"inativo":{"type":"string","description":"Indica se a Familia de Produto está inativa [S/N]."}},"title":"ConsultarFamilia (retorno)"},"geral_familias_ExcluirFamilia":{"type":"object","title":"ExcluirFamilia","description":"Exclui uma familia de produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirFamilia"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo":{"type":"integer","maxLength":15,"description":"Código da Familia de Produtos."},"codInt":{"type":"string","maxLength":20,"description":"Código de Integração da Familia de Produtos."}}}}},"example":{"call":"ExcluirFamilia","param":[{"codigo":0,"codInt":""}]}},"geral_familias_ExcluirFamilia_retorno":{"type":"object","properties":{"codigo":{"type":"integer","description":"Código da Familia de Produto."},"codInt":{"type":"string","description":"Código de Integração da Familia de Produto."},"cCodStatus":{"type":"string","description":"Código do Status."},"cDesStatus":{"type":"string","description":"Descrição do Status da Remessa."}},"title":"ExcluirFamilia (retorno)"},"geral_familias_IncluirFamilia":{"type":"object","title":"IncluirFamilia","description":"Inclui uma familia de produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirFamilia"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo":{"type":"integer","maxLength":15,"description":"Código da Familia de Produto."},"codInt":{"type":"string","maxLength":20,"description":"Código de Integração da Familia de Produto."},"codFamilia":{"type":"string","maxLength":50,"description":"Código da Familia."},"nomeFamilia":{"type":"string","maxLength":50,"description":"Nome da Familia de Produto."},"inativo":{"type":"string","maxLength":1,"description":"Indica se a Familia de Produto está inativa [S/N]."}}}}},"example":{"call":"IncluirFamilia","param":[{"codInt":"FA1790776279","codFamilia":"","nomeFamilia":"","inativo":"N"}]}},"geral_familias_IncluirFamilia_retorno":{"type":"object","properties":{"codigo":{"type":"integer","description":"Código da Familia de Produto."},"codInt":{"type":"string","description":"Código de Integração da Familia de Produto."},"cCodStatus":{"type":"string","description":"Código do Status."},"cDesStatus":{"type":"string","description":"Descrição do Status da Remessa."}},"title":"IncluirFamilia (retorno)"},"geral_familias_PesquisarFamilias":{"type":"object","title":"PesquisarFamilias","description":"Listagem de familias cadastradas.","required":["call","param"],"properties":{"call":{"type":"string","enum":["PesquisarFamilias"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15},"registros_por_pagina":{"type":"integer","maxLength":15},"apenas_importado_api":{"type":"string","maxLength":1},"ordenar_por":{"type":"string","maxLength":100},"ordem_descrescente":{"type":"string","maxLength":1},"filtrar_por_data_de":{"type":"string","maxLength":10},"filtrar_por_data_ate":{"type":"string","maxLength":10},"filtrar_apenas_inclusao":{"type":"string","maxLength":1},"filtrar_apenas_alteracao":{"type":"string","maxLength":1}}}}},"example":{"call":"PesquisarFamilias","param":[{"pagina":1,"registros_por_pagina":50}]}},"geral_familias_PesquisarFamilias_retorno":{"type":"object","properties":{"pagina":{"type":"integer"},"total_de_paginas":{"type":"integer"},"registros":{"type":"integer"},"total_de_registros":{"type":"integer"},"famCadastro":{"type":"array","items":{"type":"object","properties":{"codigo":{"type":"integer","description":"Código da Familia de Produto."},"codInt":{"type":"string","description":"Código de Integração da Familia de Produto."},"codFamilia":{"type":"string","description":"Código da Familia."},"nomeFamilia":{"type":"string","description":"Nome da Familia de Produto."},"inativo":{"type":"string","description":"Indica se a Familia de Produto está inativa [S/N]."}}}}},"title":"PesquisarFamilias (retorno)"},"geral_familias_UpsertFamilia":{"type":"object","title":"UpsertFamilia","description":"Inclui / Altera uma familia de produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["UpsertFamilia"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo":{"type":"integer","maxLength":15,"description":"Código da Familia de Produto."},"codInt":{"type":"string","maxLength":20,"description":"Código de Integração da Familia de Produto."},"codFamilia":{"type":"string","maxLength":50,"description":"Código da Familia."},"nomeFamilia":{"type":"string","maxLength":50,"description":"Nome da Familia de Produto."},"inativo":{"type":"string","maxLength":1,"description":"Indica se a Familia de Produto está inativa [S/N]."}}}}},"example":{"call":"UpsertFamilia","param":[{"codigo":0,"codInt":"FA1790776279","codFamilia":"","nomeFamilia":"","inativo":"N"}]}},"geral_familias_UpsertFamilia_retorno":{"type":"object","properties":{"codigo":{"type":"integer","description":"Código da Familia de Produto."},"codInt":{"type":"string","description":"Código de Integração da Familia de Produto."},"cCodStatus":{"type":"string","description":"Código do Status."},"cDesStatus":{"type":"string","description":"Descrição do Status da Remessa."}},"title":"UpsertFamilia (retorno)"},"geral_finaltransf_ConsultarFinalTransf":{"type":"object","title":"ConsultarFinalTransf","description":"Consulta os dados de uma finalidade de transferência específica","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarFinalTransf"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"banco":{"type":"string","maxLength":3,"description":"Código do Banco / Instituição Financeira"},"codigo":{"type":"string","maxLength":10,"description":"Código da Finalidade de Transferência"}},"required":["banco","codigo"]}}},"example":{"call":"ConsultarFinalTransf","param":[{"banco":"104","codigo":"01"}]}},"geral_finaltransf_ConsultarFinalTransf_retorno":{"type":"object","properties":{"banco":{"type":"string","description":"Código do Banco / Instituição Financeira"},"codigo":{"type":"string","description":"Código da Finalidade de Transferência"},"descricao":{"type":"string","description":"Descrição da Finalidade de Transferência"}},"title":"ConsultarFinalTransf (retorno)"},"geral_finaltransf_ListarFinalTransf":{"type":"object","title":"ListarFinalTransf","description":"Exibe uma lista com as finalidades de transferências cadastradas","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarFinalTransf"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página."},"filtrar_por_banco":{"type":"string","maxLength":3,"description":"Código do Banco / Instituição Financeira"}}}}},"example":{"call":"ListarFinalTransf","param":[{"pagina":1,"registros_por_pagina":50}]}},"geral_finaltransf_ListarFinalTransf_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada"},"total_de_paginas":{"type":"integer","description":"Número total de páginas"},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"total de registros encontrados"},"cadastros":{"type":"array","items":{"type":"object","properties":{"banco":{"type":"string","description":"Código do Banco / Instituição Financeira"},"codigo":{"type":"string","description":"Código da Finalidade de Transferência"},"descricao":{"type":"string","description":"Descrição da Finalidade de Transferência"}}},"description":"Cadastro de finalidades de transferências"}},"title":"ListarFinalTransf (retorno)"},"geral_lotevalidade_ConsultarLoteValidade":{"type":"object","title":"ConsultarLoteValidade","description":"Consulta as configurações de Lote e Validade.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarLoteValidade"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"lExibir":{"type":"boolean","description":"Aceito por compatibilidade; não altera o resultado."}}}}},"example":{"call":"ConsultarLoteValidade","param":[{"lExibir":true}]}},"geral_lotevalidade_ConsultarLoteValidade_retorno":{"type":"object","properties":{"cCodStatus":{"type":"string","description":"Código do status: \"0\" para sucesso."},"cDescStatus":{"type":"string","description":"Descrição do status."},"cMetodo":{"type":"string","description":"Método de Consumo do lote definido nas configurações do aplicativo. INFO - Manual (você escolhe manualmente o lote) FEFO - Primeiro a vencer, primeiro a sair (First expired, first out) FIFO - Primeiro a entrar, primeiro a sair (First in, first out) LIFO - Último a entrar, primeiro a sair (Last In, first out) Vazio: o sistema considera FEFO."},"cTipoNumeracao":{"type":"string","description":"Tipo da configuração de numeração sequencial do Lote. 01 - Sequencial único 9999999999 02 - Sequencial por produto 9999999999 03 - Data de fabricação do lote AAAAMMDD Vazio: sem numeração automática."},"cPrefixo":{"type":"string","description":"Prefixo colocado antes do número do lote gerado."},"nDiasNotificacao":{"type":"integer","description":"Dias de antecedência para avisar o vencimento dos produtos com controle de lote. Padrão 30."}},"title":"ConsultarLoteValidade (retorno)"},"geral_malha_AlterarEstrutura":{"type":"object","title":"AlterarEstrutura","description":"Alterar a estrutura de um produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarEstrutura"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"idProduto":{"type":"integer","maxLength":15,"description":"Código interno de identificação do produto.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno do produto gerado pelo Omie."},"intProduto":{"type":"string","maxLength":60,"description":"Código de integração do produto.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código utilizado no seu aplicativo quando incluir um produto no Omie.\nAssim, poderá utilizá-lo para resgatar as informações do produto desejado.\nCaso informe esse campo, não informe a tag nCodProd. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"itemMalhaAlterar":{"type":"array","items":{"type":"object","properties":{"idMalha":{"type":"integer","maxLength":15,"description":"Id da Malha."},"intMalha":{"type":"string","maxLength":20,"description":"Código de Integração da Malha."},"idProdMalha":{"type":"integer","maxLength":15,"description":"Código interno de identificação do produto filho da estrutura."},"intProdMalha":{"type":"string","maxLength":20,"description":"Código de integração do produto filho da estrutura."},"quantProdMalha":{"type":"number","maxLength":19,"description":"Quantidade do item da estrutura do produto."},"percPerdaProdMalha":{"type":"number","maxLength":10,"description":"Percentual de perda."},"obsProdMalha":{"type":"string","description":"Observações do item da estrutura do produto."},"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do Local do Estoque."}}},"description":"Item da estrutura do produto."}}}}},"example":{"call":"AlterarEstrutura","param":[{"idProduto":0,"intProduto":"","itemMalhaAlterar":[{"idMalha":0,"intMalha":"","idProdMalha":0,"intProdMalha":"","quantProdMalha":0,"percPerdaProdMalha":0,"obsProdMalha":""}]}]}},"geral_malha_AlterarEstrutura_retorno":{"type":"object","properties":{"idProduto":{"type":"integer","description":"Código interno de identificação do produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do produto gerado pelo Omie."},"intProduto":{"type":"string","description":"Código de integração do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código utilizado no seu aplicativo quando incluir um produto no Omie. Assim, poderá utilizá-lo para resgatar as informações do produto desejado. Caso informe esse campo, não informe a tag nCodProd. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"codStatus":{"type":"string","description":"Código do status."},"descrStatus":{"type":"string","description":"Descrição do Status."},"itemMalhaStatus":{"type":"array","items":{"type":"object","properties":{"idProdMalha":{"type":"integer","description":"Código interno de identificação do produto filho da estrutura."},"intProdMalha":{"type":"string","description":"Código de integração do produto filho da estrutura."},"idMalha":{"type":"integer","description":"Id da Malha."},"intMalha":{"type":"string","description":"Código de Integração da Malha."},"codStatus":{"type":"string","description":"Código do status."},"descrStatus":{"type":"string","description":"Descrição do Status."}}},"description":"Status do item da estrutura do produto."}},"title":"AlterarEstrutura (retorno)"},"geral_malha_ConsultarEstrutura":{"type":"object","title":"ConsultarEstrutura","description":"Consulta a estrutura do produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarEstrutura"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"idProduto":{"type":"integer","maxLength":15,"description":"Código interno de identificação do produto.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno do produto gerado pelo Omie."},"intProduto":{"type":"string","maxLength":60,"description":"Código de integração do produto.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código utilizado no seu aplicativo quando incluir um produto no Omie.\nAssim, poderá utilizá-lo para resgatar as informações do produto desejado.\nCaso informe esse campo, não informe a tag nCodProd. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"codProduto":{"type":"string","maxLength":60,"description":"Código do produto.\n\nConforme é exibido na tela do cadastro do produto."}}}}},"example":{"call":"ConsultarEstrutura","param":[{"idProduto":0,"intProduto":"","codProduto":""}]}},"geral_malha_ConsultarEstrutura_retorno":{"type":"object","properties":{"ident":{"type":"object","properties":{"idProduto":{"type":"integer","description":"Código interno de identificação do produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do produto gerado pelo Omie."},"intProduto":{"type":"string","description":"Código de integração do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código utilizado no seu aplicativo quando incluir um produto no Omie. Assim, poderá utilizá-lo para resgatar as informações do produto desejado. Caso informe esse campo, não informe a tag nCodProd. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"codProduto":{"type":"string","description":"Código do produto. Conforme é exibido na tela do cadastro do produto."},"descrProduto":{"type":"string","description":"Descrição do produto."},"tipoProduto":{"type":"string","description":"Tipo do Produto."},"idFamilia":{"type":"integer","description":"Id da Familia."},"codFamilia":{"type":"string","description":"Código da Familia."},"descrFamilia":{"type":"string","description":"Descrição da Familia."},"unidProduto":{"type":"string","description":"Unidade do produto."},"pesoLiqProduto":{"type":"decimal","description":"Peso Líquido do produto em Kg."},"pesoBrutoProduto":{"type":"decimal","description":"Peso Bruto do Produto em Kg."}},"description":"Identificação do produto."},"observacoes":{"type":"object","properties":{"obsRelevantes":{"type":"string","description":"Observações (recomendações ou instruções) relevantes para a produção desse produto."}},"description":"Observações."},"custoProducao":{"type":"object","properties":{"vMOD":{"type":"decimal","description":"Valor da Mão de Obra Direta (MOD)."},"vGGF":{"type":"decimal","description":"Valor dos Gastos Gerais de Fabricação (GGF)."}},"description":"Custo de Produção."},"itens":{"type":"array","items":{"type":"object","properties":{"idMalha":{"type":"integer","description":"Id da Malha."},"intMalha":{"type":"string","description":"Código de Integração da Malha."},"idProdMalha":{"type":"integer","description":"Código interno de identificação do produto filho da estrutura."},"intProdMalha":{"type":"string","description":"Código de integração do produto filho da estrutura."},"codProdMalha":{"type":"string","description":"Código do produto. Conforme é exibido na tela do cadastro do produto."},"descrProdMalha":{"type":"string","description":"Descrição do produto."},"quantProdMalha":{"type":"decimal","description":"Quantidade do item da estrutura do produto."},"unidProdMalha":{"type":"string","description":"Unidade do produto."},"tipoProdMalha":{"type":"string","description":"Tipo do Produto."},"idFamMalha":{"type":"integer","description":"Id da Familia."},"codFamMalha":{"type":"string","description":"Código da Familia."},"descrFamMalha":{"type":"string","description":"Descrição da Familia."},"pesoLiqProdMalha":{"type":"decimal","description":"Peso Líquido do produto em Kg."},"pesoBrutoProdMalha":{"type":"decimal","description":"Peso Bruto do Produto em Kg."},"percPerdaProdMalha":{"type":"decimal","description":"Percentual de perda."},"obsProdMalha":{"type":"string","description":"Observações do item da estrutura do produto."},"dIncProdMalha":{"type":"string","description":"Data de Inclusão do item da estrutura do produto."},"hIncProdMalha":{"type":"string","description":"Hora de Inclusão do item da estrutura do produto."},"uIncProdMalha":{"type":"string","description":"Usuário da Inclusão do item da estrutura do produto."},"dAltProdMalha":{"type":"string","description":"Data de Alteração do item da estrutura do produto."},"hAltProdMalha":{"type":"string","description":"Hora de Alteração do item da estrutura do produto."},"uAltProdMalha":{"type":"string","description":"Usuário da Alteração do item da estrutura do produto."}}},"description":"Itens da estrutura de produto."}},"title":"ConsultarEstrutura (retorno)"},"geral_malha_ExcluirEstrutura":{"type":"object","title":"ExcluirEstrutura","description":"Excluir item da estrutura de um produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirEstrutura"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"idProduto":{"type":"integer","maxLength":15,"description":"Código interno de identificação do produto.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno do produto gerado pelo Omie."},"intProduto":{"type":"string","maxLength":60,"description":"Código de integração do produto.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código utilizado no seu aplicativo quando incluir um produto no Omie.\nAssim, poderá utilizá-lo para resgatar as informações do produto desejado.\nCaso informe esse campo, não informe a tag nCodProd. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"idMalha":{"type":"integer","maxLength":15,"description":"Id da Malha."},"intMalha":{"type":"string","maxLength":20,"description":"Código de Integração da Malha."}}}}},"example":{"call":"ExcluirEstrutura","param":[{"idProduto":0,"intProduto":"","idMalha":0,"intMalha":""}]}},"geral_malha_ExcluirEstrutura_retorno":{"type":"object","properties":{"idProduto":{"type":"integer","description":"Código interno de identificação do produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do produto gerado pelo Omie."},"intProduto":{"type":"string","description":"Código de integração do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código utilizado no seu aplicativo quando incluir um produto no Omie. Assim, poderá utilizá-lo para resgatar as informações do produto desejado. Caso informe esse campo, não informe a tag nCodProd. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"idMalha":{"type":"integer","description":"Id da Malha."},"intMalha":{"type":"string","description":"Código de Integração da Malha."},"codStatus":{"type":"string","description":"Código do status."},"descrStatus":{"type":"string","description":"Descrição do Status."}},"title":"ExcluirEstrutura (retorno)"},"geral_malha_IncluirEstrutura":{"type":"object","title":"IncluirEstrutura","description":"Inclusão da Estrutura do produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirEstrutura"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"idProduto":{"type":"integer","maxLength":15,"description":"Código interno de identificação do produto.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno do produto gerado pelo Omie."},"intProduto":{"type":"string","maxLength":60,"description":"Código de integração do produto.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código utilizado no seu aplicativo quando incluir um produto no Omie.\nAssim, poderá utilizá-lo para resgatar as informações do produto desejado.\nCaso informe esse campo, não informe a tag nCodProd. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"itemMalhaIncluir":{"type":"array","items":{"type":"object","properties":{"intMalha":{"type":"string","maxLength":20,"description":"Código de Integração da Malha."},"idProdMalha":{"type":"integer","maxLength":15,"description":"Código interno de identificação do produto filho da estrutura."},"intProdMalha":{"type":"string","maxLength":20,"description":"Código de integração do produto filho da estrutura."},"quantProdMalha":{"type":"number","maxLength":19,"description":"Quantidade do item da estrutura do produto."},"percPerdaProdMalha":{"type":"number","maxLength":10,"description":"Percentual de perda."},"obsProdMalha":{"type":"string","description":"Observações do item da estrutura do produto."},"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do Local do Estoque."}},"required":["intMalha","quantProdMalha"]},"description":"Item da estrutura do produto."}}}}},"example":{"call":"IncluirEstrutura","param":[{"idProduto":0,"intProduto":"","itemMalhaIncluir":[{"intMalha":"","idProdMalha":0,"intProdMalha":"","quantProdMalha":0,"percPerdaProdMalha":0,"obsProdMalha":""}]}]}},"geral_malha_IncluirEstrutura_retorno":{"type":"object","properties":{"idProduto":{"type":"integer","description":"Código interno de identificação do produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do produto gerado pelo Omie."},"intProduto":{"type":"string","description":"Código de integração do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código utilizado no seu aplicativo quando incluir um produto no Omie. Assim, poderá utilizá-lo para resgatar as informações do produto desejado. Caso informe esse campo, não informe a tag nCodProd. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"codStatus":{"type":"string","description":"Código do status."},"descrStatus":{"type":"string","description":"Descrição do Status."},"itemMalhaStatus":{"type":"array","items":{"type":"object","properties":{"idProdMalha":{"type":"integer","description":"Código interno de identificação do produto filho da estrutura."},"intProdMalha":{"type":"string","description":"Código de integração do produto filho da estrutura."},"idMalha":{"type":"integer","description":"Id da Malha."},"intMalha":{"type":"string","description":"Código de Integração da Malha."},"codStatus":{"type":"string","description":"Código do status."},"descrStatus":{"type":"string","description":"Descrição do Status."}}},"description":"Status do item da estrutura do produto."}},"title":"IncluirEstrutura (retorno)"},"geral_malha_ListarEstruturas":{"type":"object","title":"ListarEstruturas","description":"Lista as estruturas de produtos.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarEstruturas"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página a ser recuperada."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Número de registros por página.\n(máximo 50)."},"cOrdenarPor":{"type":"string","maxLength":100,"description":"Ordem de exibição do dados.\nPode ser:\nCODIGO\nCODIGO_INTEGRACAO."},"dIncProdMalhaIni":{"type":"string","maxLength":10,"description":"Data de Inclusão do item da estrutura do produto."},"dIncProdMalhaFim":{"type":"string","maxLength":10,"description":"Data de Inclusão do item da estrutura do produto."},"hIncProdMalhaIni":{"type":"string","maxLength":8,"description":"Hora de Inclusão do item da estrutura do produto."},"hIncProdMalhaFim":{"type":"string","maxLength":8,"description":"Hora de Inclusão do item da estrutura do produto."},"dAltProdMalhaIni":{"type":"string","maxLength":10,"description":"Data de Alteração do item da estrutura do produto."},"dAltProdMalhaFim":{"type":"string","maxLength":10,"description":"Data de Alteração do item da estrutura do produto."},"hAltProdMalhaIni":{"type":"string","maxLength":8,"description":"Hora de Alteração do item da estrutura do produto."},"hAltProdMalhaFim":{"type":"string","maxLength":8,"description":"Hora de Alteração do item da estrutura do produto."}}}}},"example":{"call":"ListarEstruturas","param":[{"nPagina":1,"nRegPorPagina":100}]}},"geral_malha_ListarEstruturas_retorno":{"type":"object","properties":{"nPagina":{"type":"integer"},"nTotPaginas":{"type":"integer"},"nRegistros":{"type":"integer"},"nTotRegistros":{"type":"integer"},"produtosEncontrados":{"type":"array","items":{"type":"object","properties":{"ident":{"type":"object","properties":{"idProduto":{"type":"integer","description":"Código interno de identificação do produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do produto gerado pelo Omie."},"intProduto":{"type":"string","description":"Código de integração do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código utilizado no seu aplicativo quando incluir um produto no Omie. Assim, poderá utilizá-lo para resgatar as informações do produto desejado. Caso informe esse campo, não informe a tag nCodProd. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"codProduto":{"type":"string","description":"Código do produto. Conforme é exibido na tela do cadastro do produto."},"descrProduto":{"type":"string","description":"Descrição do produto."},"tipoProduto":{"type":"string","description":"Tipo do Produto."},"idFamilia":{"type":"integer","description":"Id da Familia."},"codFamilia":{"type":"string","description":"Código da Familia."},"descrFamilia":{"type":"string","description":"Descrição da Familia."},"unidProduto":{"type":"string","description":"Unidade do produto."},"pesoLiqProduto":{"type":"decimal","description":"Peso Líquido do produto em Kg."},"pesoBrutoProduto":{"type":"decimal","description":"Peso Bruto do Produto em Kg."}},"description":"Identificação do produto."},"observacoes":{"type":"object","properties":{"obsRelevantes":{"type":"string","description":"Observações (recomendações ou instruções) relevantes para a produção desse produto."}},"description":"Observações."},"custoProducao":{"type":"object","properties":{"vMOD":{"type":"decimal","description":"Valor da Mão de Obra Direta (MOD)."},"vGGF":{"type":"decimal","description":"Valor dos Gastos Gerais de Fabricação (GGF)."}},"description":"Custo de Produção."},"itens":{"type":"array","items":{"type":"object","properties":{"idMalha":{"type":"integer","description":"Id da Malha."},"intMalha":{"type":"string","description":"Código de Integração da Malha."},"idProdMalha":{"type":"integer","description":"Código interno de identificação do produto filho da estrutura."},"intProdMalha":{"type":"string","description":"Código de integração do produto filho da estrutura."},"codProdMalha":{"type":"string","description":"Código do produto. Conforme é exibido na tela do cadastro do produto."},"descrProdMalha":{"type":"string","description":"Descrição do produto."},"quantProdMalha":{"type":"decimal","description":"Quantidade do item da estrutura do produto."},"unidProdMalha":{"type":"string","description":"Unidade do produto."},"tipoProdMalha":{"type":"string","description":"Tipo do Produto."},"idFamMalha":{"type":"integer","description":"Id da Familia."},"codFamMalha":{"type":"string","description":"Código da Familia."},"descrFamMalha":{"type":"string","description":"Descrição da Familia."},"pesoLiqProdMalha":{"type":"decimal","description":"Peso Líquido do produto em Kg."},"pesoBrutoProdMalha":{"type":"decimal","description":"Peso Bruto do Produto em Kg."},"percPerdaProdMalha":{"type":"decimal","description":"Percentual de perda."},"obsProdMalha":{"type":"string","description":"Observações do item da estrutura do produto."},"dIncProdMalha":{"type":"string","description":"Data de Inclusão do item da estrutura do produto."},"hIncProdMalha":{"type":"string","description":"Hora de Inclusão do item da estrutura do produto."},"uIncProdMalha":{"type":"string","description":"Usuário da Inclusão do item da estrutura do produto."},"dAltProdMalha":{"type":"string","description":"Data de Alteração do item da estrutura do produto."},"hAltProdMalha":{"type":"string","description":"Hora de Alteração do item da estrutura do produto."},"uAltProdMalha":{"type":"string","description":"Usuário da Alteração do item da estrutura do produto."}}},"description":"Itens da estrutura de produto."}}}}},"title":"ListarEstruturas (retorno)"},"geral_meiospagamento_ListarMeiosPagamento":{"type":"object","title":"ListarMeiosPagamento","description":"Listagem de meios de pagamento.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarMeiosPagamento"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo":{"type":"string","maxLength":2,"description":"Código do tipo de documento."}}}}},"example":{"call":"ListarMeiosPagamento","param":[{"codigo":""}]}},"geral_meiospagamento_ListarMeiosPagamento_retorno":{"type":"object","properties":{"MeiosPagamentoLista":{"type":"array","items":{"type":"object","properties":{"codigo":{"type":"string","description":"Código do meio de pagamento."},"descricao":{"type":"string","description":"Descrição do meio de pagamento."}}},"description":"Lista de meios de pagamento."}},"title":"ListarMeiosPagamento (retorno)"},"geral_motivodevolucao_ListarMotivosDevol":{"type":"object","title":"ListarMotivosDevol","description":"Lista os motivos de devolução.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarMotivosDevol"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 500."}}}}},"example":{"call":"ListarMotivosDevol","param":[{"nPagina":1,"nRegPorPagina":20}]}},"geral_motivodevolucao_ListarMotivosDevol_retorno":{"type":"object","properties":{"nPagina":{"type":"integer","description":"Número da página retornada."},"nTotPaginas":{"type":"integer","description":"Número total de páginas."},"nRegistros":{"type":"integer","description":"Número de registros retornados na página."},"nTotRegistros":{"type":"integer","description":"Total de registros encontrados."},"listaMotivo":{"type":"array","items":{"type":"object","properties":{"nCodigo":{"type":"integer","description":"Código do motivo da devolução."},"cDescricao":{"type":"string","description":"Descrição do motivo da devolução."},"cInativo":{"type":"string","description":"Indica se o motivo da devolução está inativo. Pode ser \"S\" ou \"N\"."}}},"description":"Lista os cadastros encontrados."}},"title":"ListarMotivosDevol (retorno)"},"geral_negativacaoclientes_NegativacaoClientesContratado":{"type":"object","title":"NegativacaoClientesContratado","description":"Verifica se a negativação de clientes está contratado para o aplicativo.","required":["call","param"],"properties":{"call":{"type":"string","enum":["NegativacaoClientesContratado"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"aplicativo":{"type":"integer","description":"Opcional. Sem ele, vale o aplicativo de quem chama. Se vier, precisa ser o próprio aplicativo da chamada; outro valor é recusado."}}}}}},"geral_negativacaoclientes_NegativacaoClientesContratado_retorno":{"type":"object","properties":{"contratado":{"type":"boolean"}},"title":"NegativacaoClientesContratado (retorno)"},"geral_negativacaoclientes_NegativacaoClientesContratar":{"type":"object","title":"NegativacaoClientesContratar","description":"Contrata a negativação de clientes para o aplicativo.","required":["call","param"],"properties":{"call":{"type":"string","enum":["NegativacaoClientesContratar"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"aplicativo":{"type":"integer","description":"Opcional. Sem ele, vale o aplicativo de quem chama. Se vier, precisa ser o próprio aplicativo da chamada; outro valor é recusado."},"plano":{"type":"string","example":"mensal","description":"Plano da negativação de clientes a ser contratado, se é mensal, anual, etc."}},"required":["plano"]}}}},"geral_negativacaoclientes_NegativacaoClientesContratar_retorno":{"type":"object","properties":{"success":{"type":"boolean"}},"title":"NegativacaoClientesContratar (retorno)"},"geral_negativacaoclientes_NegativacaoClientesCriar":{"type":"object","title":"NegativacaoClientesCriar","description":"Inicia e executa a negativação de uma Conta em Atraso através de uma Conta a Receber, Cliente e Natureza da dívida. Ao criar uma negativação, você autoriza o envio dos dados da dívida para registro no Serasa. As informações do débito serão incluídas nos bancos de dados do Serasa, tornando-as visíveis para consultas realizadas por outras empresas e instituições financeiras.","required":["call","param"],"properties":{"call":{"type":"string","enum":["NegativacaoClientesCriar"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cliente":{"type":"integer","description":"Identificador único do Cliente Fornecedor (código)"},"conta_receber":{"type":"integer","description":"Identificador único da Conta a Receber (chave)"},"natureza_divida":{"type":"string","description":"Identificador único da Natureza da dívida (código)"}},"required":["cliente","conta_receber","natureza_divida"]}}}},"geral_negativacaoclientes_NegativacaoClientesCriar_retorno":{"type":"object","properties":{"success":{"type":"boolean"},"mensagem":{"type":"string"}},"title":"NegativacaoClientesCriar (retorno)"},"geral_negativacaoclientes_NegativacaoClientesCusto":{"type":"object","title":"NegativacaoClientesCusto","description":"Retorna o custo da negativação de clientes para o aplicativo.","required":["call","param"],"properties":{"call":{"type":"string","enum":["NegativacaoClientesCusto"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"aplicativo":{"type":"integer","description":"Opcional. Sem ele, vale o aplicativo de quem chama. Se vier, precisa ser o próprio aplicativo da chamada; outro valor é recusado."}}}}}},"geral_negativacaoclientes_NegativacaoClientesCusto_retorno":{"type":"object","properties":{"dados":{"type":"array","items":{"type":"object","properties":{"custo":{"type":"number"},"tipo":{"type":"string","description":"Tipo de custo da negativação de clientes, se é mensal, anual, etc."}}}}},"title":"NegativacaoClientesCusto (retorno)"},"geral_negativacaoclientes_NegativacaoClientesLista":{"type":"object","title":"NegativacaoClientesLista","description":"Lista clientes por palavra-chave.","required":["call","param"],"properties":{"call":{"type":"string","enum":["NegativacaoClientesLista"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"termo":{"type":"string","description":"Palavra-chave para busca de clientes, como CNAE´s (principal ou secundários), nome da empresa, etc."},"periodo":{"type":"integer","example":2,"description":"Período de abertura da empresa. Valores: últimos 2 meses até os últimos 20 anos. Deve ser sempre informado em meses. Exemplo: 2 para últimos 2 meses, 6 para últimos 6 meses, 12 para últimos 12 meses, etc."},"estado":{"type":"string","example":"SP","description":"Estado onde a empresa está localizada."},"cidade":{"type":"string","example":"São Paulo","description":"Cidade onde a empresa está localizada."},"bairro":{"type":"string","example":"Centro","description":"Bairro onde a empresa está localizada."}},"required":["termo"]}}}},"geral_negativacaoclientes_NegativacaoClientesLista_retorno":{"type":"object","properties":{"success":{"type":"boolean"},"dados":{"type":"array","items":{"type":"object","properties":{"documento":{"type":"string","description":"CPF ou CNPJ do cliente."},"nome":{"type":"string","description":"Nome do cliente."}}}}},"title":"NegativacaoClientesLista (retorno)"},"geral_negativacaoclientes_NegativacaoClientesNaturezasDivida":{"type":"object","title":"NegativacaoClientesNaturezasDivida","description":"Listar e consultar as naturezas de dívida disponíveis para negativação de clientes","required":["call","param"],"properties":{"call":{"type":"string","enum":["NegativacaoClientesNaturezasDivida"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"descricao":{"type":"string","description":"Palavra-chave para buscar e filtrar uma natureza de dívida específica."}}}}}},"geral_negativacaoclientes_NegativacaoClientesNaturezasDivida_retorno":{"type":"object","properties":{"dados":{"type":"array","items":{"type":"object","properties":{"codigo":{"type":"string"},"descricao":{"type":"string"}}}}},"title":"NegativacaoClientesNaturezasDivida (retorno)"},"geral_negativacaoclientes_NegativacaoClientesPesquisa":{"type":"object","title":"NegativacaoClientesPesquisa","description":"Pesquisa os dados do cliente pelo CPF ou CNPJ.","required":["call","param"],"properties":{"call":{"type":"string","enum":["NegativacaoClientesPesquisa"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"documento":{"type":"string","description":"CPF ou CNPJ do cliente para busca nas bases de dados de parceiros."}},"required":["documento"]}}}},"geral_negativacaoclientes_NegativacaoClientesPesquisa_retorno":{"type":"object","properties":{"success":{"type":"boolean"},"dados":{"type":"object","properties":{"documento":{"type":"string","description":"CPF ou CNPJ do cliente."},"nome":{"type":"string","description":"Nome do cliente."}},"description":"Dados do cliente retornados pela pesquisa no radar de clientes."}},"title":"NegativacaoClientesPesquisa (retorno)"},"geral_negativacaoclientes_NegativacaoClientesTotalRecuperado":{"type":"object","title":"NegativacaoClientesTotalRecuperado","description":"Consultar o valor total recuperado pós negativações","required":["call","param"],"properties":{"call":{"type":"string","enum":["NegativacaoClientesTotalRecuperado"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"aplicativo":{"type":"integer","description":"Opcional. Sem ele, vale o aplicativo de quem chama. Se vier, precisa ser o próprio aplicativo da chamada; outro valor é recusado."}}}}}},"geral_negativacaoclientes_NegativacaoClientesTotalRecuperado_retorno":{"type":"object","properties":{"valor_total":{"type":"number"}},"title":"NegativacaoClientesTotalRecuperado (retorno)"},"geral_origemlancamento_ListarOrigem":{"type":"object","title":"ListarOrigem","description":"","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarOrigem"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo":{"type":"string","maxLength":4,"description":"Código da origem."}}}}},"example":{"call":"ListarOrigem","param":[{"codigo":""}]}},"geral_origemlancamento_ListarOrigem_retorno":{"type":"object","properties":{"pagina":{"type":"integer"},"total_de_paginas":{"type":"integer"},"registros":{"type":"integer"},"total_de_registros":{"type":"integer"},"origem":{"type":"array","items":{"type":"object","properties":{"codigo":{"type":"string","description":"Código da origem."},"descricao":{"type":"string","description":"Descrição da origem."}}}}},"title":"ListarOrigem (retorno)"},"geral_origempedido_ListarOrigem":{"type":"object","title":"ListarOrigem","description":"Lista Origem de pedidos.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarOrigem"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo":{"type":"string","maxLength":3,"description":"Código da origem."}}}}},"example":{"call":"ListarOrigem","param":[{"codigo":""}]}},"geral_origempedido_ListarOrigem_retorno":{"type":"object","properties":{"pagina":{"type":"integer"},"total_de_paginas":{"type":"integer"},"registros":{"type":"integer"},"total_de_registros":{"type":"integer"},"origem":{"type":"array","items":{"type":"object","properties":{"codigo":{"type":"string","description":"Código da origem."},"descricao":{"type":"string","description":"Descrição da origem."}}}}},"title":"ListarOrigem (retorno)"},"geral_paises_ListarPaises":{"type":"object","title":"ListarPaises","description":"Lista os países.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarPaises"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"filtrar_por_codigo":{"type":"string","description":"Código do País (IBGE)."},"filtrar_por_descricao":{"type":"string","description":"Descrição do País."},"filtrar_por_codigo_iso":{"type":"string","maxLength":2,"description":"Código ISO do País."}}}}},"example":{"call":"ListarPaises","param":[{"filtrar_por_codigo":"","filtrar_por_descricao":""}]}},"geral_paises_ListarPaises_retorno":{"type":"object","properties":{"lista_paises":{"type":"array","items":{"type":"object","properties":{"cCodigo":{"type":"string","description":"Código do País."},"cDescricao":{"type":"string","description":"Descrição do País."},"cCodigoISO":{"type":"string","description":"Código ISO do País."}}},"description":"Lista de Países."}},"title":"ListarPaises (retorno)"},"geral_parcelas_IncluirParcela":{"type":"object","title":"IncluirParcela","description":"Método para a criação de uma parcela.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirParcela"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cParcela":{"type":"string","example":"10/20/30/40","description":"Descrição da parcela a ser criada\n\nPossíveis formatos:\n\n\"10/20/30/40\" - Com este tipo de formatação, o sistema entenderá que deve cadastrar 4 Parcelas. Sendo a primeira para 10 dias, a segunda para 20 dias e, assim, sucessivamente.\n\"A Vista/40/60\" - Nesta formatação, será cadastrada para 3 Parcelas. Sendo a primeira a vista, a segunda para 40 dias e, a terceira, para 60 dias.\n\"Para 93 dias\" - Com esse preenchimento, será cadastrada uma Parcela para 93 dias após o faturamento.\n\"50\" - Ao indicar um número único, o sistema entenderá que se trata da quantidade total de Parcelas. Neste caso, será cadastrado 50 Parcelas."}},"required":["cParcela"]}}},"example":{"call":"IncluirParcela","param":[{"cParcela":""}]}},"geral_parcelas_IncluirParcela_retorno":{"type":"object","properties":{"cCodStatus":{"type":"string","description":"Código de status da operação (\"0\" para sucesso)."},"cDesStatus":{"type":"string","description":"Descrição textual do status da operação."},"cCodParcela":{"type":"string","description":"Código da parcela gerada."},"cDesParcela":{"type":"string","description":"Descrição da parcela gerada."}},"title":"IncluirParcela (retorno)"},"geral_parcelas_ListarParcelas":{"type":"object","title":"ListarParcelas","description":"Lista de Parcelas cadastradas.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarParcelas"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"apenas_importado_api":{"type":"string","maxLength":1,"example":"S","description":"Exibir apenas os registros gerados pela API"},"ordenar_por":{"type":"string","maxLength":100,"example":"CODIGO","description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"example":"S","description":"Se a lista será apresentada em ordem decrescente."},"filtrar_por_descricao":{"type":"string","maxLength":100,"description":"Filtrar parcelas por descrição."}}}}},"example":{"call":"ListarParcelas","param":[{"pagina":1,"registros_por_pagina":50}]}},"geral_parcelas_ListarParcelas_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada"},"total_de_paginas":{"type":"integer","description":"Número total de páginas"},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"Total de registros encontrados."},"cadastros":{"type":"array","items":{"type":"object","properties":{"nCodigo":{"type":"string","description":"Código da parcela."},"cDescricao":{"type":"string","description":"Descrição da parcela."},"nParcelas":{"type":"integer","description":"Número de parcelas."}}},"description":"Lista os cadastros encontrados."}},"title":"ListarParcelas (retorno)"},"geral_periodosnotificacao_ListarPeriodosNotificacao":{"type":"object","title":"ListarPeriodosNotificacao","description":"Método para realizar a listagem de períodos de notificação.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarPeriodosNotificacao"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página, a partir de 1. Padrão 1."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Quantidade de registros por página. Padrão 500."}}}}},"example":{"call":"ListarPeriodosNotificacao","param":[{"nPagina":1,"nRegPorPagina":100}]}},"geral_periodosnotificacao_ListarPeriodosNotificacao_retorno":{"type":"object","properties":{"cCodStatus":{"type":"string","description":"Código do status: \"0\" para sucesso; \"1001\" quando a página não tem registros."},"cDesStatus":{"type":"string","description":"Descrição do status."},"nPagina":{"type":"integer","description":"Número da página retornada."},"nRegistros":{"type":"integer","description":"Quantidade de registros na página."},"nTotPaginas":{"type":"integer","description":"Total de páginas."},"nTotRegistros":{"type":"integer","description":"Total de registros encontrados."},"listaPeriodos":{"type":"array","items":{"type":"object","properties":{"nCodNotif":{"type":"integer","description":"Código do período, a informar em nCodNotif da tarefa."},"cDescricao":{"type":"string","description":"Descrição do período (ex.: 15 minutos antes)."},"nDias":{"type":"integer","description":"Antecedência em dias."},"nMinutos":{"type":"integer","description":"Antecedência em minutos."}}},"description":"Períodos de antecedência do lembrete de tarefa."}},"title":"ListarPeriodosNotificacao (retorno)"},"geral_prodcaract_AlterarCaractProduto":{"type":"object","title":"AlterarCaractProduto","description":"Altera a característica de um produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarCaractProduto"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodProd":{"type":"integer","maxLength":15,"description":"Código do produto.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno do produto gerado pelo Omie."},"cCodIntProd":{"type":"string","maxLength":60,"description":"Código de integração do produto.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código utilizado no seu aplicativo quando incluir um produto no Omie.\nAssim, poderá utilizá-lo para resgatar as informações do produto desejado.\nCaso informe esse campo, não informe a tag nCodProd. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"nCodCaract":{"type":"integer","maxLength":15,"description":"Código da característica de produto.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno da característica do produto gerado pelo Omie."},"cCodIntCaract":{"type":"string","maxLength":60,"description":"Código de integração da característica do produto.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código da característica utilizado no seu aplicativo quando incluir uma característica no Omie.\nAssim, poderá utilizar esse campo para resgatar as informações da característica desejada.\nCaso informe esse campo, não informe a tag nCodCaract. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"cConteudo":{"type":"string","maxLength":60,"description":"Conteúdo da característica."},"cExibirItemNF":{"type":"string","maxLength":1,"example":"S","description":"Exibir esta característica no item da NF-e emitida (S/N)."},"cExibirItemPedido":{"type":"string","maxLength":1,"example":"S","description":"Exibir esta característica no item do Pedido, Remessa ou Devolução (S/N)."},"cExibirOrdemProd":{"type":"string","maxLength":1,"example":"S","description":"Exibir esta característica na Ordem de Produção e Mapa de Custo (S/N)."}}}}},"example":{"call":"AlterarCaractProduto","param":[{"nCodProd":0,"cCodIntProd":"","nCodCaract":0,"cCodIntCaract":"","cConteudo":"","cExibirItemNF":"S","cExibirItemPedido":"S","cExibirOrdemProd":"S"}]}},"geral_prodcaract_AlterarCaractProduto_retorno":{"type":"object","properties":{"nCodProd":{"type":"integer","description":"Código do produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do produto gerado pelo Omie."},"cCodIntProd":{"type":"string","description":"Código de integração do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código utilizado no seu aplicativo quando incluir um produto no Omie. Assim, poderá utilizá-lo para resgatar as informações do produto desejado. Caso informe esse campo, não informe a tag nCodProd. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"nCodCaract":{"type":"integer","description":"Código da característica de produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da característica do produto gerado pelo Omie."},"cCodIntCaract":{"type":"string","description":"Código de integração da característica do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código da característica utilizado no seu aplicativo quando incluir uma característica no Omie. Assim, poderá utilizar esse campo para resgatar as informações da característica desejada. Caso informe esse campo, não informe a tag nCodCaract. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro duranteo o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodigoStatus\"."}},"title":"AlterarCaractProduto (retorno)"},"geral_prodcaract_ConsultarCaractProduto":{"type":"object","title":"ConsultarCaractProduto","description":"Consultar uma característica de um produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarCaractProduto"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodProd":{"type":"integer","maxLength":15,"description":"Código do produto.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno do produto gerado pelo Omie."},"cCodIntProd":{"type":"string","maxLength":60,"description":"Código de integração do produto.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código utilizado no seu aplicativo quando incluir um produto no Omie.\nAssim, poderá utilizá-lo para resgatar as informações do produto desejado.\nCaso informe esse campo, não informe a tag nCodProd. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"nCodCaract":{"type":"integer","maxLength":15,"description":"Código da característica de produto.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno da característica do produto gerado pelo Omie."},"cCodIntCaract":{"type":"string","maxLength":60,"description":"Código de integração da característica do produto.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código da característica utilizado no seu aplicativo quando incluir uma característica no Omie.\nAssim, poderá utilizar esse campo para resgatar as informações da característica desejada.\nCaso informe esse campo, não informe a tag nCodCaract. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."}}}}},"example":{"call":"ConsultarCaractProduto","param":[{"nCodProd":0,"cCodIntProd":"","nCodCaract":0,"cCodIntCaract":""}]}},"geral_prodcaract_ConsultarCaractProduto_retorno":{"type":"object","properties":{"nCodProd":{"type":"integer","description":"Código do produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do produto gerado pelo Omie."},"cCodIntProd":{"type":"string","description":"Código de integração do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código utilizado no seu aplicativo quando incluir um produto no Omie. Assim, poderá utilizá-lo para resgatar as informações do produto desejado. Caso informe esse campo, não informe a tag nCodProd. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"nCodCaract":{"type":"integer","description":"Código da característica de produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da característica do produto gerado pelo Omie."},"cCodIntCaract":{"type":"string","description":"Código de integração da característica do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código da característica utilizado no seu aplicativo quando incluir uma característica no Omie. Assim, poderá utilizar esse campo para resgatar as informações da característica desejada. Caso informe esse campo, não informe a tag nCodCaract. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"cNomeCaract":{"type":"string","description":"Nome da característica."},"cConteudo":{"type":"string","description":"Conteúdo da característica."},"cExibirItemNF":{"type":"string","description":"Exibir esta característica no item da NF-e emitida (S/N)."},"cExibirItemPedido":{"type":"string","description":"Exibir esta característica no item do Pedido, Remessa ou Devolução (S/N)."},"cExibirOrdemProd":{"type":"string","description":"Exibir esta característica na Ordem de Produção e Mapa de Custo (S/N)."},"info":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão. No formato dd/mm/aaaa."},"hInc":{"type":"string","description":"Hora da Inclusão. No formato hh:mm:ss."},"uInc":{"type":"string","description":"Usuário da Inclusão."},"dAlt":{"type":"string","description":"Data da Alteração. No formato dd/mm/aaaa."},"hAlt":{"type":"string","description":"Hora da Alteração. No formato hh:mm:ss."},"uAlt":{"type":"string","description":"Usuário da Alteração."},"cImpAPI":{"type":"string","description":"Importado pela API (S/N)."}},"description":"Informações complemetares da característica."}},"title":"ConsultarCaractProduto (retorno)"},"geral_prodcaract_ExcluirCaractProduto":{"type":"object","title":"ExcluirCaractProduto","description":"Excluir um característica de um produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirCaractProduto"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodProd":{"type":"integer","maxLength":15,"description":"Código do produto.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno do produto gerado pelo Omie."},"cCodIntProd":{"type":"string","maxLength":60,"description":"Código de integração do produto.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código utilizado no seu aplicativo quando incluir um produto no Omie.\nAssim, poderá utilizá-lo para resgatar as informações do produto desejado.\nCaso informe esse campo, não informe a tag nCodProd. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"nCodCaract":{"type":"integer","maxLength":15,"description":"Código da característica de produto.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno da característica do produto gerado pelo Omie."},"cCodIntCaract":{"type":"string","maxLength":60,"description":"Código de integração da característica do produto.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código da característica utilizado no seu aplicativo quando incluir uma característica no Omie.\nAssim, poderá utilizar esse campo para resgatar as informações da característica desejada.\nCaso informe esse campo, não informe a tag nCodCaract. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."}}}}},"example":{"call":"ExcluirCaractProduto","param":[{"nCodProd":0,"cCodIntProd":"","nCodCaract":0,"cCodIntCaract":""}]}},"geral_prodcaract_ExcluirCaractProduto_retorno":{"type":"object","properties":{"nCodProd":{"type":"integer","description":"Código do produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do produto gerado pelo Omie."},"cCodIntProd":{"type":"string","description":"Código de integração do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código utilizado no seu aplicativo quando incluir um produto no Omie. Assim, poderá utilizá-lo para resgatar as informações do produto desejado. Caso informe esse campo, não informe a tag nCodProd. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"nCodCaract":{"type":"integer","description":"Código da característica de produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da característica do produto gerado pelo Omie."},"cCodIntCaract":{"type":"string","description":"Código de integração da característica do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código da característica utilizado no seu aplicativo quando incluir uma característica no Omie. Assim, poderá utilizar esse campo para resgatar as informações da característica desejada. Caso informe esse campo, não informe a tag nCodCaract. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro duranteo o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodigoStatus\"."}},"title":"ExcluirCaractProduto (retorno)"},"geral_prodcaract_IncluirCaractProduto":{"type":"object","title":"IncluirCaractProduto","description":"Inclui uma característica a um produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirCaractProduto"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodProd":{"type":"integer","maxLength":15,"description":"Código do produto.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno do produto gerado pelo Omie."},"cCodIntProd":{"type":"string","maxLength":60,"description":"Código de integração do produto.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código utilizado no seu aplicativo quando incluir um produto no Omie.\nAssim, poderá utilizá-lo para resgatar as informações do produto desejado.\nCaso informe esse campo, não informe a tag nCodProd. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"nCodCaract":{"type":"integer","maxLength":15,"description":"Código da característica de produto.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno da característica do produto gerado pelo Omie."},"cCodIntCaract":{"type":"string","maxLength":60,"description":"Código de integração da característica do produto.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código da característica utilizado no seu aplicativo quando incluir uma característica no Omie.\nAssim, poderá utilizar esse campo para resgatar as informações da característica desejada.\nCaso informe esse campo, não informe a tag nCodCaract. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"cConteudo":{"type":"string","maxLength":60,"description":"Conteúdo da característica."},"cExibirItemNF":{"type":"string","maxLength":1,"example":"S","description":"Exibir esta característica no item da NF-e emitida (S/N)."},"cExibirItemPedido":{"type":"string","maxLength":1,"example":"S","description":"Exibir esta característica no item do Pedido, Remessa ou Devolução (S/N)."},"cExibirOrdemProd":{"type":"string","maxLength":1,"example":"S","description":"Exibir esta característica na Ordem de Produção e Mapa de Custo (S/N)."}},"required":["cConteudo"]}}},"example":{"call":"IncluirCaractProduto","param":[{"nCodProd":0,"cCodIntProd":"","nCodCaract":0,"cCodIntCaract":"","cConteudo":"","cExibirItemNF":"S","cExibirItemPedido":"S","cExibirOrdemProd":"S"}]}},"geral_prodcaract_IncluirCaractProduto_retorno":{"type":"object","properties":{"nCodProd":{"type":"integer","description":"Código do produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do produto gerado pelo Omie."},"cCodIntProd":{"type":"string","description":"Código de integração do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código utilizado no seu aplicativo quando incluir um produto no Omie. Assim, poderá utilizá-lo para resgatar as informações do produto desejado. Caso informe esse campo, não informe a tag nCodProd. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"nCodCaract":{"type":"integer","description":"Código da característica de produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da característica do produto gerado pelo Omie."},"cCodIntCaract":{"type":"string","description":"Código de integração da característica do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código da característica utilizado no seu aplicativo quando incluir uma característica no Omie. Assim, poderá utilizar esse campo para resgatar as informações da característica desejada. Caso informe esse campo, não informe a tag nCodCaract. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro duranteo o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodigoStatus\"."}},"title":"IncluirCaractProduto (retorno)"},"geral_prodcaract_ListarCaractProduto":{"type":"object","title":"ListarCaractProduto","description":"Lista as características de um produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarCaractProduto"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página que se deseja resgatar.\nO padrão é \"1\"."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Número de registros retornados por página.\nO padrão é 20.\nO limite máximo é 50 por página."},"cOrdenarPor":{"type":"string","maxLength":100,"description":"Ordena os resultados da página por:\nCODIGO - Código da Característica.\nCODINT - Código de Integração da Característica.\nNOME - Nome da Característica."},"cOrdemDecrescente":{"type":"string","maxLength":1,"description":"Indica se a ordem de exibição é Decrescente caso seja informado \"S\"."},"dDtIncDe":{"type":"string","maxLength":10,"description":"Data de inclusão inicial.\nNo formato dd/mm/aaaa."},"dDtIncAte":{"type":"string","maxLength":10,"description":"Data de inclusão final.\nNo formato dd/mm/aaaa."},"dDtAltDe":{"type":"string","maxLength":10,"description":"Data de alteração inicial.\nNo formato dd/mm/aaaa."},"dDtAltAte":{"type":"string","maxLength":10,"description":"Data de alteração final.\nNo formato dd/mm/aaaa."},"nCodProd":{"type":"integer","maxLength":15,"description":"Código do produto.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno do produto gerado pelo Omie."},"cCodIntProd":{"type":"string","maxLength":60,"description":"Código de integração do produto.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código utilizado no seu aplicativo quando incluir um produto no Omie.\nAssim, poderá utilizá-lo para resgatar as informações do produto desejado.\nCaso informe esse campo, não informe a tag nCodProd. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."}}}}},"example":{"call":"ListarCaractProduto","param":[{"nPagina":1,"nRegPorPagina":50,"nCodProd":0}]}},"geral_prodcaract_ListarCaractProduto_retorno":{"type":"object","properties":{"nPagina":{"type":"integer","description":"Número da página resgatada."},"nTotPaginas":{"type":"integer","description":"Número total de páginas encontradas."},"nRegistros":{"type":"integer","description":"Número de registros retornados na página."},"nTotRegistros":{"type":"integer","description":"Número total de registros encontrados."},"listaCaracteristicas":{"type":"array","items":{"type":"object","properties":{"nCodProd":{"type":"integer","description":"Código do produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do produto gerado pelo Omie."},"cCodIntProd":{"type":"string","description":"Código de integração do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código utilizado no seu aplicativo quando incluir um produto no Omie. Assim, poderá utilizá-lo para resgatar as informações do produto desejado. Caso informe esse campo, não informe a tag nCodProd. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"nCodCaract":{"type":"integer","description":"Código da característica de produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da característica do produto gerado pelo Omie."},"cCodIntCaract":{"type":"string","description":"Código de integração da característica do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código da característica utilizado no seu aplicativo quando incluir uma característica no Omie. Assim, poderá utilizar esse campo para resgatar as informações da característica desejada. Caso informe esse campo, não informe a tag nCodCaract. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"cNomeCaract":{"type":"string","description":"Nome da característica."},"cConteudo":{"type":"string","description":"Conteúdo da característica."},"cExibirItemNF":{"type":"string","description":"Exibir esta característica no item da NF-e emitida (S/N)."},"cExibirItemPedido":{"type":"string","description":"Exibir esta característica no item do Pedido, Remessa ou Devolução (S/N)."},"cExibirOrdemProd":{"type":"string","description":"Exibir esta característica na Ordem de Produção e Mapa de Custo (S/N)."},"info":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão. No formato dd/mm/aaaa."},"hInc":{"type":"string","description":"Hora da Inclusão. No formato hh:mm:ss."},"uInc":{"type":"string","description":"Usuário da Inclusão."},"dAlt":{"type":"string","description":"Data da Alteração. No formato dd/mm/aaaa."},"hAlt":{"type":"string","description":"Hora da Alteração. No formato hh:mm:ss."},"uAlt":{"type":"string","description":"Usuário da Alteração."},"cImpAPI":{"type":"string","description":"Importado pela API (S/N)."}},"description":"Informações complemetares da característica."}}},"description":"Lista de características de produto."}},"title":"ListarCaractProduto (retorno)"},"geral_prodimp_AlterarImposto":{"type":"object","title":"AlterarImposto","description":"Altera o imposto de um produto","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarImposto"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"ident":{"type":"object","properties":{"nCodProd":{"type":"integer","maxLength":15,"description":"Código do produto no Omie. Informe nCodProd ou cCodIntProd."},"cCodIntProd":{"type":"string","maxLength":60,"description":"Código de integração do produto, com até 20 caracteres. Informe nCodProd ou cCodIntProd."},"cCodIntImp":{"type":"string","maxLength":20,"description":"Código de integração da regra de imposto, escolhido por quem inclui, com até 20 caracteres. Obrigatório; identifica a regra junto com o produto."}},"description":"Identificação do imposto do produto."},"cabec":{"type":"object","properties":{"cCupomFiscal":{"type":"string","maxLength":1,"description":"Regra para venda com cupom fiscal no PDV? S ou N. Obrigatório na inclusão e na alteração."},"cUfOrigem":{"type":"string","maxLength":2,"description":"Sigla do estado de origem da venda. Obrigatório na inclusão e na alteração."},"cUfDestino":{"type":"string","maxLength":2,"description":"Sigla do estado de destino. Obrigatório quando cCupomFiscal é N."},"cCFOP":{"type":"string","maxLength":10,"description":"CFOP da operação, com ou sem ponto; gravado no formato 9.999. Obrigatório na inclusão e na alteração."},"cCNAECliente":{"type":"string","maxLength":7,"description":"CNAE do cliente a que a regra se aplica (7 dígitos). Informe um único código; vazio vale para qualquer cliente."},"cContribICMS":{"type":"string","maxLength":1,"description":"S para aplicar a regra apenas quando o cliente for contribuinte do ICMS; N caso contrário."},"cIndicadorEscala":{"type":"string","maxLength":1,"description":"Indicador de Produção em Escala Relevante.\n\nPode ser:\n\"S\" para Produzido em Escala Relevante.\n\"N\" para Produzido em Escala NÃO Relevante.\n\nVem do cadastro do produto; só aparece na listagem."},"cCNPJFabricante":{"type":"string","maxLength":20,"description":"CNPJ do fabricante da mercadoria. Vem do cadastro do produto; só aparece na listagem."}},"description":"Cabeçalho dos dados do imposto."},"ECF":{"type":"object","properties":{"cECFNaoTrib":{"type":"string","maxLength":1,"description":"ICMS - Não tributado."},"cECFSubstTrib":{"type":"string","maxLength":1,"description":"ICMS - Substituição Tributária."},"cECFIsento":{"type":"string","maxLength":1,"description":"ICMS - Isento."}},"description":"Informações referentes a ECF."},"ICMS":{"type":"object","properties":{"cCSTICMS":{"type":"string","maxLength":2,"description":"Código da Situação Tributária do ICMS."},"cOrigemICMS":{"type":"string","maxLength":1,"description":"Origem do ICMS."},"cModBCICMS":{"type":"string","maxLength":1,"description":"Modalidade da BC do ICMS."},"nRedBCICMS":{"type":"number","maxLength":10,"description":"Redução da BC do ICMS."},"nAliqICMS":{"type":"number","maxLength":10,"description":"Alíquota do ICMS."},"nPercDifICMS":{"type":"number","maxLength":10,"description":"Percentual do Diferimento do ICMS."}},"description":"Dados do ICMS."},"ICMSSN":{"type":"object","properties":{"cCSOSNICMS":{"type":"string","maxLength":3,"description":"Situação Tributária do ICMS Simples Nacional (CSOSN)."},"cOrigemICMS":{"type":"string","maxLength":1,"description":"Origem do ICMS."},"cModBCICMS":{"type":"string","maxLength":1,"description":"Modalidade da BC do ICMS."},"nAlCredICMS":{"type":"number","maxLength":10,"description":"Alíq. de Cálculo de Crédito do ICMS."},"nRedBCICMS":{"type":"number","maxLength":10,"description":"Redução da BC do ICMS."},"nAliqICMS":{"type":"number","maxLength":10,"description":"Alíquota do ICMS."}},"description":"Dados do ICMS - Simples Nacional."},"ICMSST":{"type":"object","properties":{"cModBCICMSST":{"type":"string","maxLength":1,"description":"Modalidade da BC do ICMS - ST."},"nMargValAdICMSST":{"type":"number","maxLength":10,"description":"Margem de Valor Adicionado do ICMS - ST."},"nRedBCICMSST":{"type":"number","maxLength":10,"description":"Redução da BC do ICMS - ST."},"nAliqICMSST":{"type":"number","maxLength":10,"description":"Alíquota do ICMS -  ST."},"nAliqOPICMSST":{"type":"number","maxLength":10,"description":"Alíquota do ICMS Operação Própria."},"cCEST":{"type":"string","maxLength":9,"description":"CEST (Código Especificador da Substituição Tributária)"}},"description":"Dados do ICMS - Substituição Tributária."},"ICMSIE":{"type":"object","properties":{"nPercFCP":{"type":"number","maxLength":10,"description":"Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de Destino."},"nAlIntUFDest":{"type":"number","maxLength":10,"description":"Alíquota Interna da UF de Destino."},"nAlInterestUFs":{"type":"number","maxLength":10,"description":"Alíquota Interestadual das UFs Envolvidas."},"nPercICMSIE":{"type":"number","maxLength":10,"description":"Partilha ICMS Interestadual."}},"description":"Dados do ICMS Interestadual."},"PIS":{"type":"object","properties":{"cCSTPIS":{"type":"string","maxLength":2,"description":"Código da Situação Tributária do PIS."},"cTpCalcPIS":{"type":"string","maxLength":1,"description":"Tipo de Cálculo para obter o PIS."},"nAliqPIS":{"type":"number","maxLength":10,"description":"Alíquota do PIS."},"nValUnTribPIS":{"type":"number","maxLength":18,"description":"Valor do PIS por Unidade Tributável."}},"description":"Dados do PIS"},"COFINS":{"type":"object","properties":{"cCSTCOFINS":{"type":"string","maxLength":2,"description":"Código da Situação Tributária do COFINS."},"cTpCalcCOFINS":{"type":"string","maxLength":1,"description":"Tipo de Cálculo para obter o COFINS."},"nAliqCOFINS":{"type":"number","maxLength":10,"description":"Alíquota do COFINS."},"nValUnTribCOFINS":{"type":"number","maxLength":18,"description":"Valor do COFINS por Unidade Tributável."}},"description":"Dados do COFINS."},"IPI":{"type":"object","properties":{"cCSTIPI":{"type":"string","maxLength":2,"description":"Código da Situação Tributária do IPI."},"cTpCalcIPI":{"type":"string","maxLength":1,"description":"Tipo de Cálculo para obter o IPI."},"nAliqIPI":{"type":"number","maxLength":10,"description":"Alíquota do IPI."},"nValUnTribIPI":{"type":"number","maxLength":18,"description":"Valor do IPI por Unidade Tributável."},"cEnqIPI":{"type":"string","maxLength":3,"description":"Enquadramento Fiscal do IPI,"}},"description":"Dados do IPI."},"InfAdic":{"type":"object","properties":{"cInfAdicNF":{"type":"string","description":"Informações para a Nota Fiscal.\n(elas aparecerão nas informações complementares do DANFE e da NF-e)."}},"description":"Informações adicionais para Nota Fiscal."}}}}},"example":{"call":"AlterarImposto","param":[{"ident":{"nCodProd":3456789012,"cCodIntImp":"SP-SP-5102"},"cabec":{"cCupomFiscal":"N","cUfOrigem":"SP","cUfDestino":"SP","cCFOP":"5.102","cContribICMS":"S"},"ICMS":{"cCSTICMS":"00","cOrigemICMS":"0","cModBCICMS":"3","nRedBCICMS":0,"nAliqICMS":18},"PIS":{"cCSTPIS":"01","cTpCalcPIS":"P","nAliqPIS":1.65},"COFINS":{"cCSTCOFINS":"01","cTpCalcCOFINS":"P","nAliqCOFINS":7.6},"InfAdic":{"cInfAdicNF":""}}]}},"geral_prodimp_AlterarImposto_retorno":{"type":"object","properties":{"nCodProd":{"type":"integer","description":"Código do produto no Omie."},"cCodIntProd":{"type":"string","description":"Código de integração do produto."},"cCodIntImp":{"type":"string","description":"Código de integração da regra de imposto."},"cCodStatus":{"type":"string","description":"Código do status: \"0\" para sucesso."},"cDescStatus":{"type":"string","description":"Descrição do status."}},"title":"AlterarImposto (retorno)"},"geral_prodimp_ExcluirImposto":{"type":"object","title":"ExcluirImposto","description":"Exclui um imposto apreendido de um produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirImposto"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodProd":{"type":"integer","maxLength":15,"description":"Código do produto no Omie."},"cCodIntProd":{"type":"string","maxLength":60,"description":"Código de integração do produto."},"cCodIntImp":{"type":"string","maxLength":20,"description":"Código de integração da regra de imposto a excluir (o mesmo de ident.cCodIntImp na inclusão)."}},"required":["cCodIntImp"]}}},"example":{"call":"ExcluirImposto","param":[{"nCodProd":3456789012,"cCodIntImp":"SP-SP-5102"}]}},"geral_prodimp_ExcluirImposto_retorno":{"type":"object","properties":{"nCodProd":{"type":"integer","description":"Código do produto no Omie."},"cCodIntProd":{"type":"string","description":"Código de integração do produto."},"cCodIntImp":{"type":"string","description":"Código de integração da regra de imposto."},"cCodStatus":{"type":"string","description":"Código do status: \"0\" para sucesso."},"cDescStatus":{"type":"string","description":"Descrição do status."}},"title":"ExcluirImposto (retorno)"},"geral_prodimp_IncluirImposto":{"type":"object","title":"IncluirImposto","description":"Inclui o imposto de um produto","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirImposto"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"ident":{"type":"object","properties":{"nCodProd":{"type":"integer","maxLength":15,"description":"Código do produto no Omie. Informe nCodProd ou cCodIntProd."},"cCodIntProd":{"type":"string","maxLength":60,"description":"Código de integração do produto, com até 20 caracteres. Informe nCodProd ou cCodIntProd."},"cCodIntImp":{"type":"string","maxLength":20,"description":"Código de integração da regra de imposto, escolhido por quem inclui, com até 20 caracteres. Obrigatório; identifica a regra junto com o produto."}},"description":"Identificação do imposto do produto."},"cabec":{"type":"object","properties":{"cCupomFiscal":{"type":"string","maxLength":1,"description":"Regra para venda com cupom fiscal no PDV? S ou N. Obrigatório na inclusão e na alteração."},"cUfOrigem":{"type":"string","maxLength":2,"description":"Sigla do estado de origem da venda. Obrigatório na inclusão e na alteração."},"cUfDestino":{"type":"string","maxLength":2,"description":"Sigla do estado de destino. Obrigatório quando cCupomFiscal é N."},"cCFOP":{"type":"string","maxLength":10,"description":"CFOP da operação, com ou sem ponto; gravado no formato 9.999. Obrigatório na inclusão e na alteração."},"cCNAECliente":{"type":"string","maxLength":7,"description":"CNAE do cliente a que a regra se aplica (7 dígitos). Informe um único código; vazio vale para qualquer cliente."},"cContribICMS":{"type":"string","maxLength":1,"description":"S para aplicar a regra apenas quando o cliente for contribuinte do ICMS; N caso contrário."},"cIndicadorEscala":{"type":"string","maxLength":1,"description":"Indicador de Produção em Escala Relevante.\n\nPode ser:\n\"S\" para Produzido em Escala Relevante.\n\"N\" para Produzido em Escala NÃO Relevante.\n\nVem do cadastro do produto; só aparece na listagem."},"cCNPJFabricante":{"type":"string","maxLength":20,"description":"CNPJ do fabricante da mercadoria. Vem do cadastro do produto; só aparece na listagem."}},"description":"Cabeçalho dos dados do imposto."},"ECF":{"type":"object","properties":{"cECFNaoTrib":{"type":"string","maxLength":1,"description":"ICMS - Não tributado."},"cECFSubstTrib":{"type":"string","maxLength":1,"description":"ICMS - Substituição Tributária."},"cECFIsento":{"type":"string","maxLength":1,"description":"ICMS - Isento."}},"description":"Informações referentes a ECF."},"ICMS":{"type":"object","properties":{"cCSTICMS":{"type":"string","maxLength":2,"description":"Código da Situação Tributária do ICMS."},"cOrigemICMS":{"type":"string","maxLength":1,"description":"Origem do ICMS."},"cModBCICMS":{"type":"string","maxLength":1,"description":"Modalidade da BC do ICMS."},"nRedBCICMS":{"type":"number","maxLength":10,"description":"Redução da BC do ICMS."},"nAliqICMS":{"type":"number","maxLength":10,"description":"Alíquota do ICMS."},"nPercDifICMS":{"type":"number","maxLength":10,"description":"Percentual do Diferimento do ICMS."}},"description":"Dados do ICMS."},"ICMSSN":{"type":"object","properties":{"cCSOSNICMS":{"type":"string","maxLength":3,"description":"Situação Tributária do ICMS Simples Nacional (CSOSN)."},"cOrigemICMS":{"type":"string","maxLength":1,"description":"Origem do ICMS."},"cModBCICMS":{"type":"string","maxLength":1,"description":"Modalidade da BC do ICMS."},"nAlCredICMS":{"type":"number","maxLength":10,"description":"Alíq. de Cálculo de Crédito do ICMS."},"nRedBCICMS":{"type":"number","maxLength":10,"description":"Redução da BC do ICMS."},"nAliqICMS":{"type":"number","maxLength":10,"description":"Alíquota do ICMS."}},"description":"Dados do ICMS - Simples Nacional."},"ICMSST":{"type":"object","properties":{"cModBCICMSST":{"type":"string","maxLength":1,"description":"Modalidade da BC do ICMS - ST."},"nMargValAdICMSST":{"type":"number","maxLength":10,"description":"Margem de Valor Adicionado do ICMS - ST."},"nRedBCICMSST":{"type":"number","maxLength":10,"description":"Redução da BC do ICMS - ST."},"nAliqICMSST":{"type":"number","maxLength":10,"description":"Alíquota do ICMS -  ST."},"nAliqOPICMSST":{"type":"number","maxLength":10,"description":"Alíquota do ICMS Operação Própria."},"cCEST":{"type":"string","maxLength":9,"description":"CEST (Código Especificador da Substituição Tributária)"}},"description":"Dados do ICMS - Substituição Tributária."},"ICMSIE":{"type":"object","properties":{"nPercFCP":{"type":"number","maxLength":10,"description":"Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de Destino."},"nAlIntUFDest":{"type":"number","maxLength":10,"description":"Alíquota Interna da UF de Destino."},"nAlInterestUFs":{"type":"number","maxLength":10,"description":"Alíquota Interestadual das UFs Envolvidas."},"nPercICMSIE":{"type":"number","maxLength":10,"description":"Partilha ICMS Interestadual."}},"description":"Dados do ICMS Interestadual."},"PIS":{"type":"object","properties":{"cCSTPIS":{"type":"string","maxLength":2,"description":"Código da Situação Tributária do PIS."},"cTpCalcPIS":{"type":"string","maxLength":1,"description":"Tipo de Cálculo para obter o PIS."},"nAliqPIS":{"type":"number","maxLength":10,"description":"Alíquota do PIS."},"nValUnTribPIS":{"type":"number","maxLength":18,"description":"Valor do PIS por Unidade Tributável."}},"description":"Dados do PIS"},"COFINS":{"type":"object","properties":{"cCSTCOFINS":{"type":"string","maxLength":2,"description":"Código da Situação Tributária do COFINS."},"cTpCalcCOFINS":{"type":"string","maxLength":1,"description":"Tipo de Cálculo para obter o COFINS."},"nAliqCOFINS":{"type":"number","maxLength":10,"description":"Alíquota do COFINS."},"nValUnTribCOFINS":{"type":"number","maxLength":18,"description":"Valor do COFINS por Unidade Tributável."}},"description":"Dados do COFINS."},"IPI":{"type":"object","properties":{"cCSTIPI":{"type":"string","maxLength":2,"description":"Código da Situação Tributária do IPI."},"cTpCalcIPI":{"type":"string","maxLength":1,"description":"Tipo de Cálculo para obter o IPI."},"nAliqIPI":{"type":"number","maxLength":10,"description":"Alíquota do IPI."},"nValUnTribIPI":{"type":"number","maxLength":18,"description":"Valor do IPI por Unidade Tributável."},"cEnqIPI":{"type":"string","maxLength":3,"description":"Enquadramento Fiscal do IPI,"}},"description":"Dados do IPI."},"InfAdic":{"type":"object","properties":{"cInfAdicNF":{"type":"string","description":"Informações para a Nota Fiscal.\n(elas aparecerão nas informações complementares do DANFE e da NF-e)."}},"description":"Informações adicionais para Nota Fiscal."}}}}},"example":{"call":"IncluirImposto","param":[{"ident":{"nCodProd":3456789012,"cCodIntImp":"SP-SP-5102"},"cabec":{"cCupomFiscal":"N","cUfOrigem":"SP","cUfDestino":"SP","cCFOP":"5.102","cContribICMS":"S"},"ICMS":{"cCSTICMS":"00","cOrigemICMS":"0","cModBCICMS":"3","nRedBCICMS":0,"nAliqICMS":18},"PIS":{"cCSTPIS":"01","cTpCalcPIS":"P","nAliqPIS":1.65},"COFINS":{"cCSTCOFINS":"01","cTpCalcCOFINS":"P","nAliqCOFINS":7.6},"InfAdic":{"cInfAdicNF":""}}]}},"geral_prodimp_IncluirImposto_retorno":{"type":"object","properties":{"nCodProd":{"type":"integer","description":"Código do produto no Omie."},"cCodIntProd":{"type":"string","description":"Código de integração do produto."},"cCodIntImp":{"type":"string","description":"Código de integração da regra de imposto."},"cCodStatus":{"type":"string","description":"Código do status: \"0\" para sucesso."},"cDescStatus":{"type":"string","description":"Descrição do status."}},"title":"IncluirImposto (retorno)"},"geral_prodimp_ListarImpostos":{"type":"object","title":"ListarImpostos","description":"Lista os impostos dos produtos.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarImpostos"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nPadrão 20 e máximo 50."},"filtrar_por_data_de":{"type":"string","maxLength":10,"description":"Início do período (dd/mm/aaaa), aplicado às datas de inclusão e alteração do cadastro do produto."},"filtrar_por_data_ate":{"type":"string","maxLength":10,"description":"Fim do período (dd/mm/aaaa). Sem ele, o período vai até hoje. Só vale com filtrar_por_data_de."},"filtrar_apenas_inclusao":{"type":"string","maxLength":1,"description":"S para aplicar o período só à data de inclusão do produto."},"filtrar_apenas_alteracao":{"type":"string","maxLength":1,"description":"S para aplicar o período só à data de alteração do produto."},"filtrar_apenas_cupomfiscal":{"type":"string","maxLength":1,"description":"S para trazer só regras de venda com cupom fiscal. Com o cenário de impostos ativo, é obrigatório S."},"nCodProd":{"type":"integer","maxLength":15,"description":"Código do Produto\n(Código interno do produto no Omie)"},"cCodIntProd":{"type":"string","maxLength":60,"description":"Código de Integração do produto.\n(Utilizado apenas para integração via API)."}},"required":["filtrar_apenas_cupomfiscal"]}}},"example":{"call":"ListarImpostos","param":[{"pagina":1,"registros_por_pagina":20,"filtrar_apenas_cupomfiscal":"S"}]}},"geral_prodimp_ListarImpostos_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada"},"total_de_paginas":{"type":"integer","description":"Número total de páginas"},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"total de registros encontrados"},"listaImpostos":{"type":"array","items":{"type":"object","properties":{"ident":{"type":"object","properties":{"nCodProd":{"type":"integer","description":"Código do produto no Omie. Informe nCodProd ou cCodIntProd."},"cCodIntProd":{"type":"string","description":"Código de integração do produto, com até 20 caracteres. Informe nCodProd ou cCodIntProd."},"cCodIntImp":{"type":"string","description":"Código de integração da regra de imposto, escolhido por quem inclui, com até 20 caracteres. Obrigatório; identifica a regra junto com o produto."}},"description":"Identificação do imposto do produto."},"cabec":{"type":"object","properties":{"cCupomFiscal":{"type":"string","description":"Regra para venda com cupom fiscal no PDV? S ou N. Obrigatório na inclusão e na alteração."},"cUfOrigem":{"type":"string","description":"Sigla do estado de origem da venda. Obrigatório na inclusão e na alteração."},"cUfDestino":{"type":"string","description":"Sigla do estado de destino. Obrigatório quando cCupomFiscal é N."},"cCFOP":{"type":"string","description":"CFOP da operação, com ou sem ponto; gravado no formato 9.999. Obrigatório na inclusão e na alteração."},"cCNAECliente":{"type":"string","description":"CNAE do cliente a que a regra se aplica (7 dígitos). Informe um único código; vazio vale para qualquer cliente."},"cContribICMS":{"type":"string","description":"S para aplicar a regra apenas quando o cliente for contribuinte do ICMS; N caso contrário."},"cIndicadorEscala":{"type":"string","description":"Indicador de Produção em Escala Relevante. Pode ser: \"S\" para Produzido em Escala Relevante. \"N\" para Produzido em Escala NÃO Relevante. Vem do cadastro do produto; só aparece na listagem."},"cCNPJFabricante":{"type":"string","description":"CNPJ do fabricante da mercadoria. Vem do cadastro do produto; só aparece na listagem."}},"description":"Cabeçalho dos dados do imposto."},"ECF":{"type":"object","properties":{"cECFNaoTrib":{"type":"string","description":"ICMS - Não tributado."},"cECFSubstTrib":{"type":"string","description":"ICMS - Substituição Tributária."},"cECFIsento":{"type":"string","description":"ICMS - Isento."}},"description":"Informações referentes a ECF."},"ICMS":{"type":"object","properties":{"cCSTICMS":{"type":"string","description":"Código da Situação Tributária do ICMS."},"cOrigemICMS":{"type":"string","description":"Origem do ICMS."},"cModBCICMS":{"type":"string","description":"Modalidade da BC do ICMS."},"nRedBCICMS":{"type":"decimal","description":"Redução da BC do ICMS."},"nAliqICMS":{"type":"decimal","description":"Alíquota do ICMS."},"nPercDifICMS":{"type":"decimal","description":"Percentual do Diferimento do ICMS."}},"description":"Dados do ICMS."},"ICMSSN":{"type":"object","properties":{"cCSOSNICMS":{"type":"string","description":"Situação Tributária do ICMS Simples Nacional (CSOSN)."},"cOrigemICMS":{"type":"string","description":"Origem do ICMS."},"cModBCICMS":{"type":"string","description":"Modalidade da BC do ICMS."},"nAlCredICMS":{"type":"decimal","description":"Alíq. de Cálculo de Crédito do ICMS."},"nRedBCICMS":{"type":"decimal","description":"Redução da BC do ICMS."},"nAliqICMS":{"type":"decimal","description":"Alíquota do ICMS."}},"description":"Dados do ICMS - Simples Nacional."},"ICMSST":{"type":"object","properties":{"cModBCICMSST":{"type":"string","description":"Modalidade da BC do ICMS - ST."},"nMargValAdICMSST":{"type":"decimal","description":"Margem de Valor Adicionado do ICMS - ST."},"nRedBCICMSST":{"type":"decimal","description":"Redução da BC do ICMS - ST."},"nAliqICMSST":{"type":"decimal","description":"Alíquota do ICMS - ST."},"nAliqOPICMSST":{"type":"decimal","description":"Alíquota do ICMS Operação Própria."},"cCEST":{"type":"string","description":"CEST (Código Especificador da Substituição Tributária)"}},"description":"Dados do ICMS - Substituição Tributária."},"ICMSIE":{"type":"object","properties":{"nPercFCP":{"type":"decimal","description":"Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de Destino."},"nAlIntUFDest":{"type":"decimal","description":"Alíquota Interna da UF de Destino."},"nAlInterestUFs":{"type":"decimal","description":"Alíquota Interestadual das UFs Envolvidas."},"nPercICMSIE":{"type":"decimal","description":"Partilha ICMS Interestadual."}},"description":"Dados do ICMS Interestadual."},"PIS":{"type":"object","properties":{"cCSTPIS":{"type":"string","description":"Código da Situação Tributária do PIS."},"cTpCalcPIS":{"type":"string","description":"Tipo de Cálculo para obter o PIS."},"nAliqPIS":{"type":"decimal","description":"Alíquota do PIS."},"nValUnTribPIS":{"type":"decimal","description":"Valor do PIS por Unidade Tributável."}},"description":"Dados do PIS"},"COFINS":{"type":"object","properties":{"cCSTCOFINS":{"type":"string","description":"Código da Situação Tributária do COFINS."},"cTpCalcCOFINS":{"type":"string","description":"Tipo de Cálculo para obter o COFINS."},"nAliqCOFINS":{"type":"decimal","description":"Alíquota do COFINS."},"nValUnTribCOFINS":{"type":"decimal","description":"Valor do COFINS por Unidade Tributável."}},"description":"Dados do COFINS."},"IPI":{"type":"object","properties":{"cCSTIPI":{"type":"string","description":"Código da Situação Tributária do IPI."},"cTpCalcIPI":{"type":"string","description":"Tipo de Cálculo para obter o IPI."},"nAliqIPI":{"type":"decimal","description":"Alíquota do IPI."},"nValUnTribIPI":{"type":"decimal","description":"Valor do IPI por Unidade Tributável."},"cEnqIPI":{"type":"string","description":"Enquadramento Fiscal do IPI,"}},"description":"Dados do IPI."},"InfAdic":{"type":"object","properties":{"cInfAdicNF":{"type":"string","description":"Informações para a Nota Fiscal. (elas aparecerão nas informações complementares do DANFE e da NF-e)."}},"description":"Informações adicionais para Nota Fiscal."}}},"description":"Lista de impostos de um produto."}},"title":"ListarImpostos (retorno)"},"geral_prodimp_UpsertImposto":{"type":"object","title":"UpsertImposto","description":"Inclui/Altera um imposto aprendido.","required":["call","param"],"properties":{"call":{"type":"string","enum":["UpsertImposto"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"ident":{"type":"object","properties":{"nCodProd":{"type":"integer","maxLength":15,"description":"Código do produto no Omie. Informe nCodProd ou cCodIntProd."},"cCodIntProd":{"type":"string","maxLength":60,"description":"Código de integração do produto, com até 20 caracteres. Informe nCodProd ou cCodIntProd."},"cCodIntImp":{"type":"string","maxLength":20,"description":"Código de integração da regra de imposto, escolhido por quem inclui, com até 20 caracteres. Obrigatório; identifica a regra junto com o produto."}},"description":"Identificação do imposto do produto."},"cabec":{"type":"object","properties":{"cCupomFiscal":{"type":"string","maxLength":1,"description":"Regra para venda com cupom fiscal no PDV? S ou N. Obrigatório na inclusão e na alteração."},"cUfOrigem":{"type":"string","maxLength":2,"description":"Sigla do estado de origem da venda. Obrigatório na inclusão e na alteração."},"cUfDestino":{"type":"string","maxLength":2,"description":"Sigla do estado de destino. Obrigatório quando cCupomFiscal é N."},"cCFOP":{"type":"string","maxLength":10,"description":"CFOP da operação, com ou sem ponto; gravado no formato 9.999. Obrigatório na inclusão e na alteração."},"cCNAECliente":{"type":"string","maxLength":7,"description":"CNAE do cliente a que a regra se aplica (7 dígitos). Informe um único código; vazio vale para qualquer cliente."},"cContribICMS":{"type":"string","maxLength":1,"description":"S para aplicar a regra apenas quando o cliente for contribuinte do ICMS; N caso contrário."},"cIndicadorEscala":{"type":"string","maxLength":1,"description":"Indicador de Produção em Escala Relevante.\n\nPode ser:\n\"S\" para Produzido em Escala Relevante.\n\"N\" para Produzido em Escala NÃO Relevante.\n\nVem do cadastro do produto; só aparece na listagem."},"cCNPJFabricante":{"type":"string","maxLength":20,"description":"CNPJ do fabricante da mercadoria. Vem do cadastro do produto; só aparece na listagem."}},"description":"Cabeçalho dos dados do imposto."},"ECF":{"type":"object","properties":{"cECFNaoTrib":{"type":"string","maxLength":1,"description":"ICMS - Não tributado."},"cECFSubstTrib":{"type":"string","maxLength":1,"description":"ICMS - Substituição Tributária."},"cECFIsento":{"type":"string","maxLength":1,"description":"ICMS - Isento."}},"description":"Informações referentes a ECF."},"ICMS":{"type":"object","properties":{"cCSTICMS":{"type":"string","maxLength":2,"description":"Código da Situação Tributária do ICMS."},"cOrigemICMS":{"type":"string","maxLength":1,"description":"Origem do ICMS."},"cModBCICMS":{"type":"string","maxLength":1,"description":"Modalidade da BC do ICMS."},"nRedBCICMS":{"type":"number","maxLength":10,"description":"Redução da BC do ICMS."},"nAliqICMS":{"type":"number","maxLength":10,"description":"Alíquota do ICMS."},"nPercDifICMS":{"type":"number","maxLength":10,"description":"Percentual do Diferimento do ICMS."}},"description":"Dados do ICMS."},"ICMSSN":{"type":"object","properties":{"cCSOSNICMS":{"type":"string","maxLength":3,"description":"Situação Tributária do ICMS Simples Nacional (CSOSN)."},"cOrigemICMS":{"type":"string","maxLength":1,"description":"Origem do ICMS."},"cModBCICMS":{"type":"string","maxLength":1,"description":"Modalidade da BC do ICMS."},"nAlCredICMS":{"type":"number","maxLength":10,"description":"Alíq. de Cálculo de Crédito do ICMS."},"nRedBCICMS":{"type":"number","maxLength":10,"description":"Redução da BC do ICMS."},"nAliqICMS":{"type":"number","maxLength":10,"description":"Alíquota do ICMS."}},"description":"Dados do ICMS - Simples Nacional."},"ICMSST":{"type":"object","properties":{"cModBCICMSST":{"type":"string","maxLength":1,"description":"Modalidade da BC do ICMS - ST."},"nMargValAdICMSST":{"type":"number","maxLength":10,"description":"Margem de Valor Adicionado do ICMS - ST."},"nRedBCICMSST":{"type":"number","maxLength":10,"description":"Redução da BC do ICMS - ST."},"nAliqICMSST":{"type":"number","maxLength":10,"description":"Alíquota do ICMS -  ST."},"nAliqOPICMSST":{"type":"number","maxLength":10,"description":"Alíquota do ICMS Operação Própria."},"cCEST":{"type":"string","maxLength":9,"description":"CEST (Código Especificador da Substituição Tributária)"}},"description":"Dados do ICMS - Substituição Tributária."},"ICMSIE":{"type":"object","properties":{"nPercFCP":{"type":"number","maxLength":10,"description":"Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de Destino."},"nAlIntUFDest":{"type":"number","maxLength":10,"description":"Alíquota Interna da UF de Destino."},"nAlInterestUFs":{"type":"number","maxLength":10,"description":"Alíquota Interestadual das UFs Envolvidas."},"nPercICMSIE":{"type":"number","maxLength":10,"description":"Partilha ICMS Interestadual."}},"description":"Dados do ICMS Interestadual."},"PIS":{"type":"object","properties":{"cCSTPIS":{"type":"string","maxLength":2,"description":"Código da Situação Tributária do PIS."},"cTpCalcPIS":{"type":"string","maxLength":1,"description":"Tipo de Cálculo para obter o PIS."},"nAliqPIS":{"type":"number","maxLength":10,"description":"Alíquota do PIS."},"nValUnTribPIS":{"type":"number","maxLength":18,"description":"Valor do PIS por Unidade Tributável."}},"description":"Dados do PIS"},"COFINS":{"type":"object","properties":{"cCSTCOFINS":{"type":"string","maxLength":2,"description":"Código da Situação Tributária do COFINS."},"cTpCalcCOFINS":{"type":"string","maxLength":1,"description":"Tipo de Cálculo para obter o COFINS."},"nAliqCOFINS":{"type":"number","maxLength":10,"description":"Alíquota do COFINS."},"nValUnTribCOFINS":{"type":"number","maxLength":18,"description":"Valor do COFINS por Unidade Tributável."}},"description":"Dados do COFINS."},"IPI":{"type":"object","properties":{"cCSTIPI":{"type":"string","maxLength":2,"description":"Código da Situação Tributária do IPI."},"cTpCalcIPI":{"type":"string","maxLength":1,"description":"Tipo de Cálculo para obter o IPI."},"nAliqIPI":{"type":"number","maxLength":10,"description":"Alíquota do IPI."},"nValUnTribIPI":{"type":"number","maxLength":18,"description":"Valor do IPI por Unidade Tributável."},"cEnqIPI":{"type":"string","maxLength":3,"description":"Enquadramento Fiscal do IPI,"}},"description":"Dados do IPI."},"InfAdic":{"type":"object","properties":{"cInfAdicNF":{"type":"string","description":"Informações para a Nota Fiscal.\n(elas aparecerão nas informações complementares do DANFE e da NF-e)."}},"description":"Informações adicionais para Nota Fiscal."}}}}},"example":{"call":"UpsertImposto","param":[{"ident":{"nCodProd":3456789012,"cCodIntImp":"SP-SP-5102"},"cabec":{"cCupomFiscal":"N","cUfOrigem":"SP","cUfDestino":"SP","cCFOP":"5.102","cContribICMS":"S"},"ICMS":{"cCSTICMS":"00","cOrigemICMS":"0","cModBCICMS":"3","nRedBCICMS":0,"nAliqICMS":18},"PIS":{"cCSTPIS":"01","cTpCalcPIS":"P","nAliqPIS":1.65},"COFINS":{"cCSTCOFINS":"01","cTpCalcCOFINS":"P","nAliqCOFINS":7.6},"InfAdic":{"cInfAdicNF":""}}]}},"geral_prodimp_UpsertImposto_retorno":{"type":"object","properties":{"nCodProd":{"type":"integer","description":"Código do produto no Omie."},"cCodIntProd":{"type":"string","description":"Código de integração do produto."},"cCodIntImp":{"type":"string","description":"Código de integração da regra de imposto."},"cCodStatus":{"type":"string","description":"Código do status: \"0\" para sucesso."},"cDescStatus":{"type":"string","description":"Descrição do status."}},"title":"UpsertImposto (retorno)"},"geral_produtos_AlterarProduto":{"type":"object","title":"AlterarProduto","description":"Altera um produto já cadastrado.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarProduto"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_produto":{"type":"integer","maxLength":15,"description":"Código do produto.\nÉ o ID do produto e será utilizado apenas nas APIs como chave principal para localizar um produto.\n\nQuando um produto for incluído via API, você receberá um ID para esse novo produto.\nRecomendamos que você guarde essa informação no aplicativo que estiver integrando.\n\nEsse campo não deve ser informado na inclusão de produtos.\n\nEssa informação não será exibida nas telas do Omie."},"codigo_produto_integracao":{"type":"string","maxLength":60,"description":"Código de integração do produto.\nÉ o código do produto no aplicativo que você está integrando ao Omie.\nÉ utilizado basicamente na Inclusão de Produtos via API, para evitar duplicidade de cadastros.\n\nQuando um produto for incluído via API, você receberá um ID para esse novo produto.\nRecomendamos que você guarde essa informação no aplicativo que estiver integrando.\n\nO preenchimento desse campo é obrigatório na inclusão de produtos.\n\nEssa informação não será exibida nas telas do Omie."},"codigo":{"type":"string","maxLength":60,"description":"Código do Produto.\n\nÉ um código único que identifica o produto no Omie. Se você tem um código SKU (Stock Keeping Unit = Unidade de Manutenção de Estoque) é aqui que ele deve ser informado, pois é essa informação que será exibida na tela do Omie.\n\nNão recomendamos que ele seja utilizado como chave para integração, pois pode ser modificado pelo usuário a qualquer momento. No lugar deste campo, utilize o ID do produto, que você encontra na tag \"codigo_produto\"."},"descricao":{"type":"string","maxLength":120,"description":"Descrição do produto."},"unidade":{"type":"string","maxLength":6,"description":"Código da Unidade."},"ncm":{"type":"string","maxLength":13,"description":"Código da Nomenclatura Comum do Mercosul (NCM)."},"ean":{"type":"string","maxLength":14,"description":"Código EAN (GTIN - Global Trade Item Number)."},"valor_unitario":{"type":"number","maxLength":18,"description":"Preço Unitário de Venda."},"codigo_familia":{"type":"integer","maxLength":15,"description":"Código da Familia do Produto."},"tipoItem":{"type":"string","maxLength":2,"description":"Código do Tipo do Item para o SPED.\n\n\nPode ser:\n\n00 - Mercadoria para Revenda\n01 - Matéria Prima\n02 - Embalagem\n03 - Produto em Processo\n04 - Produto Acabado\n05 - Subproduto\n06 - Produto Intermediário\n07 - Material de Uso e Consumo\n08 - Ativo Imobilizado\n09 - Serviços\n10 - Outros Insumos\n99 - Outras"},"produto_variacao":{"type":"string","maxLength":1,"description":"Indica se o Produto Possui Variações.\n\nCampo disponível apenas para consulta.\n\n(S/N) ."},"produto_lote":{"type":"string","maxLength":1,"description":"Indica se o produto possui lote.\n(S/N) ."},"variacao":{"type":"string","maxLength":1,"description":"Indica se o Produto é uma variação de produto.\n(S/N) .\n\nNo método ListarProdutos, esse campo só será exibido se a tag 'exibir_info_variacoes' for enviada como 'S'."},"id_produto_variacao":{"type":"integer","maxLength":15,"description":"Código interno do produto variação que deu origem a variação.\n\nCampo disponível apenas para consulta.\n\nNo método ListarProdutos, esse campo só será exibido se a tag 'exibir_info_variacoes' for enviada como 'S'."},"recomendacoes_fiscais":{"type":"object","properties":{"origem_mercadoria":{"type":"string","maxLength":1,"description":"Origem da Mercadoria.\n\n\nPode ser:\n0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8\n1 - Estrangeira - Importação direta, exceto a indicada no código 6\n2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7\n3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40% e inferior ou igual a 70\n4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes\n5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40\n6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural\n7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante em lista da CAMEX e gás natural\n8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70"},"id_preco_tabelado":{"type":"integer","maxLength":15,"description":"ID do Preço tabelado (Pauta)."},"id_cest":{"type":"string","maxLength":9,"description":"Código do CEST.\n(Código Especificador da Substituíção Tributária).\n\n\nFormato: 99.999.99"},"cupom_fiscal":{"type":"string","maxLength":1,"description":"Indica se o produto é comercializado via PDV.\n\nAtravés de emissão de Cupom Fiscal ECF, SAT ou NFC-e.\n\n\nPreencher com \"S\" ou \"N\"."},"market_place":{"type":"string","maxLength":1,"description":"Indica se o produto será comercializado via Market Place ou e-commerce (S/N)\n\n\nPreencher com \"S\" ou \"N\"."},"indicador_escala":{"type":"string","maxLength":1,"description":"Indicador de Produção em Escala Relevante.\n\nPode ser:\n\"S\" para Produzido em Escala Relevante.\n\"N\" para Produzido em Escala NÃO Relevante."},"cnpj_fabricante":{"type":"string","maxLength":20,"description":"CNPJ do Fabricante da Mercadoria."}},"description":"Recomendações Fiscais."},"peso_liq":{"type":"number","maxLength":18,"description":"Peso Líquido (Kg).\n\n\nLocalizado na aba \"Informações Adicionais\""},"peso_bruto":{"type":"number","maxLength":18,"description":"Peso Bruto (Kg).\n\n\nLocalizado na aba \"Informações Adicionais\""},"altura":{"type":"number","maxLength":18,"description":"Altura (centimentos).\n\n\nLocalizado na aba \"Informações Adicionais\""},"largura":{"type":"number","maxLength":18,"description":"Largura (centimetros)\n\n\nLocalizado na aba \"Informações Adicionais\""},"profundidade":{"type":"number","maxLength":18,"description":"Profundidade (centimetros).\n\n\nLocalizado na aba \"Informações Adicionais\""},"marca":{"type":"string","maxLength":60,"description":"Marca.\n\n\nLocalizado na aba \"Informações Adicionais\""},"modelo":{"type":"string","maxLength":60,"description":"Modelo.\n\n\nLocalizado na aba \"Informações Adicionais\""},"dias_garantia":{"type":"integer","maxLength":4,"description":"Dias de Garantia.\n\n\nLocalizado na aba \"Informações Adicionais\""},"dias_crossdocking":{"type":"integer","maxLength":3,"description":"Dias de Crossdocking.\n\n\nLocalizado na aba \"Informações Adicionais\""},"descr_detalhada":{"type":"string","description":"Descrição Detalhada para o Produto."},"obs_internas":{"type":"string","description":"Observações Internas.\n(ficam registradas apenas no cadastro do produto)."},"imagens":{"type":"array","items":{"type":"object","properties":{"url_imagem":{"type":"string","description":"URL da Imagem do produto."}}},"description":"Lista de imagens do produto."},"videos":{"type":"array","items":{"type":"object","properties":{"url_video":{"type":"string","description":"URL do Video do produto."}}},"description":"Lista de videos do produto."},"caracteristicas":{"type":"array","items":{"type":"object","properties":{"nCodCaract":{"type":"integer","maxLength":15,"description":"Código da característica de produto.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno da característica do produto gerado pelo Omie."},"cCodIntCaract":{"type":"string","maxLength":20,"description":"Código de integração da característica do produto.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código da característica utilizado no seu aplicativo quando incluir uma característica no Omie.\nAssim, poderá utilizar esse campo para resgatar as informações da característica desejada.\nCaso informe esse campo, não informe a tag nCodCaract. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"cNomeCaract":{"type":"string","maxLength":30,"description":"Nome da característica."},"cConteudo":{"type":"string","maxLength":60,"description":"Conteúdo da característica."},"cExibirItemNF":{"type":"string","maxLength":1,"description":"Exibir esta característica no item da NF-e emitida (S/N)."},"cExibirItemPedido":{"type":"string","maxLength":1,"description":"Exibir esta característica no item do Pedido, Remessa ou Devolução (S/N)."},"cExibirOrdemProd":{"type":"string","maxLength":1,"description":"Exibe esta característica na Ordem de Produção e Mapa de Custo (S/N)."}}},"description":"lista de caracteristicas do produto."},"tabelas_preco":{"type":"array","items":{"type":"object","properties":{"nCodTabPreco":{"type":"integer","maxLength":15,"description":"Id da tabela de preço."},"cNomeTabPreco":{"type":"string","maxLength":50,"description":"Nome da tabela de preço."},"nValorTabPreco":{"type":"number","maxLength":18,"description":"Valor do produto na tabela de preço."}}},"description":"Lista de tabelas de preço."},"info":{"type":"object","properties":{"dInc":{"type":"string","maxLength":10,"description":"Data da Inclusão.\nNo formato dd/mm/aaaa.\n\nNão deve ser informado na Inclusão/Alteração."},"hInc":{"type":"string","maxLength":8,"description":"Hora da Inclusão.\nNo formato hh:mm:ss.\n\nNão deve ser informado na Inclusão/Alteração."},"uInc":{"type":"string","maxLength":10,"description":"Usuário da Inclusão.\n\nNão deve ser informado na Inclusão/Alteração."},"dAlt":{"type":"string","maxLength":10,"description":"Data da Alteração.\nNo formato dd/mm/aaaa.\n\nNão deve ser informado na Inclusão/Alteração."},"hAlt":{"type":"string","maxLength":8,"description":"Hora da Alteração.\nNo formato hh:mm:ss.\n\nNão deve ser informado na Inclusão/Alteração."},"uAlt":{"type":"string","maxLength":10,"description":"Usuário da Alteração.\n\nNão deve ser informado na Inclusão/Alteração."},"cImpAPI":{"type":"string","maxLength":1,"description":"Importado pela API (S/N).\n\nNão deve ser informado na Inclusão/Alteração."}},"description":"Informações complemetares do cadastro do produto."},"exibir_descricao_nfe":{"type":"string","maxLength":1,"description":"Indica se a Descrição Detalhada deve ser exibida nas Informações Adicionais do Item da NF-e (S/N)."},"exibir_descricao_pedido":{"type":"string","maxLength":1,"description":"Indica se a Descrição Detalhada deve ser exibida na impressão do Pedido (S/N)."},"medicamento":{"type":"object","properties":{"cod_anvisa":{"type":"string","maxLength":13,"description":"Código de produto Anvisa"},"preco_max_cons":{"type":"number","maxLength":15,"description":"Preço máximo consumidor"}},"description":"Detalhamento específico para cadastro de medicamentos\n\nObrigatório o preenchimento no caso de medicamentos e produtos farmacêuticos"},"combustivel":{"type":"object","properties":{"codigo_anp":{"type":"string","maxLength":9,"description":"Código de Produto da ANP."},"descr_anp":{"type":"string","maxLength":95,"description":"Descrição do Produto conforme ANP."},"percent_glp":{"type":"number","description":"Percentual de GLP Derivado do Petróleo."},"percent_gas_nac":{"type":"number","maxLength":9,"description":"Percentual de Gás Natural Nacional."},"percent_gas_imp":{"type":"number","description":"Percentual de Gás Natural Importado."},"valor_part":{"type":"number","description":"Valor de partida"}},"description":"Detalhamento específico para cadastro de combustíveis."},"veiculo":{"type":"object","properties":{"ano_fabr":{"type":"string","maxLength":4},"ano_modelo":{"type":"string","maxLength":4,"description":"Ano modelo de fabricação"},"chassi":{"type":"string","maxLength":17,"description":"Chassi do veículo"},"cilin":{"type":"string","maxLength":4,"description":"Cilindradas"},"cmt":{"type":"string","maxLength":9,"description":"Capacidade máxima de tração"},"cond_veic":{"type":"string","maxLength":1,"description":"Condição do veículo"},"cod_cor_veic":{"type":"string","maxLength":4,"description":"Código da cor do veículo"},"cod_cor_den":{"type":"string","maxLength":2,"description":"Código da cor DENATRAN"},"descr_cor":{"type":"string","maxLength":40,"description":"Descrição da cor"},"dist_eixo":{"type":"string","maxLength":4,"description":"Distância entre eixos"},"especie_veic":{"type":"string","maxLength":1,"description":"Espécie do veículo"},"lota_max":{"type":"string","maxLength":3,"description":"Capacidade máxima de lotação"},"cod_modelo":{"type":"string","maxLength":6,"description":"Código marca modelo"},"motor":{"type":"string","maxLength":21,"description":"Número do motor"},"peso_bruto_veic":{"type":"string","maxLength":9,"description":"Peso bruto"},"peso_liquido_veic":{"type":"string","maxLength":9,"description":"Peso líquido"},"potencia":{"type":"string","maxLength":4,"description":"Potência motor"},"serie_veic":{"type":"string","maxLength":9,"description":"Série do veículo"},"tipo_comb":{"type":"string","maxLength":2,"description":"Tipo de combustível"},"tipo_oper":{"type":"string","maxLength":1,"description":"Tipo da operação"},"tipo_pintura":{"type":"string","maxLength":1,"description":"Tipo de pintura"},"tipo_restricao":{"type":"string","maxLength":1,"description":"Restrição"},"tipo_veic":{"type":"string","maxLength":2,"description":"Tipo de veículo de acordo com a tabela RENAVAM"},"cond_vin":{"type":"string","maxLength":1,"description":"Condição do VIN"}},"description":"Detalhamento específico para cadastro de veículos"},"armamento":{"type":"object","properties":{"serie_cano":{"type":"string","maxLength":15,"description":"Número de série do cano"},"descr_arma":{"type":"string","maxLength":256,"description":"Descrição completa da arma"},"serie_arma":{"type":"string","maxLength":15,"description":"Número de série da arma"},"tipo_arma":{"type":"string","maxLength":1,"description":"Indicador do tipo de arma de fogo"}},"description":"Detalhamento especifco para cadastro de armamentos.\n\nDescrição completa da arma, de modo a permitir sua perfeita identificação."},"cst_icms":{"type":"string","maxLength":2,"description":"Código da Situação Tributária do ICMS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"modalidade_icms":{"type":"string","maxLength":1,"description":"Modalidade da Base de Cálculo do ICMS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"csosn_icms":{"type":"string","maxLength":3,"description":"Código da Situação Tributária para Simples Nacional.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"aliquota_icms":{"type":"number","description":"Alíquota de ICMS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"red_base_icms":{"type":"number","maxLength":10,"description":"Percentual de redução de base do ICMS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"motivo_deson_icms":{"type":"string","maxLength":2,"description":"Motivo da desoneração do ICMS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"per_icms_fcp":{"type":"number","maxLength":10,"description":"Percentual do Fundo de Combate a Pobreza do ICMS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"codigo_beneficio":{"type":"string","maxLength":20,"description":"Código do Beneficio Fiscal.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"cst_pis":{"type":"string","maxLength":2,"description":"Código da Situação Tributária do PIS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"aliquota_pis":{"type":"number","maxLength":10,"description":"Alíquota do PIS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"red_base_pis":{"type":"number","maxLength":10,"description":"Percentual de redução de base do PIS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"cst_cofins":{"type":"string","maxLength":2,"description":"Código da Situação Tributária do COFINS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"aliquota_cofins":{"type":"number","maxLength":10,"description":"Alíquota do COFINS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"red_base_cofins":{"type":"number","description":"Percentual de redução de base do COFINS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"cfop":{"type":"string","maxLength":10,"description":"CFOP do Produto.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"dadosIbpt":{"type":"object","properties":{"aliqFederal":{"type":"number","maxLength":10,"description":"Carga tributária federal para os produtos nacionais.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV."},"aliqEstadual":{"type":"number","maxLength":10,"description":"Carga tributária estadual.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV."},"aliqMunicipal":{"type":"number","maxLength":10,"description":"Carga tributária municipal.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV."},"fonte":{"type":"string","maxLength":34,"description":"Fonte do IBPT.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV."},"chave":{"type":"string","maxLength":6,"description":"Número da versão do arquivo do IBPT.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV."},"versao":{"type":"string","maxLength":6,"description":"Versão da Tabela IBPT.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV."},"valido_de":{"type":"string","maxLength":10,"description":"Tabela do IBPT válilda a partir da data.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV."},"valido_ate":{"type":"string","maxLength":10,"description":"Tabela do IBPT valida até a data.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV."}},"description":"Dados do IBPT.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV."},"codInt_familia":{"type":"string","maxLength":20,"description":"Código de Integração da Familia do Produto.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV."},"descricao_familia":{"type":"string","maxLength":50,"description":"Descrição da Familia do Produto.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV."},"bloqueado":{"type":"string","maxLength":1,"description":"Indica se o registro está bloqueado (S/N)."},"bloquear_exclusao":{"type":"string","maxLength":1,"description":"Indica se a exclusão do registro está bloqueada (S/N)."},"importado_api":{"type":"string","maxLength":1,"description":"Indica se o registro foi incluído via API (S/N).\n\nNão deve ser informado na Inclusão/Alteração."},"inativo":{"type":"string","maxLength":1,"description":"Indica se o cadastro do produto está inativo (S/N).\n\nNão deve ser informado na Inclusão/Alteração."},"componentes_kit":{"type":"array","items":{"type":"object","properties":{"codigo_componente":{"type":"integer","maxLength":15,"description":"Identificação do componente do KIT, deve ser utilizado para Alterar e Excluir o componente.\n\nNão deve ser informado na inclusão.\n\nEsse código não aparece na tela do Omie."},"codigo_produto_componente":{"type":"integer","maxLength":15,"description":"Código do produto componente.\n(Código interno utilizado apenas na API).\nEsse código não aparece na tela do Omie."},"quantidade_componente":{"type":"number","maxLength":10,"description":"Quantidade do componente."},"valor_unitario_componente":{"type":"number","maxLength":18,"description":"Valor unitário do componente."},"local_estoque_componente":{"type":"integer","maxLength":15,"description":"Local estoque do componente."}}},"description":"Componetes do KIT."},"lead_time":{"type":"integer","maxLength":4,"description":"Lead Time médio de ressuprimento em dias."},"aliquota_ibpt":{"type":"number","description":"DEPRECATED."},"cest":{"type":"string","maxLength":9,"description":"DEPRECATED."},"quantidade_estoque":{"type":"number","maxLength":18,"description":"DEPRECATED."},"estoque_minimo":{"type":"number","maxLength":18,"description":"DEPRECATED."},"origem_imposto":{"type":"string","maxLength":10,"description":"Origem do Imposto\n\n\"NCM\" ou \"PRD\"\n\nEsse campo não deve ser informado na inclusão ou alteração.\n\nFinalidade: Indicar se a regra de imposto utilizada pelos PDV\"s foi originada de uma configuração pelo NCM ou por uma configuração específica para o produto."},"cst_ibs_cbs":{"type":"string","maxLength":3,"description":"Código de Situação Tributária do IBS e CBS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"class_trib":{"type":"string","maxLength":6,"description":"Código de Classificação Tributária do IBS e CBS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"aliquota_ibs_uf":{"type":"number","maxLength":7,"description":"Alíquota do IBS de competência das UF.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"aliquota_ibs_mun":{"type":"number","maxLength":7,"description":"Alíquota do IBS de competência do Município.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"perc_reducao_ibs_uf":{"type":"number","maxLength":7,"description":"Percentual da redução de alíquota do IBS UF.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"perc_reducao_ibs_mun":{"type":"number","maxLength":7,"description":"Percentual da redução de alíquota IBS UF.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"aliquota_cbs":{"type":"number","maxLength":7,"description":"Alíquota da CBS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"perc_reducao_cbs":{"type":"number","maxLength":7,"description":"Percentual da redução de alíquota da CBS\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."}},"required":["codigo_produto_integracao","medicamento"]}}},"example":{"call":"AlterarProduto","param":[{"codigo_produto_integracao":"1790774103","codigo":"teste0001","descricao":"Produto de teste","unidade":"UN"}]}},"geral_produtos_AlterarProduto_retorno":{"type":"object","properties":{"codigo_produto":{"type":"integer","description":"Código do produto. (Código interno utilizado apenas na API). Esse código não aparece na tela do Omie. Utilize esse código para identificar um produto via API, para obter uma melhor performance. Opcionalmente você pode informar o código de integração para localizar um produto através do campo \"codigo_produto_integracao\"."},"codigo_produto_integracao":{"type":"string","description":"Código de integração do produto. (Utilizado para integração via API) Esse código não aparece na tela do Omie. Utilize esse campo quando incluir um produto e desejar associar o código do produto do seu aplicativo com o código de produto gerado pelo Omie. O preenchimento desse campo é obrigatório na inclusão e opcional para os demais métodos."},"codigo_status":{"type":"string"},"descricao_status":{"type":"string"}},"title":"AlterarProduto (retorno)"},"geral_produtos_AlterarSituacaoProduto":{"type":"object","title":"AlterarSituacaoProduto","description":"Ativa ou inativa o cadastro de um produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarSituacaoProduto"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_produto":{"type":"integer","maxLength":15,"description":"(Código interno utilizado apenas na API).\nEsse código não aparece na tela do Omie.\nUtilize esse código para identificar um produto via API, para obter uma melhor performance.\nOpcionalmente você pode informar o código de integração para localizar um produto através do campo \"codigo_produto_integracao\"."},"codigo_produto_integracao":{"type":"string","maxLength":60,"description":"Código de integração do produto.\n(Utilizado para integração via API)\nEsse código não aparece na tela do Omie."},"codigo":{"type":"string","maxLength":60,"description":"Código do Produto.\nÉ o código do produto que é exibido na tela do Omie.\nNão utilize esse código para realizar a integração, ele tem função apenas informativa para o usuário e pode ser alterado a qualquer momento.\nPara integração utilize o código interno do produto através da tag \"codigo_produto\"."},"inativo":{"type":"string","maxLength":1,"description":"Situação desejada para o cadastro.\n\"S\" inativa o produto e \"N\" o ativa."}},"required":["inativo"]}}},"example":{"call":"AlterarSituacaoProduto","param":[{"codigo_produto":0,"codigo_produto_integracao":"","codigo":"","inativo":"N"}]}},"geral_produtos_AlterarSituacaoProduto_retorno":{"type":"object","properties":{"codigo_produto":{"type":"integer"},"codigo_produto_integracao":{"type":"string"},"codigo_status":{"type":"string"},"descricao_status":{"type":"string"}},"title":"AlterarSituacaoProduto (retorno)"},"geral_produtos_AssociarCodIntProduto":{"type":"object","title":"AssociarCodIntProduto","description":"Associa um código de integração do produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AssociarCodIntProduto"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_produto":{"type":"integer","maxLength":15,"description":"(Código interno utilizado apenas na API).\nEsse código não aparece na tela do Omie.\nUtilize esse código para identificar um produto via API, para obter uma melhor performance.\nOpcionalmente você pode informar o código de integração para localizar um produto através do campo \"codigo_produto_integracao\"."},"codigo_produto_integracao":{"type":"string","maxLength":60,"description":"Código de integração do produto.\n(Utilizado para integração via API)\nEsse código não aparece na tela do Omie.\nUtilize esse campo quando incluir um produto e desejar associar o código do produto do seu aplicativo com o código de produto gerado pelo Omie.\nO preenchimento desse campo é obrigatório na inclusão e opcional para os demais métodos."},"codigo":{"type":"string","maxLength":60,"description":"Código do Produto.\nÉ o código do produto que é exibido na tela do Omie.\nNão utilize esse código para realizar a integração, ele tem função apenas informativa para o usuário e pode ser alterado a qualquer momento.\nPara integração utilize o código interno do produto através da tag \"codigo_produto\"."}},"required":["codigo_produto","codigo_produto_integracao"]}}},"example":{"call":"AssociarCodIntProduto","param":[{"codigo_produto":0,"codigo_produto_integracao":""}]}},"geral_produtos_AssociarCodIntProduto_retorno":{"type":"object","properties":{"codigo_produto":{"type":"integer","description":"Código do produto. (Código interno utilizado apenas na API). Esse código não aparece na tela do Omie. Utilize esse código para identificar um produto via API, para obter uma melhor performance. Opcionalmente você pode informar o código de integração para localizar um produto através do campo \"codigo_produto_integracao\"."},"codigo_produto_integracao":{"type":"string","description":"Código de integração do produto. (Utilizado para integração via API) Esse código não aparece na tela do Omie. Utilize esse campo quando incluir um produto e desejar associar o código do produto do seu aplicativo com o código de produto gerado pelo Omie. O preenchimento desse campo é obrigatório na inclusão e opcional para os demais métodos."},"codigo_status":{"type":"string"},"descricao_status":{"type":"string"}},"title":"AssociarCodIntProduto (retorno)"},"geral_produtos_ConsultarProduto":{"type":"object","title":"ConsultarProduto","description":"Consulta um produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarProduto"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_produto":{"type":"integer","maxLength":15,"description":"(Código interno utilizado apenas na API).\nEsse código não aparece na tela do Omie.\nUtilize esse código para identificar um produto via API, para obter uma melhor performance.\nOpcionalmente você pode informar o código de integração para localizar um produto através do campo \"codigo_produto_integracao\"."},"codigo_produto_integracao":{"type":"string","maxLength":60,"description":"Código de integração do produto.\n(Utilizado para integração via API)\nEsse código não aparece na tela do Omie.\nUtilize esse campo quando incluir um produto e desejar associar o código do produto do seu aplicativo com o código de produto gerado pelo Omie.\nO preenchimento desse campo é obrigatório na inclusão e opcional para os demais métodos."},"codigo":{"type":"string","maxLength":60,"description":"Código do Produto.\nÉ o código do produto que é exibido na tela do Omie.\nNão utilize esse código para realizar a integração, ele tem função apenas informativa para o usuário e pode ser alterado a qualquer momento.\nPara integração utilize o código interno do produto através da tag \"codigo_produto\"."}},"required":["codigo_produto_integracao"]}}},"example":{"call":"ConsultarProduto","param":[{"codigo_produto":0,"codigo_produto_integracao":"","codigo":""}]}},"geral_produtos_ConsultarProduto_retorno":{"type":"object","properties":{"codigo_produto":{"type":"integer","description":"Código do produto. É o ID do produto e será utilizado apenas nas APIs como chave principal para localizar um produto. Quando um produto for incluído via API, você receberá um ID para esse novo produto. Recomendamos que você guarde essa informação no aplicativo que estiver integrando. Esse campo não deve ser informado na inclusão de produtos. Essa informação não será exibida nas telas do Omie."},"codigo_produto_integracao":{"type":"string","description":"Código de integração do produto. É o código do produto no aplicativo que você está integrando ao Omie. É utilizado basicamente na Inclusão de Produtos via API, para evitar duplicidade de cadastros. Quando um produto for incluído via API, você receberá um ID para esse novo produto. Recomendamos que você guarde essa informação no aplicativo que estiver integrando. O preenchimento desse campo é obrigatório na inclusão de produtos. Essa informação não será exibida nas telas do Omie."},"codigo":{"type":"string","description":"Código do Produto. É um código único que identifica o produto no Omie. Se você tem um código SKU (Stock Keeping Unit = Unidade de Manutenção de Estoque) é aqui que ele deve ser informado, pois é essa informação que será exibida na tela do Omie. Não recomendamos que ele seja utilizado como chave para integração, pois pode ser modificado pelo usuário a qualquer momento. No lugar deste campo, utilize o ID do produto, que você encontra na tag \"codigo_produto\"."},"descricao":{"type":"string","description":"Descrição do produto."},"unidade":{"type":"string","description":"Código da Unidade."},"ncm":{"type":"string","description":"Código da Nomenclatura Comum do Mercosul (NCM)."},"ean":{"type":"string","description":"Código EAN (GTIN - Global Trade Item Number)."},"valor_unitario":{"type":"decimal","description":"Preço Unitário de Venda."},"codigo_familia":{"type":"integer","description":"Código da Familia do Produto."},"tipoItem":{"type":"string","description":"Código do Tipo do Item para o SPED. Pode ser: 00 - Mercadoria para Revenda 01 - Matéria Prima 02 - Embalagem 03 - Produto em Processo 04 - Produto Acabado 05 - Subproduto 06 - Produto Intermediário 07 - Material de Uso e Consumo 08 - Ativo Imobilizado 09 - Serviços 10 - Outros Insumos 99 - Outras"},"produto_variacao":{"type":"string","description":"Indica se o Produto Possui Variações. Campo disponível apenas para consulta. (S/N) ."},"produto_lote":{"type":"string","description":"Indica se o produto possui lote. (S/N) ."},"variacao":{"type":"string","description":"Indica se o Produto é uma variação de produto. (S/N) . No método ListarProdutos, esse campo só será exibido se a tag 'exibir_info_variacoes' for enviada como 'S'."},"id_produto_variacao":{"type":"integer","description":"Código interno do produto variação que deu origem a variação. Campo disponível apenas para consulta. No método ListarProdutos, esse campo só será exibido se a tag 'exibir_info_variacoes' for enviada como 'S'."},"recomendacoes_fiscais":{"type":"object","properties":{"origem_mercadoria":{"type":"string","description":"Origem da Mercadoria. Pode ser: 0 - Nacional, exceto as indicadas nos códigos 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 superior a 40% e inferior ou igual a 70 4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos 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 em lista da CAMEX e gás natural 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante em lista da CAMEX e gás natural 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70"},"id_preco_tabelado":{"type":"integer","description":"ID do Preço tabelado (Pauta)."},"id_cest":{"type":"string","description":"Código do CEST. (Código Especificador da Substituíção Tributária). Formato: 99.999.99"},"cupom_fiscal":{"type":"string","description":"Indica se o produto é comercializado via PDV. Através de emissão de Cupom Fiscal ECF, SAT ou NFC-e. Preencher com \"S\" ou \"N\"."},"market_place":{"type":"string","description":"Indica se o produto será comercializado via Market Place ou e-commerce (S/N) Preencher com \"S\" ou \"N\"."},"indicador_escala":{"type":"string","description":"Indicador de Produção em Escala Relevante. Pode ser: \"S\" para Produzido em Escala Relevante. \"N\" para Produzido em Escala NÃO Relevante."},"cnpj_fabricante":{"type":"string","description":"CNPJ do Fabricante da Mercadoria."}},"description":"Recomendações Fiscais."},"peso_liq":{"type":"decimal","description":"Peso Líquido (Kg). Localizado na aba \"Informações Adicionais\""},"peso_bruto":{"type":"decimal","description":"Peso Bruto (Kg). Localizado na aba \"Informações Adicionais\""},"altura":{"type":"decimal","description":"Altura (centimentos). Localizado na aba \"Informações Adicionais\""},"largura":{"type":"decimal","description":"Largura (centimetros) Localizado na aba \"Informações Adicionais\""},"profundidade":{"type":"decimal","description":"Profundidade (centimetros). Localizado na aba \"Informações Adicionais\""},"marca":{"type":"string","description":"Marca. Localizado na aba \"Informações Adicionais\""},"modelo":{"type":"string","description":"Modelo. Localizado na aba \"Informações Adicionais\""},"dias_garantia":{"type":"integer","description":"Dias de Garantia. Localizado na aba \"Informações Adicionais\""},"dias_crossdocking":{"type":"integer","description":"Dias de Crossdocking. Localizado na aba \"Informações Adicionais\""},"descr_detalhada":{"type":"string","description":"Descrição Detalhada para o Produto."},"obs_internas":{"type":"string","description":"Observações Internas. (ficam registradas apenas no cadastro do produto)."},"imagens":{"type":"array","items":{"type":"object","properties":{"url_imagem":{"type":"string","description":"URL da Imagem do produto."}}},"description":"Lista de imagens do produto."},"videos":{"type":"array","items":{"type":"object","properties":{"url_video":{"type":"string","description":"URL do Video do produto."}}},"description":"Lista de videos do produto."},"caracteristicas":{"type":"array","items":{"type":"object","properties":{"nCodCaract":{"type":"integer","description":"Código da característica de produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da característica do produto gerado pelo Omie."},"cCodIntCaract":{"type":"string","description":"Código de integração da característica do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código da característica utilizado no seu aplicativo quando incluir uma característica no Omie. Assim, poderá utilizar esse campo para resgatar as informações da característica desejada. Caso informe esse campo, não informe a tag nCodCaract. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"cNomeCaract":{"type":"string","description":"Nome da característica."},"cConteudo":{"type":"string","description":"Conteúdo da característica."},"cExibirItemNF":{"type":"string","description":"Exibir esta característica no item da NF-e emitida (S/N)."},"cExibirItemPedido":{"type":"string","description":"Exibir esta característica no item do Pedido, Remessa ou Devolução (S/N)."},"cExibirOrdemProd":{"type":"string","description":"Exibe esta característica na Ordem de Produção e Mapa de Custo (S/N)."}}},"description":"lista de caracteristicas do produto."},"tabelas_preco":{"type":"array","items":{"type":"object","properties":{"nCodTabPreco":{"type":"integer","description":"Id da tabela de preço."},"cNomeTabPreco":{"type":"string","description":"Nome da tabela de preço."},"nValorTabPreco":{"type":"decimal","description":"Valor do produto na tabela de preço."}}},"description":"Lista de tabelas de preço."},"info":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração."},"hInc":{"type":"string","description":"Hora da Inclusão. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração."},"uInc":{"type":"string","description":"Usuário da Inclusão. Não deve ser informado na Inclusão/Alteração."},"dAlt":{"type":"string","description":"Data da Alteração. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração."},"hAlt":{"type":"string","description":"Hora da Alteração. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração."},"uAlt":{"type":"string","description":"Usuário da Alteração. Não deve ser informado na Inclusão/Alteração."},"cImpAPI":{"type":"string","description":"Importado pela API (S/N). Não deve ser informado na Inclusão/Alteração."}},"description":"Informações complemetares do cadastro do produto."},"exibir_descricao_nfe":{"type":"string","description":"Indica se a Descrição Detalhada deve ser exibida nas Informações Adicionais do Item da NF-e (S/N)."},"exibir_descricao_pedido":{"type":"string","description":"Indica se a Descrição Detalhada deve ser exibida na impressão do Pedido (S/N)."},"medicamento":{"type":"object","properties":{"cod_anvisa":{"type":"string","description":"Código de produto Anvisa"},"preco_max_cons":{"type":"decimal","description":"Preço máximo consumidor"}},"description":"Detalhamento específico para cadastro de medicamentos Obrigatório o preenchimento no caso de medicamentos e produtos farmacêuticos"},"combustivel":{"type":"object","properties":{"codigo_anp":{"type":"string","description":"Código de Produto da ANP."},"descr_anp":{"type":"string","description":"Descrição do Produto conforme ANP."},"percent_glp":{"type":"decimal","description":"Percentual de GLP Derivado do Petróleo."},"percent_gas_nac":{"type":"decimal","description":"Percentual de Gás Natural Nacional."},"percent_gas_imp":{"type":"decimal","description":"Percentual de Gás Natural Importado."},"valor_part":{"type":"decimal","description":"Valor de partida"}},"description":"Detalhamento específico para cadastro de combustíveis."},"veiculo":{"type":"object","properties":{"ano_fabr":{"type":"string"},"ano_modelo":{"type":"string","description":"Ano modelo de fabricação"},"chassi":{"type":"string","description":"Chassi do veículo"},"cilin":{"type":"string","description":"Cilindradas"},"cmt":{"type":"string","description":"Capacidade máxima de tração"},"cond_veic":{"type":"string","description":"Condição do veículo"},"cod_cor_veic":{"type":"string","description":"Código da cor do veículo"},"cod_cor_den":{"type":"string","description":"Código da cor DENATRAN"},"descr_cor":{"type":"string","description":"Descrição da cor"},"dist_eixo":{"type":"string","description":"Distância entre eixos"},"especie_veic":{"type":"string","description":"Espécie do veículo"},"lota_max":{"type":"string","description":"Capacidade máxima de lotação"},"cod_modelo":{"type":"string","description":"Código marca modelo"},"motor":{"type":"string","description":"Número do motor"},"peso_bruto_veic":{"type":"string","description":"Peso bruto"},"peso_liquido_veic":{"type":"string","description":"Peso líquido"},"potencia":{"type":"string","description":"Potência motor"},"serie_veic":{"type":"string","description":"Série do veículo"},"tipo_comb":{"type":"string","description":"Tipo de combustível"},"tipo_oper":{"type":"string","description":"Tipo da operação"},"tipo_pintura":{"type":"string","description":"Tipo de pintura"},"tipo_restricao":{"type":"string","description":"Restrição"},"tipo_veic":{"type":"string","description":"Tipo de veículo de acordo com a tabela RENAVAM"},"cond_vin":{"type":"string","description":"Condição do VIN"}},"description":"Detalhamento específico para cadastro de veículos"},"armamento":{"type":"object","properties":{"serie_cano":{"type":"string","description":"Número de série do cano"},"descr_arma":{"type":"string","description":"Descrição completa da arma"},"serie_arma":{"type":"string","description":"Número de série da arma"},"tipo_arma":{"type":"string","description":"Indicador do tipo de arma de fogo"}},"description":"Detalhamento especifco para cadastro de armamentos. Descrição completa da arma, de modo a permitir sua perfeita identificação."},"cst_icms":{"type":"string","description":"Código da Situação Tributária do ICMS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"modalidade_icms":{"type":"string","description":"Modalidade da Base de Cálculo do ICMS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"csosn_icms":{"type":"string","description":"Código da Situação Tributária para Simples Nacional. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"aliquota_icms":{"type":"decimal","description":"Alíquota de ICMS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"red_base_icms":{"type":"decimal","description":"Percentual de redução de base do ICMS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"motivo_deson_icms":{"type":"string","description":"Motivo da desoneração do ICMS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"per_icms_fcp":{"type":"decimal","description":"Percentual do Fundo de Combate a Pobreza do ICMS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"codigo_beneficio":{"type":"string","description":"Código do Beneficio Fiscal. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"cst_pis":{"type":"string","description":"Código da Situação Tributária do PIS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"aliquota_pis":{"type":"decimal","description":"Alíquota do PIS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"red_base_pis":{"type":"decimal","description":"Percentual de redução de base do PIS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"cst_cofins":{"type":"string","description":"Código da Situação Tributária do COFINS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"aliquota_cofins":{"type":"decimal","description":"Alíquota do COFINS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"red_base_cofins":{"type":"decimal","description":"Percentual de redução de base do COFINS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"cfop":{"type":"string","description":"CFOP do Produto. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"dadosIbpt":{"type":"object","properties":{"aliqFederal":{"type":"decimal","description":"Carga tributária federal para os produtos nacionais. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV."},"aliqEstadual":{"type":"decimal","description":"Carga tributária estadual. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV."},"aliqMunicipal":{"type":"decimal","description":"Carga tributária municipal. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV."},"fonte":{"type":"string","description":"Fonte do IBPT. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV."},"chave":{"type":"string","description":"Número da versão do arquivo do IBPT. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV."},"versao":{"type":"string","description":"Versão da Tabela IBPT. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV."},"valido_de":{"type":"string","description":"Tabela do IBPT válilda a partir da data. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV."},"valido_ate":{"type":"string","description":"Tabela do IBPT valida até a data. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV."}},"description":"Dados do IBPT. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV."},"codInt_familia":{"type":"string","description":"Código de Integração da Familia do Produto. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV."},"descricao_familia":{"type":"string","description":"Descrição da Familia do Produto. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV."},"bloqueado":{"type":"string","description":"Indica se o registro está bloqueado (S/N)."},"bloquear_exclusao":{"type":"string","description":"Indica se a exclusão do registro está bloqueada (S/N)."},"importado_api":{"type":"string","description":"Indica se o registro foi incluído via API (S/N). Não deve ser informado na Inclusão/Alteração."},"inativo":{"type":"string","description":"Indica se o cadastro do produto está inativo (S/N). Não deve ser informado na Inclusão/Alteração."},"componentes_kit":{"type":"array","items":{"type":"object","properties":{"codigo_componente":{"type":"integer","description":"Identificação do componente do KIT, deve ser utilizado para Alterar e Excluir o componente. Não deve ser informado na inclusão. Esse código não aparece na tela do Omie."},"codigo_produto_componente":{"type":"integer","description":"Código do produto componente. (Código interno utilizado apenas na API). Esse código não aparece na tela do Omie."},"quantidade_componente":{"type":"decimal","description":"Quantidade do componente."},"valor_unitario_componente":{"type":"decimal","description":"Valor unitário do componente."},"local_estoque_componente":{"type":"integer","description":"Local estoque do componente."}}},"description":"Componetes do KIT."},"lead_time":{"type":"integer","description":"Lead Time médio de ressuprimento em dias."},"aliquota_ibpt":{"type":"decimal","description":"DEPRECATED."},"cest":{"type":"string","description":"DEPRECATED."},"quantidade_estoque":{"type":"decimal","description":"DEPRECATED."},"estoque_minimo":{"type":"decimal","description":"DEPRECATED."},"origem_imposto":{"type":"string","description":"Origem do Imposto \"NCM\" ou \"PRD\" Esse campo não deve ser informado na inclusão ou alteração. Finalidade: Indicar se a regra de imposto utilizada pelos PDV\"s foi originada de uma configuração pelo NCM ou por uma configuração específica para o produto."},"cst_ibs_cbs":{"type":"string","description":"Código de Situação Tributária do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"class_trib":{"type":"string","description":"Código de Classificação Tributária do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"aliquota_ibs_uf":{"type":"decimal","description":"Alíquota do IBS de competência das UF. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"aliquota_ibs_mun":{"type":"decimal","description":"Alíquota do IBS de competência do Município. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"perc_reducao_ibs_uf":{"type":"decimal","description":"Percentual da redução de alíquota do IBS UF. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"perc_reducao_ibs_mun":{"type":"decimal","description":"Percentual da redução de alíquota IBS UF. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"aliquota_cbs":{"type":"decimal","description":"Alíquota da CBS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"perc_reducao_cbs":{"type":"decimal","description":"Percentual da redução de alíquota da CBS Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."}},"title":"ConsultarProduto (retorno)"},"geral_produtos_ExcluirProduto":{"type":"object","title":"ExcluirProduto","description":"Exclui um produto","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirProduto"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_produto":{"type":"integer","maxLength":15,"description":"(Código interno utilizado apenas na API).\nEsse código não aparece na tela do Omie.\nUtilize esse código para identificar um produto via API, para obter uma melhor performance.\nOpcionalmente você pode informar o código de integração para localizar um produto através do campo \"codigo_produto_integracao\"."},"codigo_produto_integracao":{"type":"string","maxLength":60,"description":"Código de integração do produto.\n(Utilizado para integração via API)\nEsse código não aparece na tela do Omie.\nUtilize esse campo quando incluir um produto e desejar associar o código do produto do seu aplicativo com o código de produto gerado pelo Omie.\nO preenchimento desse campo é obrigatório na inclusão e opcional para os demais métodos."},"codigo":{"type":"string","maxLength":60,"description":"Código do Produto.\nÉ o código do produto que é exibido na tela do Omie.\nNão utilize esse código para realizar a integração, ele tem função apenas informativa para o usuário e pode ser alterado a qualquer momento.\nPara integração utilize o código interno do produto através da tag \"codigo_produto\"."}},"required":["codigo_produto_integracao"]}}},"example":{"call":"ExcluirProduto","param":[{"codigo_produto":0,"codigo_produto_integracao":"","codigo":""}]}},"geral_produtos_ExcluirProduto_retorno":{"type":"object","properties":{"codigo_produto":{"type":"integer","description":"Código do produto. (Código interno utilizado apenas na API). Esse código não aparece na tela do Omie. Utilize esse código para identificar um produto via API, para obter uma melhor performance. Opcionalmente você pode informar o código de integração para localizar um produto através do campo \"codigo_produto_integracao\"."},"codigo_produto_integracao":{"type":"string","description":"Código de integração do produto. (Utilizado para integração via API) Esse código não aparece na tela do Omie. Utilize esse campo quando incluir um produto e desejar associar o código do produto do seu aplicativo com o código de produto gerado pelo Omie. O preenchimento desse campo é obrigatório na inclusão e opcional para os demais métodos."},"codigo_status":{"type":"string"},"descricao_status":{"type":"string"}},"title":"ExcluirProduto (retorno)"},"geral_produtos_IncluirProduto":{"type":"object","title":"IncluirProduto","description":"Incluir um produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirProduto"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_produto":{"type":"integer","maxLength":15,"description":"Código do produto.\nÉ o ID do produto e será utilizado apenas nas APIs como chave principal para localizar um produto.\n\nQuando um produto for incluído via API, você receberá um ID para esse novo produto.\nRecomendamos que você guarde essa informação no aplicativo que estiver integrando.\n\nEsse campo não deve ser informado na inclusão de produtos.\n\nEssa informação não será exibida nas telas do Omie."},"codigo_produto_integracao":{"type":"string","maxLength":60,"description":"Código de integração do produto.\nÉ o código do produto no aplicativo que você está integrando ao Omie.\nÉ utilizado basicamente na Inclusão de Produtos via API, para evitar duplicidade de cadastros.\n\nQuando um produto for incluído via API, você receberá um ID para esse novo produto.\nRecomendamos que você guarde essa informação no aplicativo que estiver integrando.\n\nO preenchimento desse campo é obrigatório na inclusão de produtos.\n\nEssa informação não será exibida nas telas do Omie."},"codigo":{"type":"string","maxLength":60,"description":"Código do Produto.\n\nÉ um código único que identifica o produto no Omie. Se você tem um código SKU (Stock Keeping Unit = Unidade de Manutenção de Estoque) é aqui que ele deve ser informado, pois é essa informação que será exibida na tela do Omie.\n\nNão recomendamos que ele seja utilizado como chave para integração, pois pode ser modificado pelo usuário a qualquer momento. No lugar deste campo, utilize o ID do produto, que você encontra na tag \"codigo_produto\"."},"descricao":{"type":"string","maxLength":120,"description":"Descrição do produto."},"unidade":{"type":"string","maxLength":6,"description":"Código da Unidade."},"ncm":{"type":"string","maxLength":13,"description":"Código da Nomenclatura Comum do Mercosul (NCM)."},"ean":{"type":"string","maxLength":14,"description":"Código EAN (GTIN - Global Trade Item Number)."},"valor_unitario":{"type":"number","maxLength":18,"description":"Preço Unitário de Venda."},"codigo_familia":{"type":"integer","maxLength":15,"description":"Código da Familia do Produto."},"tipoItem":{"type":"string","maxLength":2,"description":"Código do Tipo do Item para o SPED.\n\n\nPode ser:\n\n00 - Mercadoria para Revenda\n01 - Matéria Prima\n02 - Embalagem\n03 - Produto em Processo\n04 - Produto Acabado\n05 - Subproduto\n06 - Produto Intermediário\n07 - Material de Uso e Consumo\n08 - Ativo Imobilizado\n09 - Serviços\n10 - Outros Insumos\n99 - Outras"},"produto_variacao":{"type":"string","maxLength":1,"description":"Indica se o Produto Possui Variações.\n\nCampo disponível apenas para consulta.\n\n(S/N) ."},"produto_lote":{"type":"string","maxLength":1,"description":"Indica se o produto possui lote.\n(S/N) ."},"variacao":{"type":"string","maxLength":1,"description":"Indica se o Produto é uma variação de produto.\n(S/N) .\n\nNo método ListarProdutos, esse campo só será exibido se a tag 'exibir_info_variacoes' for enviada como 'S'."},"id_produto_variacao":{"type":"integer","maxLength":15,"description":"Código interno do produto variação que deu origem a variação.\n\nCampo disponível apenas para consulta.\n\nNo método ListarProdutos, esse campo só será exibido se a tag 'exibir_info_variacoes' for enviada como 'S'."},"recomendacoes_fiscais":{"type":"object","properties":{"origem_mercadoria":{"type":"string","maxLength":1,"description":"Origem da Mercadoria.\n\n\nPode ser:\n0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8\n1 - Estrangeira - Importação direta, exceto a indicada no código 6\n2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7\n3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40% e inferior ou igual a 70\n4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes\n5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40\n6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural\n7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante em lista da CAMEX e gás natural\n8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70"},"id_preco_tabelado":{"type":"integer","maxLength":15,"description":"ID do Preço tabelado (Pauta)."},"id_cest":{"type":"string","maxLength":9,"description":"Código do CEST.\n(Código Especificador da Substituíção Tributária).\n\n\nFormato: 99.999.99"},"cupom_fiscal":{"type":"string","maxLength":1,"description":"Indica se o produto é comercializado via PDV.\n\nAtravés de emissão de Cupom Fiscal ECF, SAT ou NFC-e.\n\n\nPreencher com \"S\" ou \"N\"."},"market_place":{"type":"string","maxLength":1,"description":"Indica se o produto será comercializado via Market Place ou e-commerce (S/N)\n\n\nPreencher com \"S\" ou \"N\"."},"indicador_escala":{"type":"string","maxLength":1,"description":"Indicador de Produção em Escala Relevante.\n\nPode ser:\n\"S\" para Produzido em Escala Relevante.\n\"N\" para Produzido em Escala NÃO Relevante."},"cnpj_fabricante":{"type":"string","maxLength":20,"description":"CNPJ do Fabricante da Mercadoria."}},"description":"Recomendações Fiscais."},"peso_liq":{"type":"number","maxLength":18,"description":"Peso Líquido (Kg).\n\n\nLocalizado na aba \"Informações Adicionais\""},"peso_bruto":{"type":"number","maxLength":18,"description":"Peso Bruto (Kg).\n\n\nLocalizado na aba \"Informações Adicionais\""},"altura":{"type":"number","maxLength":18,"description":"Altura (centimentos).\n\n\nLocalizado na aba \"Informações Adicionais\""},"largura":{"type":"number","maxLength":18,"description":"Largura (centimetros)\n\n\nLocalizado na aba \"Informações Adicionais\""},"profundidade":{"type":"number","maxLength":18,"description":"Profundidade (centimetros).\n\n\nLocalizado na aba \"Informações Adicionais\""},"marca":{"type":"string","maxLength":60,"description":"Marca.\n\n\nLocalizado na aba \"Informações Adicionais\""},"modelo":{"type":"string","maxLength":60,"description":"Modelo.\n\n\nLocalizado na aba \"Informações Adicionais\""},"dias_garantia":{"type":"integer","maxLength":4,"description":"Dias de Garantia.\n\n\nLocalizado na aba \"Informações Adicionais\""},"dias_crossdocking":{"type":"integer","maxLength":3,"description":"Dias de Crossdocking.\n\n\nLocalizado na aba \"Informações Adicionais\""},"descr_detalhada":{"type":"string","description":"Descrição Detalhada para o Produto."},"obs_internas":{"type":"string","description":"Observações Internas.\n(ficam registradas apenas no cadastro do produto)."},"imagens":{"type":"array","items":{"type":"object","properties":{"url_imagem":{"type":"string","description":"URL da Imagem do produto."}}},"description":"Lista de imagens do produto."},"videos":{"type":"array","items":{"type":"object","properties":{"url_video":{"type":"string","description":"URL do Video do produto."}}},"description":"Lista de videos do produto."},"caracteristicas":{"type":"array","items":{"type":"object","properties":{"nCodCaract":{"type":"integer","maxLength":15,"description":"Código da característica de produto.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno da característica do produto gerado pelo Omie."},"cCodIntCaract":{"type":"string","maxLength":20,"description":"Código de integração da característica do produto.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código da característica utilizado no seu aplicativo quando incluir uma característica no Omie.\nAssim, poderá utilizar esse campo para resgatar as informações da característica desejada.\nCaso informe esse campo, não informe a tag nCodCaract. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"cNomeCaract":{"type":"string","maxLength":30,"description":"Nome da característica."},"cConteudo":{"type":"string","maxLength":60,"description":"Conteúdo da característica."},"cExibirItemNF":{"type":"string","maxLength":1,"description":"Exibir esta característica no item da NF-e emitida (S/N)."},"cExibirItemPedido":{"type":"string","maxLength":1,"description":"Exibir esta característica no item do Pedido, Remessa ou Devolução (S/N)."},"cExibirOrdemProd":{"type":"string","maxLength":1,"description":"Exibe esta característica na Ordem de Produção e Mapa de Custo (S/N)."}}},"description":"lista de caracteristicas do produto."},"tabelas_preco":{"type":"array","items":{"type":"object","properties":{"nCodTabPreco":{"type":"integer","maxLength":15,"description":"Id da tabela de preço."},"cNomeTabPreco":{"type":"string","maxLength":50,"description":"Nome da tabela de preço."},"nValorTabPreco":{"type":"number","maxLength":18,"description":"Valor do produto na tabela de preço."}}},"description":"Lista de tabelas de preço."},"info":{"type":"object","properties":{"dInc":{"type":"string","maxLength":10,"description":"Data da Inclusão.\nNo formato dd/mm/aaaa.\n\nNão deve ser informado na Inclusão/Alteração."},"hInc":{"type":"string","maxLength":8,"description":"Hora da Inclusão.\nNo formato hh:mm:ss.\n\nNão deve ser informado na Inclusão/Alteração."},"uInc":{"type":"string","maxLength":10,"description":"Usuário da Inclusão.\n\nNão deve ser informado na Inclusão/Alteração."},"dAlt":{"type":"string","maxLength":10,"description":"Data da Alteração.\nNo formato dd/mm/aaaa.\n\nNão deve ser informado na Inclusão/Alteração."},"hAlt":{"type":"string","maxLength":8,"description":"Hora da Alteração.\nNo formato hh:mm:ss.\n\nNão deve ser informado na Inclusão/Alteração."},"uAlt":{"type":"string","maxLength":10,"description":"Usuário da Alteração.\n\nNão deve ser informado na Inclusão/Alteração."},"cImpAPI":{"type":"string","maxLength":1,"description":"Importado pela API (S/N).\n\nNão deve ser informado na Inclusão/Alteração."}},"description":"Informações complemetares do cadastro do produto."},"exibir_descricao_nfe":{"type":"string","maxLength":1,"description":"Indica se a Descrição Detalhada deve ser exibida nas Informações Adicionais do Item da NF-e (S/N)."},"exibir_descricao_pedido":{"type":"string","maxLength":1,"description":"Indica se a Descrição Detalhada deve ser exibida na impressão do Pedido (S/N)."},"medicamento":{"type":"object","properties":{"cod_anvisa":{"type":"string","maxLength":13,"description":"Código de produto Anvisa"},"preco_max_cons":{"type":"number","maxLength":15,"description":"Preço máximo consumidor"}},"description":"Detalhamento específico para cadastro de medicamentos\n\nObrigatório o preenchimento no caso de medicamentos e produtos farmacêuticos"},"combustivel":{"type":"object","properties":{"codigo_anp":{"type":"string","maxLength":9,"description":"Código de Produto da ANP."},"descr_anp":{"type":"string","maxLength":95,"description":"Descrição do Produto conforme ANP."},"percent_glp":{"type":"number","description":"Percentual de GLP Derivado do Petróleo."},"percent_gas_nac":{"type":"number","maxLength":9,"description":"Percentual de Gás Natural Nacional."},"percent_gas_imp":{"type":"number","description":"Percentual de Gás Natural Importado."},"valor_part":{"type":"number","description":"Valor de partida"}},"description":"Detalhamento específico para cadastro de combustíveis."},"veiculo":{"type":"object","properties":{"ano_fabr":{"type":"string","maxLength":4},"ano_modelo":{"type":"string","maxLength":4,"description":"Ano modelo de fabricação"},"chassi":{"type":"string","maxLength":17,"description":"Chassi do veículo"},"cilin":{"type":"string","maxLength":4,"description":"Cilindradas"},"cmt":{"type":"string","maxLength":9,"description":"Capacidade máxima de tração"},"cond_veic":{"type":"string","maxLength":1,"description":"Condição do veículo"},"cod_cor_veic":{"type":"string","maxLength":4,"description":"Código da cor do veículo"},"cod_cor_den":{"type":"string","maxLength":2,"description":"Código da cor DENATRAN"},"descr_cor":{"type":"string","maxLength":40,"description":"Descrição da cor"},"dist_eixo":{"type":"string","maxLength":4,"description":"Distância entre eixos"},"especie_veic":{"type":"string","maxLength":1,"description":"Espécie do veículo"},"lota_max":{"type":"string","maxLength":3,"description":"Capacidade máxima de lotação"},"cod_modelo":{"type":"string","maxLength":6,"description":"Código marca modelo"},"motor":{"type":"string","maxLength":21,"description":"Número do motor"},"peso_bruto_veic":{"type":"string","maxLength":9,"description":"Peso bruto"},"peso_liquido_veic":{"type":"string","maxLength":9,"description":"Peso líquido"},"potencia":{"type":"string","maxLength":4,"description":"Potência motor"},"serie_veic":{"type":"string","maxLength":9,"description":"Série do veículo"},"tipo_comb":{"type":"string","maxLength":2,"description":"Tipo de combustível"},"tipo_oper":{"type":"string","maxLength":1,"description":"Tipo da operação"},"tipo_pintura":{"type":"string","maxLength":1,"description":"Tipo de pintura"},"tipo_restricao":{"type":"string","maxLength":1,"description":"Restrição"},"tipo_veic":{"type":"string","maxLength":2,"description":"Tipo de veículo de acordo com a tabela RENAVAM"},"cond_vin":{"type":"string","maxLength":1,"description":"Condição do VIN"}},"description":"Detalhamento específico para cadastro de veículos"},"armamento":{"type":"object","properties":{"serie_cano":{"type":"string","maxLength":15,"description":"Número de série do cano"},"descr_arma":{"type":"string","maxLength":256,"description":"Descrição completa da arma"},"serie_arma":{"type":"string","maxLength":15,"description":"Número de série da arma"},"tipo_arma":{"type":"string","maxLength":1,"description":"Indicador do tipo de arma de fogo"}},"description":"Detalhamento especifco para cadastro de armamentos.\n\nDescrição completa da arma, de modo a permitir sua perfeita identificação."},"cst_icms":{"type":"string","maxLength":2,"description":"Código da Situação Tributária do ICMS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"modalidade_icms":{"type":"string","maxLength":1,"description":"Modalidade da Base de Cálculo do ICMS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"csosn_icms":{"type":"string","maxLength":3,"description":"Código da Situação Tributária para Simples Nacional.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"aliquota_icms":{"type":"number","description":"Alíquota de ICMS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"red_base_icms":{"type":"number","maxLength":10,"description":"Percentual de redução de base do ICMS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"motivo_deson_icms":{"type":"string","maxLength":2,"description":"Motivo da desoneração do ICMS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"per_icms_fcp":{"type":"number","maxLength":10,"description":"Percentual do Fundo de Combate a Pobreza do ICMS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"codigo_beneficio":{"type":"string","maxLength":20,"description":"Código do Beneficio Fiscal.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"cst_pis":{"type":"string","maxLength":2,"description":"Código da Situação Tributária do PIS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"aliquota_pis":{"type":"number","maxLength":10,"description":"Alíquota do PIS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"red_base_pis":{"type":"number","maxLength":10,"description":"Percentual de redução de base do PIS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"cst_cofins":{"type":"string","maxLength":2,"description":"Código da Situação Tributária do COFINS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"aliquota_cofins":{"type":"number","maxLength":10,"description":"Alíquota do COFINS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"red_base_cofins":{"type":"number","description":"Percentual de redução de base do COFINS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"cfop":{"type":"string","maxLength":10,"description":"CFOP do Produto.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"dadosIbpt":{"type":"object","properties":{"aliqFederal":{"type":"number","maxLength":10,"description":"Carga tributária federal para os produtos nacionais.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV."},"aliqEstadual":{"type":"number","maxLength":10,"description":"Carga tributária estadual.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV."},"aliqMunicipal":{"type":"number","maxLength":10,"description":"Carga tributária municipal.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV."},"fonte":{"type":"string","maxLength":34,"description":"Fonte do IBPT.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV."},"chave":{"type":"string","maxLength":6,"description":"Número da versão do arquivo do IBPT.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV."},"versao":{"type":"string","maxLength":6,"description":"Versão da Tabela IBPT.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV."},"valido_de":{"type":"string","maxLength":10,"description":"Tabela do IBPT válilda a partir da data.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV."},"valido_ate":{"type":"string","maxLength":10,"description":"Tabela do IBPT valida até a data.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV."}},"description":"Dados do IBPT.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV."},"codInt_familia":{"type":"string","maxLength":20,"description":"Código de Integração da Familia do Produto.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV."},"descricao_familia":{"type":"string","maxLength":50,"description":"Descrição da Familia do Produto.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV."},"bloqueado":{"type":"string","maxLength":1,"description":"Indica se o registro está bloqueado (S/N)."},"bloquear_exclusao":{"type":"string","maxLength":1,"description":"Indica se a exclusão do registro está bloqueada (S/N)."},"importado_api":{"type":"string","maxLength":1,"description":"Indica se o registro foi incluído via API (S/N).\n\nNão deve ser informado na Inclusão/Alteração."},"inativo":{"type":"string","maxLength":1,"description":"Indica se o cadastro do produto está inativo (S/N).\n\nNão deve ser informado na Inclusão/Alteração."},"componentes_kit":{"type":"array","items":{"type":"object","properties":{"codigo_componente":{"type":"integer","maxLength":15,"description":"Identificação do componente do KIT, deve ser utilizado para Alterar e Excluir o componente.\n\nNão deve ser informado na inclusão.\n\nEsse código não aparece na tela do Omie."},"codigo_produto_componente":{"type":"integer","maxLength":15,"description":"Código do produto componente.\n(Código interno utilizado apenas na API).\nEsse código não aparece na tela do Omie."},"quantidade_componente":{"type":"number","maxLength":10,"description":"Quantidade do componente."},"valor_unitario_componente":{"type":"number","maxLength":18,"description":"Valor unitário do componente."},"local_estoque_componente":{"type":"integer","maxLength":15,"description":"Local estoque do componente."}}},"description":"Componetes do KIT."},"lead_time":{"type":"integer","maxLength":4,"description":"Lead Time médio de ressuprimento em dias."},"aliquota_ibpt":{"type":"number","description":"DEPRECATED."},"cest":{"type":"string","maxLength":9,"description":"DEPRECATED."},"quantidade_estoque":{"type":"number","maxLength":18,"description":"DEPRECATED."},"estoque_minimo":{"type":"number","maxLength":18,"description":"DEPRECATED."},"origem_imposto":{"type":"string","maxLength":10,"description":"Origem do Imposto\n\n\"NCM\" ou \"PRD\"\n\nEsse campo não deve ser informado na inclusão ou alteração.\n\nFinalidade: Indicar se a regra de imposto utilizada pelos PDV\"s foi originada de uma configuração pelo NCM ou por uma configuração específica para o produto."},"cst_ibs_cbs":{"type":"string","maxLength":3,"description":"Código de Situação Tributária do IBS e CBS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"class_trib":{"type":"string","maxLength":6,"description":"Código de Classificação Tributária do IBS e CBS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"aliquota_ibs_uf":{"type":"number","maxLength":7,"description":"Alíquota do IBS de competência das UF.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"aliquota_ibs_mun":{"type":"number","maxLength":7,"description":"Alíquota do IBS de competência do Município.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"perc_reducao_ibs_uf":{"type":"number","maxLength":7,"description":"Percentual da redução de alíquota do IBS UF.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"perc_reducao_ibs_mun":{"type":"number","maxLength":7,"description":"Percentual da redução de alíquota IBS UF.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"aliquota_cbs":{"type":"number","maxLength":7,"description":"Alíquota da CBS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"perc_reducao_cbs":{"type":"number","maxLength":7,"description":"Percentual da redução de alíquota da CBS\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."}},"required":["codigo","codigo_produto_integracao","descricao","medicamento","ncm","unidade"]}}},"example":{"call":"IncluirProduto","param":[{"codigo_produto_integracao":"1790774103","codigo":"teste0001","descricao":"Produto de teste","unidade":"UN"}]}},"geral_produtos_IncluirProduto_retorno":{"type":"object","properties":{"codigo_produto":{"type":"integer","description":"Código do produto. (Código interno utilizado apenas na API). Esse código não aparece na tela do Omie. Utilize esse código para identificar um produto via API, para obter uma melhor performance. Opcionalmente você pode informar o código de integração para localizar um produto através do campo \"codigo_produto_integracao\"."},"codigo_produto_integracao":{"type":"string","description":"Código de integração do produto. (Utilizado para integração via API) Esse código não aparece na tela do Omie. Utilize esse campo quando incluir um produto e desejar associar o código do produto do seu aplicativo com o código de produto gerado pelo Omie. O preenchimento desse campo é obrigatório na inclusão e opcional para os demais métodos."},"codigo_status":{"type":"string"},"descricao_status":{"type":"string"}},"title":"IncluirProduto (retorno)"},"geral_produtos_ListarProdutos":{"type":"object","title":"ListarProdutos","description":"Lista completa do Cadastro de Produtos","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarProdutos"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados.\n\nDefault 1."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 500.\n\nDefault 50."},"apenas_importado_api":{"type":"string","maxLength":1,"description":"Exibir apenas os registros gerados pela API.\n\n\n\nPreencher com \"S\" ou \"N\"."},"ordenar_por":{"type":"string","maxLength":100,"description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente (S/N).\n\n\nPreencher com \"S\" ou \"N\"."},"filtrar_por_data_de":{"type":"string","maxLength":10,"description":"Filtrar os registros a partir de uma data.\n\n\nFormato: \"dd/mm/aaaa\""},"filtrar_por_hora_de":{"type":"string","maxLength":8,"description":"Filtrar a partir da hora.\n\n\nFormato: \"hh:mm:ss\""},"filtrar_por_data_ate":{"type":"string","maxLength":10,"description":"Filtrar os registros até uma data.\n\n\nFormato: \"dd/mm/aaaa\""},"filtrar_por_hora_ate":{"type":"string","maxLength":8,"description":"Filtrar até a hora.\n\n\nFormato: \"hh:mm:ss\""},"filtrar_apenas_inclusao":{"type":"string","maxLength":1,"description":"Filtrar apenas os registros incluídos (S/N).\n\n\nPreencher com \"S\" ou \"N\"."},"filtrar_apenas_alteracao":{"type":"string","maxLength":1,"description":"Filtrar apenas os registros alterados (S/N).\n\n\nPreencher com \"S\" ou \"N\"."},"filtrar_apenas_omiepdv":{"type":"string","maxLength":1,"description":"Filtrar apenas produtos marcados para venda via PDV.\n\nATENÇÃO:\nTodos os PDVs integrados devem preencher esse campo com \"S\".\nO preenchimento desse campo é obrigatório e o seu padrão é \"S\".\nQuando preenchido como \"S\" filtra apenas o produtos que tenham configuração de impostos definidas para o PDV.\n\n\nPreencher com \"S\" ou \"N\"."},"filtrar_apenas_familia":{"type":"string","maxLength":50,"description":"Filtrar por ID da Familia de Produto."},"filtrar_apenas_tipo":{"type":"string","maxLength":2,"description":"Código do Tipo do Item para o SPED.\n\n\nPode ser:\n\n00 - Mercadoria para Revenda\n01 - Matéria Prima\n02 - Embalagem\n03 - Produto em Processo\n04 - Produto Acabado\n05 - Subproduto\n06 - Produto Intermediário\n07 - Material de Uso e Consumo\n08 - Ativo Imobilizado\n09 - Serviços\n10 - Outros Insumos\n99 - Outras"},"filtrar_apenas_descricao":{"type":"string","maxLength":200,"description":"Filtro pela descrição do produto.\n\n\nPara filtrar utilize:\n\n\"TEXTO\" - Para pesquisa exata.\n\"TEXTO%\" - Para pesquisa começando com.\n\"%TEXTO\" - Para pesquisa terminando com.\n\"%TEXTO%\" - Para pesquisa contendo."},"filtrar_apenas_marketplace":{"type":"string","maxLength":1,"description":"Filtrar apenas produtos marcados para venda via Market Place ou e-Commerce.\n\n\nPreencher com \"S\" ou \"N\"."},"filtrar_apenas_pdv":{"type":"string","maxLength":1,"description":"Filtrar apenas produtos marcados para venda via Ponto de Venda (PDV).\n\n\nPreencher com \"S\" ou \"N\"."},"exibir_caracteristicas":{"type":"string","maxLength":1,"description":"Exibir as características do produto (S/N).\n\n\nPreencher com \"S\" ou \"N\"."},"exibir_tabelas_preco":{"type":"string","maxLength":1,"description":"Exibir as tabelas de preço do produto (S/N).\n\n\nPreencher com \"S\" ou \"N\"."},"caracteristicas":{"type":"array","items":{"type":"object","properties":{"nCodCaract":{"type":"integer","maxLength":15,"description":"Código da característica de produto.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno da característica do produto gerado pelo Omie."},"cCodIntCaract":{"type":"string","maxLength":20,"description":"Código de integração da característica do produto.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código da característica utilizado no seu aplicativo quando incluir uma característica no Omie.\nAssim, poderá utilizar esse campo para resgatar as informações da característica desejada.\nCaso informe esse campo, não informe a tag nCodCaract. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"cNomeCaract":{"type":"string","maxLength":30,"description":"Nome da característica."},"cConteudo":{"type":"string","maxLength":60,"description":"Conteúdo da característica."},"cExibirItemNF":{"type":"string","maxLength":1,"description":"Exibir esta característica no item da NF-e emitida (S/N)."},"cExibirItemPedido":{"type":"string","maxLength":1,"description":"Exibir esta característica no item do Pedido, Remessa ou Devolução (S/N)."},"cExibirOrdemProd":{"type":"string","maxLength":1,"description":"Exibe esta característica na Ordem de Produção e Mapa de Custo (S/N)."}}},"description":"lista de caracteristicas do produto."},"produtosPorCodigo":{"type":"array","items":{"type":"object","properties":{"codigo_produto":{"type":"integer","maxLength":15,"description":"(Código interno utilizado apenas na API).\nEsse código não aparece na tela do Omie.\nUtilize esse código para identificar um produto via API, para obter uma melhor performance.\nOpcionalmente você pode informar o código de integração para localizar um produto através do campo \"codigo_produto_integracao\"."},"codigo_produto_integracao":{"type":"string","maxLength":60,"description":"Código de integração do produto.\n(Utilizado para integração via API)\nEsse código não aparece na tela do Omie.\nUtilize esse campo quando incluir um produto e desejar associar o código do produto do seu aplicativo com o código de produto gerado pelo Omie.\nO preenchimento desse campo é obrigatório na inclusão e opcional para os demais métodos."},"codigo":{"type":"string","maxLength":60,"description":"Código do Produto.\nÉ o código do produto que é exibido na tela do Omie.\nNão utilize esse código para realizar a integração, ele tem função apenas informativa para o usuário e pode ser alterado a qualquer momento.\nPara integração utilize o código interno do produto através da tag \"codigo_produto\"."}},"required":["codigo_produto_integracao"]},"description":"Filtro por código do produto."},"inativo":{"type":"string","maxLength":1,"description":"Indica se o cadastro do produto está inativo (S/N).\n\nNão deve ser informado na Inclusão/Alteração."},"ncm":{"type":"string","maxLength":13,"description":"Código da Nomenclatura Comum do Mercosul (NCM)."},"ean":{"type":"string","maxLength":14,"description":"Código EAN (GTIN - Global Trade Item Number)."},"ordem_descrescente":{"type":"string","maxLength":1,"description":"DEPRECATED."},"exibir_obs":{"type":"string","maxLength":1,"description":"Exibir as observações do produto (S/N).\n\n\nPreencher com \"S\" ou \"N\"."},"exibir_kit":{"type":"string","maxLength":1,"description":"Exibir os componentes do KIT (S/N).\n\n\nPreencher com \"S\" ou \"N\"."},"exibir_info_variacoes":{"type":"string","maxLength":1,"description":"Opcional. Indica se deve retornar informações sobre as variações de produto.\n\nPreencher com S/N.\n\nDisponível apenas para o método ListarProdutos."}},"required":["filtrar_apenas_omiepdv"]}}},"example":{"call":"ListarProdutos","param":[{"pagina":1,"registros_por_pagina":50,"apenas_importado_api":"N","filtrar_apenas_omiepdv":"N"}]}},"geral_produtos_ListarProdutos_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada"},"total_de_paginas":{"type":"integer","description":"Número total de páginas"},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"total de registros encontrados"},"produto_servico_cadastro":{"type":"array","items":{"type":"object","properties":{"codigo_produto":{"type":"integer","description":"Código do produto. É o ID do produto e será utilizado apenas nas APIs como chave principal para localizar um produto. Quando um produto for incluído via API, você receberá um ID para esse novo produto. Recomendamos que você guarde essa informação no aplicativo que estiver integrando. Esse campo não deve ser informado na inclusão de produtos. Essa informação não será exibida nas telas do Omie."},"codigo_produto_integracao":{"type":"string","description":"Código de integração do produto. É o código do produto no aplicativo que você está integrando ao Omie. É utilizado basicamente na Inclusão de Produtos via API, para evitar duplicidade de cadastros. Quando um produto for incluído via API, você receberá um ID para esse novo produto. Recomendamos que você guarde essa informação no aplicativo que estiver integrando. O preenchimento desse campo é obrigatório na inclusão de produtos. Essa informação não será exibida nas telas do Omie."},"codigo":{"type":"string","description":"Código do Produto. É um código único que identifica o produto no Omie. Se você tem um código SKU (Stock Keeping Unit = Unidade de Manutenção de Estoque) é aqui que ele deve ser informado, pois é essa informação que será exibida na tela do Omie. Não recomendamos que ele seja utilizado como chave para integração, pois pode ser modificado pelo usuário a qualquer momento. No lugar deste campo, utilize o ID do produto, que você encontra na tag \"codigo_produto\"."},"descricao":{"type":"string","description":"Descrição do produto."},"unidade":{"type":"string","description":"Código da Unidade."},"ncm":{"type":"string","description":"Código da Nomenclatura Comum do Mercosul (NCM)."},"ean":{"type":"string","description":"Código EAN (GTIN - Global Trade Item Number)."},"valor_unitario":{"type":"decimal","description":"Preço Unitário de Venda."},"codigo_familia":{"type":"integer","description":"Código da Familia do Produto."},"tipoItem":{"type":"string","description":"Código do Tipo do Item para o SPED. Pode ser: 00 - Mercadoria para Revenda 01 - Matéria Prima 02 - Embalagem 03 - Produto em Processo 04 - Produto Acabado 05 - Subproduto 06 - Produto Intermediário 07 - Material de Uso e Consumo 08 - Ativo Imobilizado 09 - Serviços 10 - Outros Insumos 99 - Outras"},"produto_variacao":{"type":"string","description":"Indica se o Produto Possui Variações. Campo disponível apenas para consulta. (S/N) ."},"produto_lote":{"type":"string","description":"Indica se o produto possui lote. (S/N) ."},"variacao":{"type":"string","description":"Indica se o Produto é uma variação de produto. (S/N) . No método ListarProdutos, esse campo só será exibido se a tag 'exibir_info_variacoes' for enviada como 'S'."},"id_produto_variacao":{"type":"integer","description":"Código interno do produto variação que deu origem a variação. Campo disponível apenas para consulta. No método ListarProdutos, esse campo só será exibido se a tag 'exibir_info_variacoes' for enviada como 'S'."},"recomendacoes_fiscais":{"type":"object","properties":{"origem_mercadoria":{"type":"string","description":"Origem da Mercadoria. Pode ser: 0 - Nacional, exceto as indicadas nos códigos 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 superior a 40% e inferior ou igual a 70 4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos 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 em lista da CAMEX e gás natural 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante em lista da CAMEX e gás natural 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70"},"id_preco_tabelado":{"type":"integer","description":"ID do Preço tabelado (Pauta)."},"id_cest":{"type":"string","description":"Código do CEST. (Código Especificador da Substituíção Tributária). Formato: 99.999.99"},"cupom_fiscal":{"type":"string","description":"Indica se o produto é comercializado via PDV. Através de emissão de Cupom Fiscal ECF, SAT ou NFC-e. Preencher com \"S\" ou \"N\"."},"market_place":{"type":"string","description":"Indica se o produto será comercializado via Market Place ou e-commerce (S/N) Preencher com \"S\" ou \"N\"."},"indicador_escala":{"type":"string","description":"Indicador de Produção em Escala Relevante. Pode ser: \"S\" para Produzido em Escala Relevante. \"N\" para Produzido em Escala NÃO Relevante."},"cnpj_fabricante":{"type":"string","description":"CNPJ do Fabricante da Mercadoria."}},"description":"Recomendações Fiscais."},"peso_liq":{"type":"decimal","description":"Peso Líquido (Kg). Localizado na aba \"Informações Adicionais\""},"peso_bruto":{"type":"decimal","description":"Peso Bruto (Kg). Localizado na aba \"Informações Adicionais\""},"altura":{"type":"decimal","description":"Altura (centimentos). Localizado na aba \"Informações Adicionais\""},"largura":{"type":"decimal","description":"Largura (centimetros) Localizado na aba \"Informações Adicionais\""},"profundidade":{"type":"decimal","description":"Profundidade (centimetros). Localizado na aba \"Informações Adicionais\""},"marca":{"type":"string","description":"Marca. Localizado na aba \"Informações Adicionais\""},"modelo":{"type":"string","description":"Modelo. Localizado na aba \"Informações Adicionais\""},"dias_garantia":{"type":"integer","description":"Dias de Garantia. Localizado na aba \"Informações Adicionais\""},"dias_crossdocking":{"type":"integer","description":"Dias de Crossdocking. Localizado na aba \"Informações Adicionais\""},"descr_detalhada":{"type":"string","description":"Descrição Detalhada para o Produto."},"obs_internas":{"type":"string","description":"Observações Internas. (ficam registradas apenas no cadastro do produto)."},"imagens":{"type":"array","items":{"type":"object","properties":{"url_imagem":{"type":"string","description":"URL da Imagem do produto."}}},"description":"Lista de imagens do produto."},"videos":{"type":"array","items":{"type":"object","properties":{"url_video":{"type":"string","description":"URL do Video do produto."}}},"description":"Lista de videos do produto."},"caracteristicas":{"type":"array","items":{"type":"object","properties":{"nCodCaract":{"type":"integer","description":"Código da característica de produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da característica do produto gerado pelo Omie."},"cCodIntCaract":{"type":"string","description":"Código de integração da característica do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código da característica utilizado no seu aplicativo quando incluir uma característica no Omie. Assim, poderá utilizar esse campo para resgatar as informações da característica desejada. Caso informe esse campo, não informe a tag nCodCaract. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"cNomeCaract":{"type":"string","description":"Nome da característica."},"cConteudo":{"type":"string","description":"Conteúdo da característica."},"cExibirItemNF":{"type":"string","description":"Exibir esta característica no item da NF-e emitida (S/N)."},"cExibirItemPedido":{"type":"string","description":"Exibir esta característica no item do Pedido, Remessa ou Devolução (S/N)."},"cExibirOrdemProd":{"type":"string","description":"Exibe esta característica na Ordem de Produção e Mapa de Custo (S/N)."}}},"description":"lista de caracteristicas do produto."},"tabelas_preco":{"type":"array","items":{"type":"object","properties":{"nCodTabPreco":{"type":"integer","description":"Id da tabela de preço."},"cNomeTabPreco":{"type":"string","description":"Nome da tabela de preço."},"nValorTabPreco":{"type":"decimal","description":"Valor do produto na tabela de preço."}}},"description":"Lista de tabelas de preço."},"info":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração."},"hInc":{"type":"string","description":"Hora da Inclusão. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração."},"uInc":{"type":"string","description":"Usuário da Inclusão. Não deve ser informado na Inclusão/Alteração."},"dAlt":{"type":"string","description":"Data da Alteração. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração."},"hAlt":{"type":"string","description":"Hora da Alteração. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração."},"uAlt":{"type":"string","description":"Usuário da Alteração. Não deve ser informado na Inclusão/Alteração."},"cImpAPI":{"type":"string","description":"Importado pela API (S/N). Não deve ser informado na Inclusão/Alteração."}},"description":"Informações complemetares do cadastro do produto."},"exibir_descricao_nfe":{"type":"string","description":"Indica se a Descrição Detalhada deve ser exibida nas Informações Adicionais do Item da NF-e (S/N)."},"exibir_descricao_pedido":{"type":"string","description":"Indica se a Descrição Detalhada deve ser exibida na impressão do Pedido (S/N)."},"medicamento":{"type":"object","properties":{"cod_anvisa":{"type":"string","description":"Código de produto Anvisa"},"preco_max_cons":{"type":"decimal","description":"Preço máximo consumidor"}},"description":"Detalhamento específico para cadastro de medicamentos Obrigatório o preenchimento no caso de medicamentos e produtos farmacêuticos"},"combustivel":{"type":"object","properties":{"codigo_anp":{"type":"string","description":"Código de Produto da ANP."},"descr_anp":{"type":"string","description":"Descrição do Produto conforme ANP."},"percent_glp":{"type":"decimal","description":"Percentual de GLP Derivado do Petróleo."},"percent_gas_nac":{"type":"decimal","description":"Percentual de Gás Natural Nacional."},"percent_gas_imp":{"type":"decimal","description":"Percentual de Gás Natural Importado."},"valor_part":{"type":"decimal","description":"Valor de partida"}},"description":"Detalhamento específico para cadastro de combustíveis."},"veiculo":{"type":"object","properties":{"ano_fabr":{"type":"string"},"ano_modelo":{"type":"string","description":"Ano modelo de fabricação"},"chassi":{"type":"string","description":"Chassi do veículo"},"cilin":{"type":"string","description":"Cilindradas"},"cmt":{"type":"string","description":"Capacidade máxima de tração"},"cond_veic":{"type":"string","description":"Condição do veículo"},"cod_cor_veic":{"type":"string","description":"Código da cor do veículo"},"cod_cor_den":{"type":"string","description":"Código da cor DENATRAN"},"descr_cor":{"type":"string","description":"Descrição da cor"},"dist_eixo":{"type":"string","description":"Distância entre eixos"},"especie_veic":{"type":"string","description":"Espécie do veículo"},"lota_max":{"type":"string","description":"Capacidade máxima de lotação"},"cod_modelo":{"type":"string","description":"Código marca modelo"},"motor":{"type":"string","description":"Número do motor"},"peso_bruto_veic":{"type":"string","description":"Peso bruto"},"peso_liquido_veic":{"type":"string","description":"Peso líquido"},"potencia":{"type":"string","description":"Potência motor"},"serie_veic":{"type":"string","description":"Série do veículo"},"tipo_comb":{"type":"string","description":"Tipo de combustível"},"tipo_oper":{"type":"string","description":"Tipo da operação"},"tipo_pintura":{"type":"string","description":"Tipo de pintura"},"tipo_restricao":{"type":"string","description":"Restrição"},"tipo_veic":{"type":"string","description":"Tipo de veículo de acordo com a tabela RENAVAM"},"cond_vin":{"type":"string","description":"Condição do VIN"}},"description":"Detalhamento específico para cadastro de veículos"},"armamento":{"type":"object","properties":{"serie_cano":{"type":"string","description":"Número de série do cano"},"descr_arma":{"type":"string","description":"Descrição completa da arma"},"serie_arma":{"type":"string","description":"Número de série da arma"},"tipo_arma":{"type":"string","description":"Indicador do tipo de arma de fogo"}},"description":"Detalhamento especifco para cadastro de armamentos. Descrição completa da arma, de modo a permitir sua perfeita identificação."},"cst_icms":{"type":"string","description":"Código da Situação Tributária do ICMS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"modalidade_icms":{"type":"string","description":"Modalidade da Base de Cálculo do ICMS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"csosn_icms":{"type":"string","description":"Código da Situação Tributária para Simples Nacional. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"aliquota_icms":{"type":"decimal","description":"Alíquota de ICMS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"red_base_icms":{"type":"decimal","description":"Percentual de redução de base do ICMS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"motivo_deson_icms":{"type":"string","description":"Motivo da desoneração do ICMS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"per_icms_fcp":{"type":"decimal","description":"Percentual do Fundo de Combate a Pobreza do ICMS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"codigo_beneficio":{"type":"string","description":"Código do Beneficio Fiscal. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"cst_pis":{"type":"string","description":"Código da Situação Tributária do PIS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"aliquota_pis":{"type":"decimal","description":"Alíquota do PIS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"red_base_pis":{"type":"decimal","description":"Percentual de redução de base do PIS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"cst_cofins":{"type":"string","description":"Código da Situação Tributária do COFINS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"aliquota_cofins":{"type":"decimal","description":"Alíquota do COFINS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"red_base_cofins":{"type":"decimal","description":"Percentual de redução de base do COFINS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"cfop":{"type":"string","description":"CFOP do Produto. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"dadosIbpt":{"type":"object","properties":{"aliqFederal":{"type":"decimal","description":"Carga tributária federal para os produtos nacionais. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV."},"aliqEstadual":{"type":"decimal","description":"Carga tributária estadual. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV."},"aliqMunicipal":{"type":"decimal","description":"Carga tributária municipal. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV."},"fonte":{"type":"string","description":"Fonte do IBPT. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV."},"chave":{"type":"string","description":"Número da versão do arquivo do IBPT. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV."},"versao":{"type":"string","description":"Versão da Tabela IBPT. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV."},"valido_de":{"type":"string","description":"Tabela do IBPT válilda a partir da data. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV."},"valido_ate":{"type":"string","description":"Tabela do IBPT valida até a data. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV."}},"description":"Dados do IBPT. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV."},"codInt_familia":{"type":"string","description":"Código de Integração da Familia do Produto. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV."},"descricao_familia":{"type":"string","description":"Descrição da Familia do Produto. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV."},"bloqueado":{"type":"string","description":"Indica se o registro está bloqueado (S/N)."},"bloquear_exclusao":{"type":"string","description":"Indica se a exclusão do registro está bloqueada (S/N)."},"importado_api":{"type":"string","description":"Indica se o registro foi incluído via API (S/N). Não deve ser informado na Inclusão/Alteração."},"inativo":{"type":"string","description":"Indica se o cadastro do produto está inativo (S/N). Não deve ser informado na Inclusão/Alteração."},"componentes_kit":{"type":"array","items":{"type":"object","properties":{"codigo_componente":{"type":"integer","description":"Identificação do componente do KIT, deve ser utilizado para Alterar e Excluir o componente. Não deve ser informado na inclusão. Esse código não aparece na tela do Omie."},"codigo_produto_componente":{"type":"integer","description":"Código do produto componente. (Código interno utilizado apenas na API). Esse código não aparece na tela do Omie."},"quantidade_componente":{"type":"decimal","description":"Quantidade do componente."},"valor_unitario_componente":{"type":"decimal","description":"Valor unitário do componente."},"local_estoque_componente":{"type":"integer","description":"Local estoque do componente."}}},"description":"Componetes do KIT."},"lead_time":{"type":"integer","description":"Lead Time médio de ressuprimento em dias."},"aliquota_ibpt":{"type":"decimal","description":"DEPRECATED."},"cest":{"type":"string","description":"DEPRECATED."},"quantidade_estoque":{"type":"decimal","description":"DEPRECATED."},"estoque_minimo":{"type":"decimal","description":"DEPRECATED."},"origem_imposto":{"type":"string","description":"Origem do Imposto \"NCM\" ou \"PRD\" Esse campo não deve ser informado na inclusão ou alteração. Finalidade: Indicar se a regra de imposto utilizada pelos PDV\"s foi originada de uma configuração pelo NCM ou por uma configuração específica para o produto."},"cst_ibs_cbs":{"type":"string","description":"Código de Situação Tributária do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"class_trib":{"type":"string","description":"Código de Classificação Tributária do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"aliquota_ibs_uf":{"type":"decimal","description":"Alíquota do IBS de competência das UF. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"aliquota_ibs_mun":{"type":"decimal","description":"Alíquota do IBS de competência do Município. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"perc_reducao_ibs_uf":{"type":"decimal","description":"Percentual da redução de alíquota do IBS UF. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"perc_reducao_ibs_mun":{"type":"decimal","description":"Percentual da redução de alíquota IBS UF. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"aliquota_cbs":{"type":"decimal","description":"Alíquota da CBS. Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."},"perc_reducao_cbs":{"type":"decimal","description":"Percentual da redução de alíquota da CBS Não deve ser informado na Inclusão/Alteração. Informação retornada apenas para consultas do PDV. Utiliza o Cenário de Impostos Padrão."}}},"description":"Cadastro completo de produtos"}},"title":"ListarProdutos (retorno)"},"geral_produtos_ListarProdutosResumido":{"type":"object","title":"ListarProdutosResumido","description":"Lista os produtos cadastrados","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarProdutosResumido"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados.\n\nDefault 1."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 500.\n\nDefault 50."},"apenas_importado_api":{"type":"string","maxLength":1,"description":"Exibir apenas os registros gerados pela API.\n\n\n\nPreencher com \"S\" ou \"N\"."},"ordenar_por":{"type":"string","maxLength":100,"description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente (S/N).\n\n\nPreencher com \"S\" ou \"N\"."},"filtrar_por_data_de":{"type":"string","maxLength":10,"description":"Filtrar os registros a partir de uma data.\n\n\nFormato: \"dd/mm/aaaa\""},"filtrar_por_hora_de":{"type":"string","maxLength":8,"description":"Filtrar a partir da hora.\n\n\nFormato: \"hh:mm:ss\""},"filtrar_por_data_ate":{"type":"string","maxLength":10,"description":"Filtrar os registros até uma data.\n\n\nFormato: \"dd/mm/aaaa\""},"filtrar_por_hora_ate":{"type":"string","maxLength":8,"description":"Filtrar até a hora.\n\n\nFormato: \"hh:mm:ss\""},"filtrar_apenas_inclusao":{"type":"string","maxLength":1,"description":"Filtrar apenas os registros incluídos (S/N).\n\n\nPreencher com \"S\" ou \"N\"."},"filtrar_apenas_alteracao":{"type":"string","maxLength":1,"description":"Filtrar apenas os registros alterados (S/N).\n\n\nPreencher com \"S\" ou \"N\"."},"filtrar_apenas_omiepdv":{"type":"string","maxLength":1,"description":"Filtrar apenas produtos marcados para venda via PDV.\n\nATENÇÃO:\nTodos os PDVs integrados devem preencher esse campo com \"S\".\nO preenchimento desse campo é obrigatório e o seu padrão é \"S\".\nQuando preenchido como \"S\" filtra apenas o produtos que tenham configuração de impostos definidas para o PDV.\n\n\nPreencher com \"S\" ou \"N\"."},"filtrar_apenas_familia":{"type":"string","maxLength":50,"description":"Filtrar por ID da Familia de Produto."},"filtrar_apenas_tipo":{"type":"string","maxLength":2,"description":"Código do Tipo do Item para o SPED.\n\n\nPode ser:\n\n00 - Mercadoria para Revenda\n01 - Matéria Prima\n02 - Embalagem\n03 - Produto em Processo\n04 - Produto Acabado\n05 - Subproduto\n06 - Produto Intermediário\n07 - Material de Uso e Consumo\n08 - Ativo Imobilizado\n09 - Serviços\n10 - Outros Insumos\n99 - Outras"},"filtrar_apenas_descricao":{"type":"string","maxLength":200,"description":"Filtro pela descrição do produto.\n\n\nPara filtrar utilize:\n\n\"TEXTO\" - Para pesquisa exata.\n\"TEXTO%\" - Para pesquisa começando com.\n\"%TEXTO\" - Para pesquisa terminando com.\n\"%TEXTO%\" - Para pesquisa contendo."},"filtrar_apenas_marketplace":{"type":"string","maxLength":1,"description":"Filtrar apenas produtos marcados para venda via Market Place ou e-Commerce.\n\n\nPreencher com \"S\" ou \"N\"."},"filtrar_apenas_pdv":{"type":"string","maxLength":1,"description":"Filtrar apenas produtos marcados para venda via Ponto de Venda (PDV).\n\n\nPreencher com \"S\" ou \"N\"."},"exibir_caracteristicas":{"type":"string","maxLength":1,"description":"Exibir as características do produto (S/N).\n\n\nPreencher com \"S\" ou \"N\"."},"exibir_tabelas_preco":{"type":"string","maxLength":1,"description":"Exibir as tabelas de preço do produto (S/N).\n\n\nPreencher com \"S\" ou \"N\"."},"caracteristicas":{"type":"array","items":{"type":"object","properties":{"nCodCaract":{"type":"integer","maxLength":15,"description":"Código da característica de produto.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno da característica do produto gerado pelo Omie."},"cCodIntCaract":{"type":"string","maxLength":20,"description":"Código de integração da característica do produto.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código da característica utilizado no seu aplicativo quando incluir uma característica no Omie.\nAssim, poderá utilizar esse campo para resgatar as informações da característica desejada.\nCaso informe esse campo, não informe a tag nCodCaract. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"cNomeCaract":{"type":"string","maxLength":30,"description":"Nome da característica."},"cConteudo":{"type":"string","maxLength":60,"description":"Conteúdo da característica."},"cExibirItemNF":{"type":"string","maxLength":1,"description":"Exibir esta característica no item da NF-e emitida (S/N)."},"cExibirItemPedido":{"type":"string","maxLength":1,"description":"Exibir esta característica no item do Pedido, Remessa ou Devolução (S/N)."},"cExibirOrdemProd":{"type":"string","maxLength":1,"description":"Exibe esta característica na Ordem de Produção e Mapa de Custo (S/N)."}}},"description":"lista de caracteristicas do produto."},"produtosPorCodigo":{"type":"array","items":{"type":"object","properties":{"codigo_produto":{"type":"integer","maxLength":15,"description":"(Código interno utilizado apenas na API).\nEsse código não aparece na tela do Omie.\nUtilize esse código para identificar um produto via API, para obter uma melhor performance.\nOpcionalmente você pode informar o código de integração para localizar um produto através do campo \"codigo_produto_integracao\"."},"codigo_produto_integracao":{"type":"string","maxLength":60,"description":"Código de integração do produto.\n(Utilizado para integração via API)\nEsse código não aparece na tela do Omie.\nUtilize esse campo quando incluir um produto e desejar associar o código do produto do seu aplicativo com o código de produto gerado pelo Omie.\nO preenchimento desse campo é obrigatório na inclusão e opcional para os demais métodos."},"codigo":{"type":"string","maxLength":60,"description":"Código do Produto.\nÉ o código do produto que é exibido na tela do Omie.\nNão utilize esse código para realizar a integração, ele tem função apenas informativa para o usuário e pode ser alterado a qualquer momento.\nPara integração utilize o código interno do produto através da tag \"codigo_produto\"."}},"required":["codigo_produto_integracao"]},"description":"Filtro por código do produto."},"inativo":{"type":"string","maxLength":1,"description":"Indica se o cadastro do produto está inativo (S/N).\n\nNão deve ser informado na Inclusão/Alteração."},"ncm":{"type":"string","maxLength":13,"description":"Código da Nomenclatura Comum do Mercosul (NCM)."},"ean":{"type":"string","maxLength":14,"description":"Código EAN (GTIN - Global Trade Item Number)."},"ordem_descrescente":{"type":"string","maxLength":1,"description":"DEPRECATED."},"exibir_obs":{"type":"string","maxLength":1,"description":"Exibir as observações do produto (S/N).\n\n\nPreencher com \"S\" ou \"N\"."},"exibir_kit":{"type":"string","maxLength":1,"description":"Exibir os componentes do KIT (S/N).\n\n\nPreencher com \"S\" ou \"N\"."},"exibir_info_variacoes":{"type":"string","maxLength":1,"description":"Opcional. Indica se deve retornar informações sobre as variações de produto.\n\nPreencher com S/N.\n\nDisponível apenas para o método ListarProdutos."}},"required":["filtrar_apenas_omiepdv"]}}},"example":{"call":"ListarProdutosResumido","param":[{"pagina":1,"registros_por_pagina":50,"apenas_importado_api":"N","filtrar_apenas_omiepdv":"N"}]}},"geral_produtos_ListarProdutosResumido_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada"},"total_de_paginas":{"type":"integer","description":"Número total de páginas"},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"total de registros encontrados"},"produto_servico_resumido":{"type":"array","items":{"type":"object","properties":{"codigo_produto":{"type":"integer","description":"Código do produto. (Código interno utilizado apenas na API). Esse código não aparece na tela do Omie. Utilize esse código para identificar um produto via API, para obter uma melhor performance. Opcionalmente você pode informar o código de integração para localizar um produto através do campo \"codigo_produto_integracao\"."},"codigo_produto_integracao":{"type":"string","description":"Código de integração do produto. Código de integração do produto. (Utilizado para integração via API) Esse código não aparece na tela do Omie. Utilize esse campo quando incluir um produto e desejar associar o código do produto do seu aplicativo com o código de produto gerado pelo Omie. O preenchimento desse campo é obrigatório na inclusão e opcional para os demais métodos."},"codigo":{"type":"string","description":"Código do Produto. É o código do produto que é exibido na tela do Omie. Não utilize esse código para realizar a integração, ele tem função apenas informativa para o usuário e pode ser alterado a qualquer momento. Para integração utilize o código interno do produto através da tag \"codigo_produto\"."},"descricao":{"type":"string","description":"Descrição do produto"},"valor_unitario":{"type":"decimal","description":"Valor Unitário do produto"}}},"description":"Cadastro reduzido de produtos"}},"title":"ListarProdutosResumido (retorno)"},"geral_produtos_UpsertProduto":{"type":"object","title":"UpsertProduto","description":"Realiza a inclusão/alteração de produtos.","required":["call","param"],"properties":{"call":{"type":"string","enum":["UpsertProduto"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_produto":{"type":"integer","maxLength":15,"description":"Código do produto.\nÉ o ID do produto e será utilizado apenas nas APIs como chave principal para localizar um produto.\n\nQuando um produto for incluído via API, você receberá um ID para esse novo produto.\nRecomendamos que você guarde essa informação no aplicativo que estiver integrando.\n\nEsse campo não deve ser informado na inclusão de produtos.\n\nEssa informação não será exibida nas telas do Omie."},"codigo_produto_integracao":{"type":"string","maxLength":60,"description":"Código de integração do produto.\nÉ o código do produto no aplicativo que você está integrando ao Omie.\nÉ utilizado basicamente na Inclusão de Produtos via API, para evitar duplicidade de cadastros.\n\nQuando um produto for incluído via API, você receberá um ID para esse novo produto.\nRecomendamos que você guarde essa informação no aplicativo que estiver integrando.\n\nO preenchimento desse campo é obrigatório na inclusão de produtos.\n\nEssa informação não será exibida nas telas do Omie."},"codigo":{"type":"string","maxLength":60,"description":"Código do Produto.\n\nÉ um código único que identifica o produto no Omie. Se você tem um código SKU (Stock Keeping Unit = Unidade de Manutenção de Estoque) é aqui que ele deve ser informado, pois é essa informação que será exibida na tela do Omie.\n\nNão recomendamos que ele seja utilizado como chave para integração, pois pode ser modificado pelo usuário a qualquer momento. No lugar deste campo, utilize o ID do produto, que você encontra na tag \"codigo_produto\"."},"descricao":{"type":"string","maxLength":120,"description":"Descrição do produto."},"unidade":{"type":"string","maxLength":6,"description":"Código da Unidade."},"ncm":{"type":"string","maxLength":13,"description":"Código da Nomenclatura Comum do Mercosul (NCM)."},"ean":{"type":"string","maxLength":14,"description":"Código EAN (GTIN - Global Trade Item Number)."},"valor_unitario":{"type":"number","maxLength":18,"description":"Preço Unitário de Venda."},"codigo_familia":{"type":"integer","maxLength":15,"description":"Código da Familia do Produto."},"tipoItem":{"type":"string","maxLength":2,"description":"Código do Tipo do Item para o SPED.\n\n\nPode ser:\n\n00 - Mercadoria para Revenda\n01 - Matéria Prima\n02 - Embalagem\n03 - Produto em Processo\n04 - Produto Acabado\n05 - Subproduto\n06 - Produto Intermediário\n07 - Material de Uso e Consumo\n08 - Ativo Imobilizado\n09 - Serviços\n10 - Outros Insumos\n99 - Outras"},"produto_variacao":{"type":"string","maxLength":1,"description":"Indica se o Produto Possui Variações.\n\nCampo disponível apenas para consulta.\n\n(S/N) ."},"produto_lote":{"type":"string","maxLength":1,"description":"Indica se o produto possui lote.\n(S/N) ."},"variacao":{"type":"string","maxLength":1,"description":"Indica se o Produto é uma variação de produto.\n(S/N) .\n\nNo método ListarProdutos, esse campo só será exibido se a tag 'exibir_info_variacoes' for enviada como 'S'."},"id_produto_variacao":{"type":"integer","maxLength":15,"description":"Código interno do produto variação que deu origem a variação.\n\nCampo disponível apenas para consulta.\n\nNo método ListarProdutos, esse campo só será exibido se a tag 'exibir_info_variacoes' for enviada como 'S'."},"recomendacoes_fiscais":{"type":"object","properties":{"origem_mercadoria":{"type":"string","maxLength":1,"description":"Origem da Mercadoria.\n\n\nPode ser:\n0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8\n1 - Estrangeira - Importação direta, exceto a indicada no código 6\n2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7\n3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40% e inferior ou igual a 70\n4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes\n5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40\n6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural\n7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante em lista da CAMEX e gás natural\n8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70"},"id_preco_tabelado":{"type":"integer","maxLength":15,"description":"ID do Preço tabelado (Pauta)."},"id_cest":{"type":"string","maxLength":9,"description":"Código do CEST.\n(Código Especificador da Substituíção Tributária).\n\n\nFormato: 99.999.99"},"cupom_fiscal":{"type":"string","maxLength":1,"description":"Indica se o produto é comercializado via PDV.\n\nAtravés de emissão de Cupom Fiscal ECF, SAT ou NFC-e.\n\n\nPreencher com \"S\" ou \"N\"."},"market_place":{"type":"string","maxLength":1,"description":"Indica se o produto será comercializado via Market Place ou e-commerce (S/N)\n\n\nPreencher com \"S\" ou \"N\"."},"indicador_escala":{"type":"string","maxLength":1,"description":"Indicador de Produção em Escala Relevante.\n\nPode ser:\n\"S\" para Produzido em Escala Relevante.\n\"N\" para Produzido em Escala NÃO Relevante."},"cnpj_fabricante":{"type":"string","maxLength":20,"description":"CNPJ do Fabricante da Mercadoria."}},"description":"Recomendações Fiscais."},"peso_liq":{"type":"number","maxLength":18,"description":"Peso Líquido (Kg).\n\n\nLocalizado na aba \"Informações Adicionais\""},"peso_bruto":{"type":"number","maxLength":18,"description":"Peso Bruto (Kg).\n\n\nLocalizado na aba \"Informações Adicionais\""},"altura":{"type":"number","maxLength":18,"description":"Altura (centimentos).\n\n\nLocalizado na aba \"Informações Adicionais\""},"largura":{"type":"number","maxLength":18,"description":"Largura (centimetros)\n\n\nLocalizado na aba \"Informações Adicionais\""},"profundidade":{"type":"number","maxLength":18,"description":"Profundidade (centimetros).\n\n\nLocalizado na aba \"Informações Adicionais\""},"marca":{"type":"string","maxLength":60,"description":"Marca.\n\n\nLocalizado na aba \"Informações Adicionais\""},"modelo":{"type":"string","maxLength":60,"description":"Modelo.\n\n\nLocalizado na aba \"Informações Adicionais\""},"dias_garantia":{"type":"integer","maxLength":4,"description":"Dias de Garantia.\n\n\nLocalizado na aba \"Informações Adicionais\""},"dias_crossdocking":{"type":"integer","maxLength":3,"description":"Dias de Crossdocking.\n\n\nLocalizado na aba \"Informações Adicionais\""},"descr_detalhada":{"type":"string","description":"Descrição Detalhada para o Produto."},"obs_internas":{"type":"string","description":"Observações Internas.\n(ficam registradas apenas no cadastro do produto)."},"imagens":{"type":"array","items":{"type":"object","properties":{"url_imagem":{"type":"string","description":"URL da Imagem do produto."}}},"description":"Lista de imagens do produto."},"videos":{"type":"array","items":{"type":"object","properties":{"url_video":{"type":"string","description":"URL do Video do produto."}}},"description":"Lista de videos do produto."},"caracteristicas":{"type":"array","items":{"type":"object","properties":{"nCodCaract":{"type":"integer","maxLength":15,"description":"Código da característica de produto.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno da característica do produto gerado pelo Omie."},"cCodIntCaract":{"type":"string","maxLength":20,"description":"Código de integração da característica do produto.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código da característica utilizado no seu aplicativo quando incluir uma característica no Omie.\nAssim, poderá utilizar esse campo para resgatar as informações da característica desejada.\nCaso informe esse campo, não informe a tag nCodCaract. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"cNomeCaract":{"type":"string","maxLength":30,"description":"Nome da característica."},"cConteudo":{"type":"string","maxLength":60,"description":"Conteúdo da característica."},"cExibirItemNF":{"type":"string","maxLength":1,"description":"Exibir esta característica no item da NF-e emitida (S/N)."},"cExibirItemPedido":{"type":"string","maxLength":1,"description":"Exibir esta característica no item do Pedido, Remessa ou Devolução (S/N)."},"cExibirOrdemProd":{"type":"string","maxLength":1,"description":"Exibe esta característica na Ordem de Produção e Mapa de Custo (S/N)."}}},"description":"lista de caracteristicas do produto."},"tabelas_preco":{"type":"array","items":{"type":"object","properties":{"nCodTabPreco":{"type":"integer","maxLength":15,"description":"Id da tabela de preço."},"cNomeTabPreco":{"type":"string","maxLength":50,"description":"Nome da tabela de preço."},"nValorTabPreco":{"type":"number","maxLength":18,"description":"Valor do produto na tabela de preço."}}},"description":"Lista de tabelas de preço."},"info":{"type":"object","properties":{"dInc":{"type":"string","maxLength":10,"description":"Data da Inclusão.\nNo formato dd/mm/aaaa.\n\nNão deve ser informado na Inclusão/Alteração."},"hInc":{"type":"string","maxLength":8,"description":"Hora da Inclusão.\nNo formato hh:mm:ss.\n\nNão deve ser informado na Inclusão/Alteração."},"uInc":{"type":"string","maxLength":10,"description":"Usuário da Inclusão.\n\nNão deve ser informado na Inclusão/Alteração."},"dAlt":{"type":"string","maxLength":10,"description":"Data da Alteração.\nNo formato dd/mm/aaaa.\n\nNão deve ser informado na Inclusão/Alteração."},"hAlt":{"type":"string","maxLength":8,"description":"Hora da Alteração.\nNo formato hh:mm:ss.\n\nNão deve ser informado na Inclusão/Alteração."},"uAlt":{"type":"string","maxLength":10,"description":"Usuário da Alteração.\n\nNão deve ser informado na Inclusão/Alteração."},"cImpAPI":{"type":"string","maxLength":1,"description":"Importado pela API (S/N).\n\nNão deve ser informado na Inclusão/Alteração."}},"description":"Informações complemetares do cadastro do produto."},"exibir_descricao_nfe":{"type":"string","maxLength":1,"description":"Indica se a Descrição Detalhada deve ser exibida nas Informações Adicionais do Item da NF-e (S/N)."},"exibir_descricao_pedido":{"type":"string","maxLength":1,"description":"Indica se a Descrição Detalhada deve ser exibida na impressão do Pedido (S/N)."},"medicamento":{"type":"object","properties":{"cod_anvisa":{"type":"string","maxLength":13,"description":"Código de produto Anvisa"},"preco_max_cons":{"type":"number","maxLength":15,"description":"Preço máximo consumidor"}},"description":"Detalhamento específico para cadastro de medicamentos\n\nObrigatório o preenchimento no caso de medicamentos e produtos farmacêuticos"},"combustivel":{"type":"object","properties":{"codigo_anp":{"type":"string","maxLength":9,"description":"Código de Produto da ANP."},"descr_anp":{"type":"string","maxLength":95,"description":"Descrição do Produto conforme ANP."},"percent_glp":{"type":"number","description":"Percentual de GLP Derivado do Petróleo."},"percent_gas_nac":{"type":"number","maxLength":9,"description":"Percentual de Gás Natural Nacional."},"percent_gas_imp":{"type":"number","description":"Percentual de Gás Natural Importado."},"valor_part":{"type":"number","description":"Valor de partida"}},"description":"Detalhamento específico para cadastro de combustíveis."},"veiculo":{"type":"object","properties":{"ano_fabr":{"type":"string","maxLength":4},"ano_modelo":{"type":"string","maxLength":4,"description":"Ano modelo de fabricação"},"chassi":{"type":"string","maxLength":17,"description":"Chassi do veículo"},"cilin":{"type":"string","maxLength":4,"description":"Cilindradas"},"cmt":{"type":"string","maxLength":9,"description":"Capacidade máxima de tração"},"cond_veic":{"type":"string","maxLength":1,"description":"Condição do veículo"},"cod_cor_veic":{"type":"string","maxLength":4,"description":"Código da cor do veículo"},"cod_cor_den":{"type":"string","maxLength":2,"description":"Código da cor DENATRAN"},"descr_cor":{"type":"string","maxLength":40,"description":"Descrição da cor"},"dist_eixo":{"type":"string","maxLength":4,"description":"Distância entre eixos"},"especie_veic":{"type":"string","maxLength":1,"description":"Espécie do veículo"},"lota_max":{"type":"string","maxLength":3,"description":"Capacidade máxima de lotação"},"cod_modelo":{"type":"string","maxLength":6,"description":"Código marca modelo"},"motor":{"type":"string","maxLength":21,"description":"Número do motor"},"peso_bruto_veic":{"type":"string","maxLength":9,"description":"Peso bruto"},"peso_liquido_veic":{"type":"string","maxLength":9,"description":"Peso líquido"},"potencia":{"type":"string","maxLength":4,"description":"Potência motor"},"serie_veic":{"type":"string","maxLength":9,"description":"Série do veículo"},"tipo_comb":{"type":"string","maxLength":2,"description":"Tipo de combustível"},"tipo_oper":{"type":"string","maxLength":1,"description":"Tipo da operação"},"tipo_pintura":{"type":"string","maxLength":1,"description":"Tipo de pintura"},"tipo_restricao":{"type":"string","maxLength":1,"description":"Restrição"},"tipo_veic":{"type":"string","maxLength":2,"description":"Tipo de veículo de acordo com a tabela RENAVAM"},"cond_vin":{"type":"string","maxLength":1,"description":"Condição do VIN"}},"description":"Detalhamento específico para cadastro de veículos"},"armamento":{"type":"object","properties":{"serie_cano":{"type":"string","maxLength":15,"description":"Número de série do cano"},"descr_arma":{"type":"string","maxLength":256,"description":"Descrição completa da arma"},"serie_arma":{"type":"string","maxLength":15,"description":"Número de série da arma"},"tipo_arma":{"type":"string","maxLength":1,"description":"Indicador do tipo de arma de fogo"}},"description":"Detalhamento especifco para cadastro de armamentos.\n\nDescrição completa da arma, de modo a permitir sua perfeita identificação."},"cst_icms":{"type":"string","maxLength":2,"description":"Código da Situação Tributária do ICMS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"modalidade_icms":{"type":"string","maxLength":1,"description":"Modalidade da Base de Cálculo do ICMS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"csosn_icms":{"type":"string","maxLength":3,"description":"Código da Situação Tributária para Simples Nacional.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"aliquota_icms":{"type":"number","description":"Alíquota de ICMS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"red_base_icms":{"type":"number","maxLength":10,"description":"Percentual de redução de base do ICMS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"motivo_deson_icms":{"type":"string","maxLength":2,"description":"Motivo da desoneração do ICMS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"per_icms_fcp":{"type":"number","maxLength":10,"description":"Percentual do Fundo de Combate a Pobreza do ICMS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"codigo_beneficio":{"type":"string","maxLength":20,"description":"Código do Beneficio Fiscal.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"cst_pis":{"type":"string","maxLength":2,"description":"Código da Situação Tributária do PIS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"aliquota_pis":{"type":"number","maxLength":10,"description":"Alíquota do PIS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"red_base_pis":{"type":"number","maxLength":10,"description":"Percentual de redução de base do PIS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"cst_cofins":{"type":"string","maxLength":2,"description":"Código da Situação Tributária do COFINS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"aliquota_cofins":{"type":"number","maxLength":10,"description":"Alíquota do COFINS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"red_base_cofins":{"type":"number","description":"Percentual de redução de base do COFINS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"cfop":{"type":"string","maxLength":10,"description":"CFOP do Produto.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"dadosIbpt":{"type":"object","properties":{"aliqFederal":{"type":"number","maxLength":10,"description":"Carga tributária federal para os produtos nacionais.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV."},"aliqEstadual":{"type":"number","maxLength":10,"description":"Carga tributária estadual.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV."},"aliqMunicipal":{"type":"number","maxLength":10,"description":"Carga tributária municipal.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV."},"fonte":{"type":"string","maxLength":34,"description":"Fonte do IBPT.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV."},"chave":{"type":"string","maxLength":6,"description":"Número da versão do arquivo do IBPT.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV."},"versao":{"type":"string","maxLength":6,"description":"Versão da Tabela IBPT.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV."},"valido_de":{"type":"string","maxLength":10,"description":"Tabela do IBPT válilda a partir da data.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV."},"valido_ate":{"type":"string","maxLength":10,"description":"Tabela do IBPT valida até a data.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV."}},"description":"Dados do IBPT.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV."},"codInt_familia":{"type":"string","maxLength":20,"description":"Código de Integração da Familia do Produto.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV."},"descricao_familia":{"type":"string","maxLength":50,"description":"Descrição da Familia do Produto.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV."},"bloqueado":{"type":"string","maxLength":1,"description":"Indica se o registro está bloqueado (S/N)."},"bloquear_exclusao":{"type":"string","maxLength":1,"description":"Indica se a exclusão do registro está bloqueada (S/N)."},"importado_api":{"type":"string","maxLength":1,"description":"Indica se o registro foi incluído via API (S/N).\n\nNão deve ser informado na Inclusão/Alteração."},"inativo":{"type":"string","maxLength":1,"description":"Indica se o cadastro do produto está inativo (S/N).\n\nNão deve ser informado na Inclusão/Alteração."},"componentes_kit":{"type":"array","items":{"type":"object","properties":{"codigo_componente":{"type":"integer","maxLength":15,"description":"Identificação do componente do KIT, deve ser utilizado para Alterar e Excluir o componente.\n\nNão deve ser informado na inclusão.\n\nEsse código não aparece na tela do Omie."},"codigo_produto_componente":{"type":"integer","maxLength":15,"description":"Código do produto componente.\n(Código interno utilizado apenas na API).\nEsse código não aparece na tela do Omie."},"quantidade_componente":{"type":"number","maxLength":10,"description":"Quantidade do componente."},"valor_unitario_componente":{"type":"number","maxLength":18,"description":"Valor unitário do componente."},"local_estoque_componente":{"type":"integer","maxLength":15,"description":"Local estoque do componente."}}},"description":"Componetes do KIT."},"lead_time":{"type":"integer","maxLength":4,"description":"Lead Time médio de ressuprimento em dias."},"aliquota_ibpt":{"type":"number","description":"DEPRECATED."},"cest":{"type":"string","maxLength":9,"description":"DEPRECATED."},"quantidade_estoque":{"type":"number","maxLength":18,"description":"DEPRECATED."},"estoque_minimo":{"type":"number","maxLength":18,"description":"DEPRECATED."},"origem_imposto":{"type":"string","maxLength":10,"description":"Origem do Imposto\n\n\"NCM\" ou \"PRD\"\n\nEsse campo não deve ser informado na inclusão ou alteração.\n\nFinalidade: Indicar se a regra de imposto utilizada pelos PDV\"s foi originada de uma configuração pelo NCM ou por uma configuração específica para o produto."},"cst_ibs_cbs":{"type":"string","maxLength":3,"description":"Código de Situação Tributária do IBS e CBS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"class_trib":{"type":"string","maxLength":6,"description":"Código de Classificação Tributária do IBS e CBS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"aliquota_ibs_uf":{"type":"number","maxLength":7,"description":"Alíquota do IBS de competência das UF.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"aliquota_ibs_mun":{"type":"number","maxLength":7,"description":"Alíquota do IBS de competência do Município.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"perc_reducao_ibs_uf":{"type":"number","maxLength":7,"description":"Percentual da redução de alíquota do IBS UF.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"perc_reducao_ibs_mun":{"type":"number","maxLength":7,"description":"Percentual da redução de alíquota IBS UF.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"aliquota_cbs":{"type":"number","maxLength":7,"description":"Alíquota da CBS.\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."},"perc_reducao_cbs":{"type":"number","maxLength":7,"description":"Percentual da redução de alíquota da CBS\n\nNão deve ser informado na Inclusão/Alteração.\nInformação retornada apenas para consultas do PDV.\nUtiliza o Cenário de Impostos Padrão."}},"required":["codigo_produto_integracao","medicamento"]}}},"example":{"call":"UpsertProduto","param":[{"codigo_produto_integracao":"1790774103","codigo":"teste0001","descricao":"Produto de teste","unidade":"UN"}]}},"geral_produtos_UpsertProduto_retorno":{"type":"object","properties":{"codigo_produto":{"type":"integer","description":"Código do produto. (Código interno utilizado apenas na API). Esse código não aparece na tela do Omie. Utilize esse código para identificar um produto via API, para obter uma melhor performance. Opcionalmente você pode informar o código de integração para localizar um produto através do campo \"codigo_produto_integracao\"."},"codigo_produto_integracao":{"type":"string","description":"Código de integração do produto. (Utilizado para integração via API) Esse código não aparece na tela do Omie. Utilize esse campo quando incluir um produto e desejar associar o código do produto do seu aplicativo com o código de produto gerado pelo Omie. O preenchimento desse campo é obrigatório na inclusão e opcional para os demais métodos."},"codigo_status":{"type":"string"},"descricao_status":{"type":"string"}},"title":"UpsertProduto (retorno)"},"geral_produtoskit_AlterarComponentesKit":{"type":"object","title":"AlterarComponentesKit","description":"Inclui/Altera/Exclui os componentes do KIT.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarComponentesKit"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_produto":{"type":"integer","maxLength":15,"description":"ID do produto que irá receber os componentes do KIT.\n\n(utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno gerado pelo Omie ao cadastrar o produto.\n\nPara incluir componentes do KIT, o Tipo do Produto deve ser: \"KT - Kit\"."},"componentes_kit":{"type":"array","items":{"type":"object","properties":{"acao_componente":{"type":"string","maxLength":1,"description":"Indica se irá Incluir/Alterar ou Excluir o componente.\n\nPode ser:\n\n\"A\" - Alterar o componente.\n\"E\" - Excluir o componente\n\"I\" - Incluir o componente."},"codigo_componente":{"type":"integer","maxLength":15,"description":"Identificação do componente do KIT, deve ser utilizado para Alterar e Excluir o componente.\n\nNão deve ser informado na inclusão.\n\nEsse código não aparece na tela do Omie."},"codigo_produto_componente":{"type":"integer","maxLength":15,"description":"ID do produto que deseja Incluir ou Alterar no KIT.\n\n(utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno gerado pelo Omie ao cadastrar o produto."},"quantidade_componente":{"type":"number","maxLength":10,"description":"Quantidade do componente."},"valor_unitario_componente":{"type":"number","maxLength":18,"description":"Valor unitário do componente."},"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"ID do local de estoque\nCaso não seja informado será atribuido o local de estoque padrão.\n\nUtilize a tag \"codigo_local_estoque\" do método \"ListarLocaisEstoque\" da API:\nhttps://app.omie.com.br/api/v1/estoque/local/\npara obter essa informação."},"obs_componente":{"type":"string","description":"Observações do Componente."}},"required":["acao_componente"]},"description":"Lista de Componentes do KIT."}},"required":["codigo_produto"]}}},"example":{"call":"AlterarComponentesKit","param":[{"codigo_produto":0,"componentes_kit":[{"acao_componente":"I","codigo_componente":0,"codigo_produto_componente":0,"valor_unitario_componente":1.99,"quantidade_componente":1,"codigo_local_estoque":0}]}]}},"geral_produtoskit_AlterarComponentesKit_retorno":{"type":"object","properties":{"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro durante o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodigoStatus\"."},"codigo_produto":{"type":"integer","description":"ID do produto que irá receber os componentes do KIT. (utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno gerado pelo Omie ao cadastrar o produto. Para incluir componentes do KIT, o Tipo do Produto deve ser: \"KT - Kit\"."},"componentes_kit":{"type":"array","items":{"type":"object","properties":{"acao_componente":{"type":"string","description":"Indica se irá Incluir/Alterar ou Excluir o componente. Pode ser: \"A\" - Alterar o componente. \"E\" - Excluir o componente \"I\" - Incluir o componente."},"codigo_componente":{"type":"integer","description":"Identificação do componente do KIT, deve ser utilizado para Alterar e Excluir o componente. Não deve ser informado na inclusão. Esse código não aparece na tela do Omie."},"codigo_produto_componente":{"type":"integer","description":"ID do produto que deseja Incluir ou Alterar no KIT. (utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno gerado pelo Omie ao cadastrar o produto."},"quantidade_componente":{"type":"decimal","description":"Quantidade do componente."},"valor_unitario_componente":{"type":"decimal","description":"Valor unitário do componente."},"codigo_local_estoque":{"type":"integer","description":"ID do local de estoque Caso não seja informado será atribuido o local de estoque padrão. Utilize a tag \"codigo_local_estoque\" do método \"ListarLocaisEstoque\" da API: https://app.omie.com.br/api/v1/estoque/local/ para obter essa informação."},"obs_componente":{"type":"string","description":"Observações do Componente."}}},"description":"Lista de Componentes do KIT."}},"title":"AlterarComponentesKit (retorno)"},"geral_projetos_AlterarProjeto":{"type":"object","title":"AlterarProjeto","description":"Altera um projeto","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarProjeto"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo":{"type":"integer","maxLength":15,"description":"Código do projeto."},"codInt":{"type":"string","maxLength":20,"description":"Código de Integração do projeto."},"nome":{"type":"string","maxLength":70,"description":"Nome do projeto."},"inativo":{"type":"string","maxLength":1,"example":"S","description":"Projeto inativo (S/N)"}}}}},"example":{"call":"AlterarProjeto","param":[{"codigo":0,"codint":"123","nome":"","inativo":"N"}]}},"geral_projetos_AlterarProjeto_retorno":{"type":"object","properties":{"codigo":{"type":"integer","description":"Código do projeto."},"codInt":{"type":"string","description":"Código de Integração do projeto."},"status":{"type":"string","description":"Status do processamento"},"descricao":{"type":"string","description":"Descrição do status"}},"title":"AlterarProjeto (retorno)"},"geral_projetos_ConsultarProjeto":{"type":"object","title":"ConsultarProjeto","description":"Consulta um projeto","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarProjeto"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo":{"type":"integer","maxLength":15,"description":"Código do projeto."},"codInt":{"type":"string","maxLength":20,"description":"Código de Integração do projeto."}}}}},"example":{"call":"ConsultarProjeto","param":[{"codigo":0,"codint":"123"}]}},"geral_projetos_ConsultarProjeto_retorno":{"type":"object","properties":{"codigo":{"type":"integer","description":"Código do projeto."},"codInt":{"type":"string","description":"Código de Integração do projeto."},"nome":{"type":"string","description":"Nome do projeto."},"inativo":{"type":"string","description":"Projeto inativo [S/N]."},"info":{"type":"object","properties":{"data_inc":{"type":"string","description":"Data da Inclusão. No formato dd/mm/aaaa."},"hora_inc":{"type":"string","description":"Hora da Inclusão. No formato hh:mm:ss."},"user_inc":{"type":"string","description":"Usuário da Inclusão."},"data_alt":{"type":"string","description":"Data da Alteração. No formato dd/mm/aaaa."},"hora_alt":{"type":"string","description":"Hora da Alteração. No formato hh:mm:ss."},"user_alt":{"type":"string","description":"Usuário da Alteração."}}}},"title":"ConsultarProjeto (retorno)"},"geral_projetos_ExcluirProjeto":{"type":"object","title":"ExcluirProjeto","description":"Exclui um projeto","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirProjeto"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo":{"type":"integer","maxLength":15,"description":"Código do projeto."},"codInt":{"type":"string","maxLength":20,"description":"Código de Integração do projeto."}}}}},"example":{"call":"ExcluirProjeto","param":[{"codigo":0,"codint":"123"}]}},"geral_projetos_ExcluirProjeto_retorno":{"type":"object","properties":{"codigo":{"type":"integer","description":"Código do projeto."},"codInt":{"type":"string","description":"Código de Integração do projeto."},"status":{"type":"string","description":"Status do processamento"},"descricao":{"type":"string","description":"Descrição do status"}},"title":"ExcluirProjeto (retorno)"},"geral_projetos_IncluirProjeto":{"type":"object","title":"IncluirProjeto","description":"Inclui um novo projeto","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirProjeto"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codInt":{"type":"string","maxLength":20,"description":"Código de Integração do projeto."},"nome":{"type":"string","maxLength":70,"description":"Nome do projeto."},"inativo":{"type":"string","maxLength":1,"example":"S","description":"Projeto inativo (S/N)."}},"required":["codInt","nome"]}}},"example":{"call":"IncluirProjeto","param":[{"codint":"123","nome":"","inativo":"N"}]}},"geral_projetos_IncluirProjeto_retorno":{"type":"object","properties":{"codigo":{"type":"integer","description":"Código do projeto."},"codInt":{"type":"string","description":"Código de Integração do projeto."},"status":{"type":"string","description":"Status do processamento"},"descricao":{"type":"string","description":"Descrição do status"}},"title":"IncluirProjeto (retorno)"},"geral_projetos_ListarProjetos":{"type":"object","title":"ListarProjetos","description":"Lista os projetos cadastrados","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarProjetos"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15},"registros_por_pagina":{"type":"integer","maxLength":15},"apenas_importado_api":{"type":"string","maxLength":1},"ordenar_por":{"type":"string","maxLength":100},"ordem_descrescente":{"type":"string","maxLength":1},"filtrar_por_data_de":{"type":"string","maxLength":10},"filtrar_por_data_ate":{"type":"string","maxLength":10},"filtrar_apenas_inclusao":{"type":"string","maxLength":1},"filtrar_apenas_alteracao":{"type":"string","maxLength":1},"nome_projeto":{"type":"string","maxLength":100,"description":"Nome do projeto."}}}}},"example":{"call":"ListarProjetos","param":[{"pagina":1,"registros_por_pagina":50,"apenas_importado_api":"N"}]}},"geral_projetos_ListarProjetos_retorno":{"type":"object","properties":{"pagina":{"type":"integer"},"total_de_paginas":{"type":"integer"},"registros":{"type":"integer"},"total_de_registros":{"type":"integer"},"cadastro":{"type":"array","items":{"type":"object","properties":{"codigo":{"type":"integer","description":"Código do projeto."},"codInt":{"type":"string","description":"Código de Integração do projeto."},"nome":{"type":"string","description":"Nome do projeto."},"inativo":{"type":"string","description":"Projeto inativo [S/N]."},"info":{"type":"object","properties":{"data_inc":{"type":"string","description":"Data da Inclusão. No formato dd/mm/aaaa."},"hora_inc":{"type":"string","description":"Hora da Inclusão. No formato hh:mm:ss."},"user_inc":{"type":"string","description":"Usuário da Inclusão."},"data_alt":{"type":"string","description":"Data da Alteração. No formato dd/mm/aaaa."},"hora_alt":{"type":"string","description":"Hora da Alteração. No formato hh:mm:ss."},"user_alt":{"type":"string","description":"Usuário da Alteração."}}}}}}},"title":"ListarProjetos (retorno)"},"geral_projetos_UpsertProjeto":{"type":"object","title":"UpsertProjeto","description":"Inclui ou altera um projeto","required":["call","param"],"properties":{"call":{"type":"string","enum":["UpsertProjeto"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo":{"type":"integer","maxLength":15,"description":"Código do projeto."},"codInt":{"type":"string","maxLength":20,"description":"Código de Integração do projeto."},"nome":{"type":"string","maxLength":70,"description":"Nome do projeto."},"inativo":{"type":"string","maxLength":1,"example":"S","description":"Projeto inativo (S/N)"}}}}},"example":{"call":"UpsertProjeto","param":[{"codigo":0,"codint":"123","nome":"","inativo":"N"}]}},"geral_projetos_UpsertProjeto_retorno":{"type":"object","properties":{"codigo":{"type":"integer","description":"Código do projeto."},"codInt":{"type":"string","description":"Código de Integração do projeto."},"status":{"type":"string","description":"Status do processamento"},"descricao":{"type":"string","description":"Descrição do status"}},"title":"UpsertProjeto (retorno)"},"geral_tarefas_AlterarTarefa":{"type":"object","title":"AlterarTarefa","description":"Método para realizar a alteração de uma tarefa.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarTarefa"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodTarefa":{"type":"integer","maxLength":15,"description":"Código único da tarefa."},"cCodIntTarefa":{"type":"string","maxLength":20},"cDescricao":{"type":"string","description":"Descrição da tarefa."},"dData":{"type":"string"},"hHora":{"type":"string","maxLength":5},"cImportante":{"type":"string","maxLength":1,"example":"S","description":"Indica se a tarefa é importante (S/N)."},"cUrgente":{"type":"string","maxLength":1,"example":"S","description":"Indica se a tarefa é urgente (S/N)."},"cSituacao":{"type":"string","maxLength":40,"example":"pendente","description":"Situação da tarefa.\n\nPara métodos de criação e edição:\nComo default será utilizado \"Pendente\".\n\nPode ser:\n\npendente (Pendente)\nem-execucao (Em execução)\nrealizada (Realizada)"},"nCodAtividade":{"type":"integer","maxLength":15,"description":"Código do tipo de tarefa vinculado.\n\nPara métodos de criação e edição:\n\nPara obter os tipos de tarefa, utilize o método ObterTiposTarefa da API:\n/api/v1/geral/tipostarefa/"},"nCodNotif":{"type":"integer","maxLength":5,"description":"Código da notificação.\n\nPara métodos de criação e edição:\nComo default será utilizado \"Não notificar\".\n\n99999\t(Não notificar)\n15\t   (15 minutos antes)\n30\t   (30 minutos antes)\n60\t   (1 hora antes)\n120\t(2 horas antes)\n180\t(3 horas antes)\n1001\t(1 dia antes)\n1002\t(2 dias antes)\n1003\t(3 dias antes)\n2001\t(1 semana antes)\n2002\t(2 semanas antes)"},"nCodUserAtb":{"type":"integer","maxLength":15,"description":"Código do usuário atribuído.\n\nPara método de criação:\n\nPara método de edição:\n\nPara obter os possíveis usuários para alocar a tarefa, utilize o método ListarUsuarios da API:\n/api/v1/geral/usuarios/"}}}}},"example":{"call":"AlterarTarefa","param":[{"nCodTarefa":987654,"cDescricao":"Ligar para o cliente (remarcado)","dData":"21/10/2026","hHora":"10:00"}]}},"geral_tarefas_AlterarTarefa_retorno":{"type":"object","properties":{"cCodStatus":{"type":"string"},"cDesStatus":{"type":"string"},"nCodTarefa":{"type":"integer","description":"Código único da tarefa."}},"title":"AlterarTarefa (retorno)"},"geral_tarefas_ConsultarTarefa":{"type":"object","title":"ConsultarTarefa","description":"Método para realizar a consulta de uma tarefa.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarTarefa"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodTarefa":{"type":"integer","maxLength":15,"description":"Código único da tarefa."},"cCodIntTarefa":{"type":"string","maxLength":20}}}}},"example":{"call":"ConsultarTarefa","param":[{"nCodTarefa":987654}]}},"geral_tarefas_ConsultarTarefa_retorno":{"type":"object","properties":{"cCodStatus":{"type":"string"},"cDesStatus":{"type":"string"},"tarefa":{"type":"object","properties":{"nCodTarefa":{"type":"integer","description":"Código único da tarefa."},"cCodIntTarefa":{"type":"string"},"cOrigem":{"type":"string","description":"Origem da tarefa. Para método de criação: Pode ser: oportunidade geral cliente produto servico pedido-venda pedido-compra pedido-importacao contas-pagar contas-receber ordem-producao ordem-servico contrato-servico"},"nCodDoc":{"type":"integer","description":"Id do documento vinculado a tarefa. Esse campo varia conforme a origem da tarefa. Ele permite vincular a tarefa a um documento específico, seja ele relacionado a uma oportunidade, contas a pagar, contas a receber, entre outros. Exemplo: Se a origem da tarefa for \"pedido-compra\", esse campo reflete o código do pedido de compra. Se a origem da tarefa for \"contas-receber\", esse campo reflete o código da conta a receber. No cadastro de uma tarefa, quando a origem for \"geral\", não é permitido informar esse campo."},"cDescDoc":{"type":"string","description":"Descrição do documento vinculado a tarefa. Exemplo: Se a origem da tarefa for \"pedido-compra\", esse campo reflete a descrição do pedido de compra. Se a origem da tarefa for \"contas-receber\", esse campo reflete a descrição da conta a receber."},"cDescricao":{"type":"string","description":"Descrição da tarefa."},"dData":{"type":"string"},"hHora":{"type":"string"},"cImportante":{"type":"string","description":"Indica se a tarefa é importante (S/N)."},"cUrgente":{"type":"string","description":"Indica se a tarefa é urgente (S/N)."},"nCodSituacao":{"type":"integer","description":"Código da situação da tarefa."},"cSituacao":{"type":"string","description":"Situação da tarefa. Para métodos de criação e edição: Como default será utilizado \"Pendente\". Pode ser: pendente (Pendente) em-execucao (Em execução) realizada (Realizada)"},"nCodTipoTarefa":{"type":"integer","description":"Código do tipo de tarefa vinculado. Para métodos de criação e edição: Para obter os tipos de tarefa, utilize o método ObterTiposTarefa da API: /api/v1/geral/tipostarefa/"},"cDescTipoTarefa":{"type":"string"},"nCodNotif":{"type":"integer"},"cDescNotif":{"type":"string"},"nCodUserAtb":{"type":"integer","description":"Código do usuário atribuído. Para método de criação: Para método de edição: Para obter os possíveis usuários para alocar a tarefa, utilize o método ListarUsuarios da API: /api/v1/geral/usuarios/"},"cNomeUserAtb":{"type":"string"}}}},"title":"ConsultarTarefa (retorno)"},"geral_tarefas_ExcluirTarefa":{"type":"object","title":"ExcluirTarefa","description":"Método para realizar a exclusão de uma tarefa.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirTarefa"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodTarefa":{"type":"integer","maxLength":15,"description":"Código único da tarefa."},"cCodIntTarefa":{"type":"string","maxLength":20}}}}},"example":{"call":"ExcluirTarefa","param":[{"nCodTarefa":987654}]}},"geral_tarefas_ExcluirTarefa_retorno":{"type":"object","properties":{"cCodStatus":{"type":"string"},"cDesStatus":{"type":"string"}},"title":"ExcluirTarefa (retorno)"},"geral_tarefas_IncluirTarefa":{"type":"object","title":"IncluirTarefa","description":"Método para realizar a inclusão de uma tarefa.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirTarefa"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cCodIntTarefa":{"type":"string","maxLength":20},"cOrigem":{"type":"string","maxLength":20,"example":"oportunidade","description":"Origem da tarefa.\n\nPara método de criação:\n\nPode ser:\n\noportunidade\ngeral\ncliente\nproduto\nservico\npedido-venda\npedido-compra\npedido-importacao\ncontas-pagar\ncontas-receber\nordem-producao\nordem-servico\ncontrato-servico"},"nCodDoc":{"type":"integer","maxLength":15,"description":"Id do documento vinculado a tarefa.\n\nEsse campo varia conforme a origem da tarefa.\nEle permite vincular a tarefa a um documento específico, seja ele relacionado a uma oportunidade, contas a pagar, contas a receber, entre outros.\n\nExemplo:\nSe a origem da tarefa for \"pedido-compra\", esse campo reflete o código do pedido de compra.\nSe a origem da tarefa for \"contas-receber\", esse campo reflete o código da conta a receber.\n\nNo cadastro de uma tarefa, quando a origem for \"geral\", não é permitido informar esse campo."},"cDescricao":{"type":"string","description":"Descrição da tarefa."},"dData":{"type":"string"},"hHora":{"type":"string","maxLength":5},"cImportante":{"type":"string","maxLength":1,"example":"S","description":"Indica se a tarefa é importante (S/N)."},"cUrgente":{"type":"string","maxLength":1,"example":"S","description":"Indica se a tarefa é urgente (S/N)."},"cSituacao":{"type":"string","maxLength":40,"example":"pendente","description":"Situação da tarefa.\n\nPara métodos de criação e edição:\nComo default será utilizado \"Pendente\".\n\nPode ser:\n\npendente (Pendente)\nem-execucao (Em execução)\nrealizada (Realizada)"},"nCodAtividade":{"type":"integer","maxLength":15,"description":"Código do tipo de tarefa vinculado.\n\nPara métodos de criação e edição:\n\nPara obter os tipos de tarefa, utilize o método ObterTiposTarefa da API:\n/api/v1/geral/tipostarefa/"},"nCodNotif":{"type":"integer","maxLength":5,"description":"Código da notificação.\n\nPara métodos de criação e edição:\nComo default será utilizado \"Não notificar\".\n\n99999\t(Não notificar)\n15\t   (15 minutos antes)\n30\t   (30 minutos antes)\n60\t   (1 hora antes)\n120\t(2 horas antes)\n180\t(3 horas antes)\n1001\t(1 dia antes)\n1002\t(2 dias antes)\n1003\t(3 dias antes)\n2001\t(1 semana antes)\n2002\t(2 semanas antes)"},"nCodUserAtb":{"type":"integer","maxLength":15,"description":"Código do usuário atribuído.\n\nPara método de criação:\n\nPara método de edição:\n\nPara obter os possíveis usuários para alocar a tarefa, utilize o método ListarUsuarios da API:\n/api/v1/geral/usuarios/"}},"required":["cOrigem","dData","hHora","nCodUserAtb"]}}},"example":{"call":"IncluirTarefa","param":[{"cOrigem":"geral","cDescricao":"Ligar para o cliente","dData":"20/10/2026","hHora":"14:00","nCodUserAtb":123456}]}},"geral_tarefas_IncluirTarefa_retorno":{"type":"object","properties":{"cCodStatus":{"type":"string"},"cDesStatus":{"type":"string"},"nCodTarefa":{"type":"integer","description":"Código único da tarefa."}},"title":"IncluirTarefa (retorno)"},"geral_tarefas_ListarTarefas":{"type":"object","title":"ListarTarefas","description":"Método para realizar a listagem de tarefas cadastradas no ERP.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarTarefas"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15},"nRegPorPagina":{"type":"integer","maxLength":15},"cOrigem":{"type":"string","maxLength":20,"example":"oportunidade","description":"Origem da tarefa.\n\n\nPode ser:\n\noportunidade\ngeral\ncliente\nproduto\nservico\npedido-venda\npedido-compra\npedido-importacao\ncontas-pagar\ncontas-receber\nordem-producao\nordem-servico\ncontrato-servico"},"cImportante":{"type":"string","maxLength":1,"example":"S","description":"Indica se a tarefa é importante (S/N)."},"cUrgente":{"type":"string","maxLength":1,"example":"S","description":"Indica se a tarefa é urgente (S/N)."},"cSituacao":{"type":"string","maxLength":40,"example":"pendente","description":"Situação da tarefa.\n\nPara métodos de criação e edição:\nComo default será utilizado \"Pendente\".\n\nPode ser:\n\npendente (Pendente)\nem-execucao (Em execução)\nrealizada (Realizada)"},"cIntervalo":{"type":"string","maxLength":30,"example":"hoje","description":"Filtrar tarefas a partir de intervalos específicos.\n\nQuando preenchida essa tag, não informar as tags 'dDataInicial' e 'dDataFinal'\n\nPode ser:\n\nhoje\nsemana-atual\nproxima-semana\nmes (mês atual)"},"dDataInicial":{"type":"string","maxLength":10,"description":"Filtrar tarefas a partir dessa data"},"dDataFinal":{"type":"string","maxLength":10,"description":"Filtrar tarefas até essa data"},"cCriadasPorMim":{"type":"string","maxLength":1,"example":"S","description":"Indica se deve retornar apenas as tarefas criadas pelo usuário (S/N)."},"cAtribuidasAMim":{"type":"string","maxLength":1,"example":"S","description":"Indica se deve retornar apenas as tarefas atribuídas ao usuário (S/N)."},"nCodDoc":{"type":"integer","maxLength":15,"description":"Id do documento vinculado a tarefa.\n\nEsse campo varia conforme a origem da tarefa.\nEle permite vincular a tarefa a um documento específico, seja ele relacionado a uma oportunidade, contas a pagar, contas a receber, entre outros.\n\nExemplo:\nSe a origem da tarefa for \"pedido-compra\", esse campo reflete o código do pedido de compra.\nSe a origem da tarefa for \"contas-receber\", esse campo reflete o código da conta a receber.\n\nNo cadastro de uma tarefa, quando a origem for \"geral\", não é permitido informar esse campo."},"cOrdenarPor":{"type":"string","maxLength":100,"example":"codigo","description":"Ordem de exibição dos dados.\nQuando não preenchido o padrão será por código\n\nPode ser:\n\ncodigo\ncodint\ndata\ndescricao"},"cOrdemDesc":{"type":"string","maxLength":1,"example":"S","description":"Indica se a ordem de exibição é decrescente (S/N).\n\nCaso não informado, o padrão é \"N\"."}}}}},"example":{"call":"ListarTarefas","param":[{"nPagina":1,"nRegPorPagina":20,"cOrigem":"geral"}]}},"geral_tarefas_ListarTarefas_retorno":{"type":"object","properties":{"cCodStatus":{"type":"string"},"cDesStatus":{"type":"string"},"nPagina":{"type":"integer"},"nRegistros":{"type":"integer"},"nTotPaginas":{"type":"integer"},"nTotRegistros":{"type":"integer"},"listaTarefas":{"type":"array","items":{"type":"object","properties":{"nCodTarefa":{"type":"integer","description":"Código único da tarefa."},"cCodIntTarefa":{"type":"string"},"cOrigem":{"type":"string","description":"Origem da tarefa. Para método de criação: Pode ser: oportunidade geral cliente produto servico pedido-venda pedido-compra pedido-importacao contas-pagar contas-receber ordem-producao ordem-servico contrato-servico"},"nCodDoc":{"type":"integer","description":"Id do documento vinculado a tarefa. Esse campo varia conforme a origem da tarefa. Ele permite vincular a tarefa a um documento específico, seja ele relacionado a uma oportunidade, contas a pagar, contas a receber, entre outros. Exemplo: Se a origem da tarefa for \"pedido-compra\", esse campo reflete o código do pedido de compra. Se a origem da tarefa for \"contas-receber\", esse campo reflete o código da conta a receber. No cadastro de uma tarefa, quando a origem for \"geral\", não é permitido informar esse campo."},"cDescDoc":{"type":"string","description":"Descrição do documento vinculado a tarefa. Exemplo: Se a origem da tarefa for \"pedido-compra\", esse campo reflete a descrição do pedido de compra. Se a origem da tarefa for \"contas-receber\", esse campo reflete a descrição da conta a receber."},"cDescricao":{"type":"string","description":"Descrição da tarefa."},"dData":{"type":"string"},"hHora":{"type":"string"},"cImportante":{"type":"string","description":"Indica se a tarefa é importante (S/N)."},"cUrgente":{"type":"string","description":"Indica se a tarefa é urgente (S/N)."},"nCodSituacao":{"type":"integer","description":"Código da situação da tarefa."},"cSituacao":{"type":"string","description":"Situação da tarefa. Para métodos de criação e edição: Como default será utilizado \"Pendente\". Pode ser: pendente (Pendente) em-execucao (Em execução) realizada (Realizada)"},"nCodTipoTarefa":{"type":"integer","description":"Código do tipo de tarefa vinculado. Para métodos de criação e edição: Para obter os tipos de tarefa, utilize o método ObterTiposTarefa da API: /api/v1/geral/tipostarefa/"},"cDescTipoTarefa":{"type":"string"},"nCodNotif":{"type":"integer"},"cDescNotif":{"type":"string"},"nCodUserAtb":{"type":"integer","description":"Código do usuário atribuído. Para método de criação: Para método de edição: Para obter os possíveis usuários para alocar a tarefa, utilize o método ListarUsuarios da API: /api/v1/geral/usuarios/"},"cNomeUserAtb":{"type":"string"},"cDescOrigem":{"type":"string","description":"Nome da origem da tarefa"}}}}},"title":"ListarTarefas (retorno)"},"geral_tarefas_ObterCalendarioTarefas":{"type":"object","title":"ObterCalendarioTarefas","description":"Método para obter o calendário de tarefas no intervalo informado, retornando o resumo diário de tare","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterCalendarioTarefas"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"dDataInicial":{"type":"string","maxLength":10,"description":"Filtrar tarefas a partir dessa data"},"dDataFinal":{"type":"string","maxLength":10,"description":"Filtrar tarefas até essa data"},"cOrigem":{"type":"string","maxLength":20,"example":"oportunidade","description":"Origem da tarefa.\n\n\nPode ser:\n\noportunidade\ngeral\ncliente\nproduto\nservico\npedido-venda\npedido-compra\npedido-importacao\ncontas-pagar\ncontas-receber\nordem-producao\nordem-servico\ncontrato-servico"},"cCriadasPorMim":{"type":"string","maxLength":1,"example":"S","description":"Indica se deve retornar apenas as tarefas criadas pelo usuário (S/N)."},"cAtribuidasAMim":{"type":"string","maxLength":1,"example":"S","description":"Indica se deve retornar apenas as tarefas atribuídas ao usuário (S/N)."}},"required":["dDataFinal","dDataInicial"]}}},"example":{"call":"ObterCalendarioTarefas","param":[{"dDataInicial":"01/10/2026","dDataFinal":"31/10/2026"}]}},"geral_tarefas_ObterCalendarioTarefas_retorno":{"type":"object","properties":{"cCodStatus":{"type":"string"},"cDesStatus":{"type":"string"},"calendario":{"type":"array","items":{"type":"object","properties":{"dData":{"type":"string","description":"Data relacionada à consulta ou ao agrupamento de tarefas."},"nPendentes":{"type":"integer","description":"Número de tarefas pendentes para a data."},"nEmExecucao":{"type":"integer","description":"Número de tarefas em execução para a data."},"nConcluidas":{"type":"integer","description":"Número de tarefas concluídas para a data."},"cStatus":{"type":"string","description":"Status de situação geral para o dia. Pode ser: \"00\" - Nenhuma tarefa mapeada para essa data \"01\" - Possui tarefas pendentes/execução \"02\" - Possui tarefas pendentes/execução (atrasados - menor que a data atual) \"03\" - Todas tarefas já foram concluídas"}}}}},"title":"ObterCalendarioTarefas (retorno)"},"geral_tarefas_ObterResumoTarefas":{"type":"object","title":"ObterResumoTarefas","description":"Método para obter o resumo das tarefas.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterResumoTarefas"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cApenasResumo":{"type":"string","maxLength":1},"cOrigem":{"type":"string","maxLength":20,"example":"oportunidade","description":"Origem da tarefa.\n\n\nPode ser:\n\noportunidade\ngeral\ncliente\nproduto\nservico\npedido-venda\npedido-compra\npedido-importacao\ncontas-pagar\ncontas-receber\nordem-producao\nordem-servico\ncontrato-servico"},"cCriadasPorMim":{"type":"string","maxLength":1,"example":"S","description":"Indica se deve retornar apenas as tarefas criadas pelo usuário (S/N)."},"cAtribuidasAMim":{"type":"string","maxLength":1,"example":"S","description":"Indica se deve retornar apenas as tarefas atribuídas ao usuário (S/N)."}}}}},"example":{"call":"ObterResumoTarefas","param":[{"cOrigem":"geral"}]}},"geral_tarefas_ObterResumoTarefas_retorno":{"type":"object","properties":{"cCodStatus":{"type":"string"},"cDesStatus":{"type":"string"},"dData":{"type":"string","description":"Data relacionada à consulta ou ao agrupamento de tarefas."},"resumo":{"type":"object","properties":{"nHoje":{"type":"integer","description":"Número de tarefas de hoje."},"nSemanaAtual":{"type":"integer","description":"Número de tarefas da semana atual."},"nProximaSemana":{"type":"integer","description":"Número de tarefas da próxima semana."},"nMesAtual":{"type":"integer","description":"Número de tarefas do mês atual."}}}},"title":"ObterResumoTarefas (retorno)"},"geral_tarefas_ObterTotalTarefas":{"type":"object","title":"ObterTotalTarefas","description":"Método para obter o número de tarefas de acordo com a origem e documento.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterTotalTarefas"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cOrigem":{"type":"string","maxLength":20,"example":"oportunidade","description":"Origem da tarefa.\n\n\nPode ser:\n\noportunidade\ngeral\ncliente\nproduto\nservico\npedido-venda\npedido-compra\npedido-importacao\ncontas-pagar\ncontas-receber\nordem-producao\nordem-servico\ncontrato-servico"},"nCodDoc":{"type":"integer","maxLength":15,"description":"Id do documento vinculado a tarefa.\n\nEsse campo varia conforme a origem da tarefa.\nEle permite vincular a tarefa a um documento específico, seja ele relacionado a uma oportunidade, contas a pagar, contas a receber, entre outros.\n\nExemplo:\nSe a origem da tarefa for \"pedido-compra\", esse campo reflete o código do pedido de compra.\nSe a origem da tarefa for \"contas-receber\", esse campo reflete o código da conta a receber.\n\nNo cadastro de uma tarefa, quando a origem for \"geral\", não é permitido informar esse campo."}},"required":["cOrigem","nCodDoc"]}}},"example":{"call":"ObterTotalTarefas","param":[{"cOrigem":"geral","nCodDoc":987654}]}},"geral_tarefas_ObterTotalTarefas_retorno":{"type":"object","properties":{"cCodStatus":{"type":"string"},"cDesStatus":{"type":"string"},"nTarefas":{"type":"integer","description":"Número de tarefas."}},"title":"ObterTotalTarefas (retorno)"},"geral_tarefasorigem_ObterTarefasOrigem":{"type":"object","title":"ObterTarefasOrigem","description":"Método para realizar a listagem de origens de tarefas.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterTarefasOrigem"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página, a partir de 1. Padrão 1."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Quantidade de registros por página. Padrão e máximo de 100."}}}}},"example":{"call":"ObterTarefasOrigem","param":[{"nPagina":1,"nRegPorPagina":100}]}},"geral_tarefasorigem_ObterTarefasOrigem_retorno":{"type":"object","properties":{"cCodStatus":{"type":"string","description":"Código do status: \"0\" para sucesso; \"1001\" quando a página não tem registros."},"cDesStatus":{"type":"string","description":"Descrição do status."},"nPagina":{"type":"integer","description":"Número da página retornada."},"nRegistros":{"type":"integer","description":"Quantidade de registros na página."},"nTotPaginas":{"type":"integer","description":"Total de páginas."},"nTotRegistros":{"type":"integer","description":"Total de registros encontrados."},"listaOrigens":{"type":"object","properties":{"cCodigo":{"type":"string","description":"Código da origem, usado em cOrigem das tarefas e dos tipos de tarefa (ex.: pedido-venda)."},"cNome":{"type":"string","description":"Nome da origem."},"cModulo":{"type":"string","description":"Sigla do módulo do ERP a que a origem pertence."}},"description":"Origens de tarefa (a resposta traz uma lista)."}},"title":"ObterTarefasOrigem (retorno)"},"geral_tipoassinante_ListarTipoAssinante":{"type":"object","title":"ListarTipoAssinante","description":"Lista os tipos de assinante","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarTipoAssinante"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"ordenar_por":{"type":"string","maxLength":100,"example":"CODIGO","description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"example":"S","description":"Se a lista será apresentada em ordem decrescente."}}}}},"example":{"call":"ListarTipoAssinante","param":[{"pagina":1,"registros_por_pagina":20}]}},"geral_tipoassinante_ListarTipoAssinante_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada"},"total_de_paginas":{"type":"integer","description":"Número total de páginas"},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"total de registros encontrados"},"cadastros":{"type":"array","items":{"type":"object","properties":{"cCodigo":{"type":"string","description":"Código do tipo de assinante"},"cDescricao":{"type":"string","description":"Descrição do tipo de assinante"}}},"description":"Lista os tipos de assinante."}},"title":"ListarTipoAssinante (retorno)"},"geral_tipocategoria_ListarTipoCategoria":{"type":"object","title":"ListarTipoCategoria","description":"Listagem do tipo de categoria","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarTipoCategoria"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página, a partir de 1. Padrão 1."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Quantidade de registros por página. Padrão 500."}}}}},"example":{"call":"ListarTipoCategoria","param":[{"nPagina":1,"nRegPorPagina":100}]}},"geral_tipocategoria_ListarTipoCategoria_retorno":{"type":"object","properties":{"cCodStatus":{"type":"string","description":"Código do status: \"0\" para sucesso; \"5113\" quando a página não tem registros."},"cDesStatus":{"type":"string","description":"Descrição do status."},"nPagina":{"type":"integer","description":"Número da página retornada."},"nTotPaginas":{"type":"integer","description":"Total de páginas."},"nRegistros":{"type":"integer","description":"Quantidade de registros na página."},"nTotRegistros":{"type":"integer","description":"Total de registros encontrados."},"listaTipoCategoria":{"type":"array","items":{"type":"object","properties":{"cTipo":{"type":"string","description":"Indica se o tipo é de gasto ou de receita. P - Gasto (para categorias de despesa) R - Receita (para categorias de receita)"},"cDescricao":{"type":"string","description":"Descrição do tipo de categoria."},"cCodigo":{"type":"string","description":"Código do tipo de categoria, a informar em tipo_categoria da categoria."},"cGrupo":{"type":"string","description":"Grupo a que o tipo pertence, para organizar a lista."}}},"description":"Tipos de gasto e de receita das categorias."}},"title":"ListarTipoCategoria (retorno)"},"geral_tipocc_ListarTiposCC":{"type":"object","title":"ListarTiposCC","description":"Listar os tipos de contas correntes.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarTiposCC"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"apenas_importado_api":{"type":"string","maxLength":1,"description":"Exibir apenas os registros gerados pela API"},"ordenar_por":{"type":"string","maxLength":100,"description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."}}}}},"example":{"call":"ListarTiposCC","param":[{"pagina":1,"registros_por_pagina":50}]}},"geral_tipocc_ListarTiposCC_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada"},"total_de_paginas":{"type":"integer","description":"Número total de páginas"},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"total de registros encontrados"},"cadastros":{"type":"array","items":{"type":"object","properties":{"cCodigo":{"type":"string","description":"Código do tipo de oportunidade."},"cDescricao":{"type":"string","description":"Descrição do tipo de oportunidade."},"cGrupo":{"type":"string","description":"Observação do tipo de oportunidade."}}},"description":"Lista os cadastros encontrados."}},"title":"ListarTiposCC (retorno)"},"geral_tiposanexo_ListarTiposAnexos":{"type":"object","title":"ListarTiposAnexos","description":"Listagem de tipos de anexos.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarTiposAnexos"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo":{"type":"string","maxLength":10,"description":"Código do tipo de anexo."}}}}},"example":{"call":"ListarTiposAnexos","param":[{"codigo":""}]}},"geral_tiposanexo_ListarTiposAnexos_retorno":{"type":"object","properties":{"listaTipoAnexo":{"type":"array","items":{"type":"object","properties":{"codigo":{"type":"string","description":"Código do Tipo de Anexo."},"descricao":{"type":"string","description":"Descrição do Tipo de Anexo."}}},"description":"Lista de tipos de anexos."}},"title":"ListarTiposAnexos (retorno)"},"geral_tiposdoc_ConsultarTipoDocumento":{"type":"object","title":"ConsultarTipoDocumento","description":"Consulta um tipo de documento por código","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarTipoDocumento"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo":{"type":"string","maxLength":5,"description":"Código do tipo de documento"}},"required":["codigo"]}}},"example":{"call":"ConsultarTipoDocumento","param":[{"codigo":"9999"}]}},"geral_tiposdoc_ConsultarTipoDocumento_retorno":{"type":"object","properties":{"codigo":{"type":"string","description":"Código para o Tipo de Documento"},"descricao":{"type":"string","description":"Descrição para o Tipo de Documento"}},"title":"ConsultarTipoDocumento (retorno)"},"geral_tiposdoc_PesquisarTipoDocumento":{"type":"object","title":"PesquisarTipoDocumento","description":"Pesquisa o tipo de documento","required":["call","param"],"properties":{"call":{"type":"string","enum":["PesquisarTipoDocumento"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo":{"type":"string","maxLength":5,"description":"codigo do tipo de documento"}}}}},"example":{"call":"PesquisarTipoDocumento","param":[{"codigo":""}]}},"geral_tiposdoc_PesquisarTipoDocumento_retorno":{"type":"object","properties":{"tipo_documento_cadastro":{"type":"array","items":{"type":"object","properties":{"codigo":{"type":"string","description":"Código para o Tipo de Documento"},"descricao":{"type":"string","description":"Descrição para o Tipo de Documento"}}},"description":"Cadastro do tipo de documento"}},"title":"PesquisarTipoDocumento (retorno)"},"geral_tiposentrega_AlterarTipoEntrega":{"type":"object","title":"AlterarTipoEntrega","description":"Alterar tipo de entrega","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarTipoEntrega"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodEntrega":{"type":"integer","maxLength":15,"description":"Código do tipo de entrega"},"cCodIntEntrega":{"type":"string","maxLength":40,"description":"Código de integração do tipo de entrega"},"cDescricao":{"type":"string","maxLength":80,"description":"Descrição do tipo de entrega"},"cInativo":{"type":"string","maxLength":1,"example":"S","description":"Tipo de entrega inativo [S/N]"}}}}},"example":{"call":"AlterarTipoEntrega","param":[{"nCodEntrega":0,"cCodIntEntrega":"","cDescricao":"","cInativo":"N"}]}},"geral_tiposentrega_AlterarTipoEntrega_retorno":{"type":"object","properties":{"nCodEntrega":{"type":"integer","description":"Código do tipo de entrega"},"cCodIntEntrega":{"type":"string","description":"Código de integração do tipo de entrega"},"cCodStatus":{"type":"string","description":"Código do status do tipo de entrega"},"cDesStatus":{"type":"string","description":"Descrição do status do tipo de entrega"}},"title":"AlterarTipoEntrega (retorno)"},"geral_tiposentrega_ConsultarTipoEntrega":{"type":"object","title":"ConsultarTipoEntrega","description":"Consultar tipo de entrega","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarTipoEntrega"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodEntrega":{"type":"integer","maxLength":15,"description":"Código do tipo de entrega"},"cCodIntEntrega":{"type":"string","maxLength":40,"description":"Código de integração do tipo de entrega"}}}}},"example":{"call":"ConsultarTipoEntrega","param":[{"nCodEntrega":0,"cCodIntEntrega":""}]}},"geral_tiposentrega_ConsultarTipoEntrega_retorno":{"type":"object","properties":{"nCodTransp":{"type":"integer","description":"Código da transportadora"},"nCodEntrega":{"type":"integer","description":"Código do tipo de entrega"},"cCodIntEntrega":{"type":"string","description":"Código de integração do tipo de entrega"},"cDescricao":{"type":"string","description":"Descrição do tipo de entrega"},"cInativo":{"type":"string","description":"Tipo de entrega inativo [S/N]"}},"title":"ConsultarTipoEntrega (retorno)"},"geral_tiposentrega_ExcluirTipoEntrega":{"type":"object","title":"ExcluirTipoEntrega","description":"Excluir tipo de entrega","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirTipoEntrega"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodEntrega":{"type":"integer","maxLength":15,"description":"Código do tipo de entrega"},"cCodIntEntrega":{"type":"string","maxLength":40,"description":"Código de integração do tipo de entrega"}}}}},"example":{"call":"ExcluirTipoEntrega","param":[{"nCodEntrega":0,"cCodIntEntrega":""}]}},"geral_tiposentrega_ExcluirTipoEntrega_retorno":{"type":"object","properties":{"nCodEntrega":{"type":"integer","description":"Código do tipo de entrega"},"cCodIntEntrega":{"type":"string","description":"Código de integração do tipo de entrega"},"cCodStatus":{"type":"string","description":"Código do status do tipo de entrega"},"cDesStatus":{"type":"string","description":"Descrição do status do tipo de entrega"}},"title":"ExcluirTipoEntrega (retorno)"},"geral_tiposentrega_IncluirTipoEntrega":{"type":"object","title":"IncluirTipoEntrega","description":"Incluir tipo de entrega","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirTipoEntrega"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodTransp":{"type":"integer","maxLength":15,"description":"Código da transportadora"},"cCodIntEntrega":{"type":"string","maxLength":40,"description":"Código de integração do tipo de entrega"},"cDescricao":{"type":"string","maxLength":80,"description":"Descrição do tipo de entrega"},"cInativo":{"type":"string","maxLength":1,"example":"S","description":"Tipo de entrega inativo [S/N]"}},"required":["cCodIntEntrega","cDescricao","nCodTransp"]}}},"example":{"call":"IncluirTipoEntrega","param":[{"nCodTransp":0,"cCodIntEntrega":"","cDescricao":"","cInativo":"N"}]}},"geral_tiposentrega_IncluirTipoEntrega_retorno":{"type":"object","properties":{"nCodEntrega":{"type":"integer","description":"Código do tipo de entrega"},"cCodIntEntrega":{"type":"string","description":"Código de integração do tipo de entrega"},"cCodStatus":{"type":"string","description":"Código do status do tipo de entrega"},"cDesStatus":{"type":"string","description":"Descrição do status do tipo de entrega"}},"title":"IncluirTipoEntrega (retorno)"},"geral_tiposentrega_ListarTipoEntrega":{"type":"object","title":"ListarTipoEntrega","description":"Listar tipo de entrega","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarTipoEntrega"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15},"nRegistrosPorPagina":{"type":"integer","maxLength":15},"dDtAltDe":{"type":"string","maxLength":10},"dDtAltAte":{"type":"string","maxLength":10},"nCodTransp":{"type":"integer","maxLength":15,"description":"Código da transportadora"}}}}},"example":{"call":"ListarTipoEntrega","param":[{"nPagina":1,"nRegistrosPorPagina":50,"nCodTransp":0}]}},"geral_tiposentrega_ListarTipoEntrega_retorno":{"type":"object","properties":{"nPagina":{"type":"integer"},"nTotalPaginas":{"type":"integer"},"nRegistros":{"type":"integer"},"nTotalRegistros":{"type":"integer"},"CadTiposEntrega":{"type":"array","items":{"type":"object","properties":{"nCodTransp":{"type":"integer","description":"Código da transportadora"},"nCodEntrega":{"type":"integer","description":"Código do tipo de entrega"},"cCodIntEntrega":{"type":"string","description":"Código de integração do tipo de entrega"},"cDescricao":{"type":"string","description":"Descrição do tipo de entrega"},"cInativo":{"type":"string","description":"Tipo de entrega inativo [S/N]"}}}}},"title":"ListarTipoEntrega (retorno)"},"geral_tipostarefa_AlterarTiposTarefa":{"type":"object","title":"AlterarTiposTarefa","description":"Método para realizar a alteração de um tipo de tarefa.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarTiposTarefa"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodTipoTarefa":{"type":"integer","maxLength":15,"description":"Código do tipo de tarefa a alterar, obtido em ObterTiposTarefa."},"cOrigem":{"type":"string","maxLength":20,"description":"Origem da tarefa.\n\nPode ser:\n\noportunidade\ngeral\ncliente\nproduto\nservico\npedido-venda\npedido-compra\npedido-importacao\ncontas-pagar\ncontas-receber\nordem-producao\nordem-servico\ncontrato-servico\n\nObrigatória: não há origem padrão na inclusão nem na alteração. O usuário precisa ter acesso à área da origem."},"cDescricao":{"type":"string","maxLength":40,"description":"Nova descrição. Obrigatória: envie a atual se não for mudar."}},"required":["cDescricao","cOrigem","nCodTipoTarefa"]}}},"example":{"call":"AlterarTiposTarefa","param":[{"nCodTipoTarefa":7654321001,"cOrigem":"contas-receber","cDescricao":"Ligação de cobrança amigável"}]}},"geral_tipostarefa_AlterarTiposTarefa_retorno":{"type":"object","properties":{"cCodStatus":{"type":"string","description":"Código do status: \"0\" para sucesso; \"1140\" tipo não encontrado."},"cDesStatus":{"type":"string","description":"Descrição do status."},"nCodTipoTarefa":{"type":"integer","description":"Código do tipo de tarefa alterado."}},"title":"AlterarTiposTarefa (retorno)"},"geral_tipostarefa_ExcluirTiposTarefa":{"type":"object","title":"ExcluirTiposTarefa","description":"Método para realizar a exclusão de um tipo de tarefa.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirTiposTarefa"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodTipoTarefa":{"type":"integer","maxLength":15,"description":"Código do tipo de tarefa a excluir."}},"required":["nCodTipoTarefa"]}}},"example":{"call":"ExcluirTiposTarefa","param":[{"nCodTipoTarefa":7654321001}]}},"geral_tipostarefa_ExcluirTiposTarefa_retorno":{"type":"object","properties":{"cCodStatus":{"type":"string","description":"Código do status: \"0\" para sucesso; \"1001\" tipo em uso por tarefa; \"1140\" tipo não encontrado."},"cDesStatus":{"type":"string","description":"Descrição do status."}},"title":"ExcluirTiposTarefa (retorno)"},"geral_tipostarefa_IncluirTiposTarefa":{"type":"object","title":"IncluirTiposTarefa","description":"Método para realizar a inclusão de tipos de tarefa.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirTiposTarefa"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cOrigem":{"type":"string","maxLength":20,"description":"Origem da tarefa.\n\nPode ser:\n\noportunidade\ngeral\ncliente\nproduto\nservico\npedido-venda\npedido-compra\npedido-importacao\ncontas-pagar\ncontas-receber\nordem-producao\nordem-servico\ncontrato-servico\n\nObrigatória: não há origem padrão na inclusão nem na alteração. O usuário precisa ter acesso à área da origem."},"cDescricao":{"type":"string","maxLength":40,"description":"Descrição do tipo de tarefa (ex.: Ligação de cobrança). Obrigatória."}},"required":["cDescricao","cOrigem"]}}},"example":{"call":"IncluirTiposTarefa","param":[{"cOrigem":"contas-receber","cDescricao":"Ligação de cobrança"}]}},"geral_tipostarefa_IncluirTiposTarefa_retorno":{"type":"object","properties":{"cCodStatus":{"type":"string","description":"Código do status: \"0\" para sucesso."},"cDesStatus":{"type":"string","description":"Descrição do status."},"nCodTipoTarefa":{"type":"integer","description":"Código gerado para o novo tipo de tarefa."}},"title":"IncluirTiposTarefa (retorno)"},"geral_tipostarefa_ObterTiposTarefa":{"type":"object","title":"ObterTiposTarefa","description":"Método para realizar a listagem de tipos de tarefa cadastrados no ERP.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterTiposTarefa"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página, a partir de 1. Padrão 1."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Quantidade de registros por página. Padrão 500."},"cOrigem":{"type":"string","maxLength":20,"description":"Origem da tarefa.\n\nPode ser:\n\noportunidade\ngeral\ncliente\nproduto\nservico\npedido-venda\npedido-compra\npedido-importacao\ncontas-pagar\ncontas-receber\nordem-producao\nordem-servico\ncontrato-servico\n\nQuando não informada, a listagem traz os tipos da origem \"geral\"."},"nCodTipoTarefa":{"type":"integer","maxLength":15,"description":"Filtra um tipo de tarefa pelo código. Combina com cOrigem, que continua valendo (padrão \"geral\")."}}}}},"example":{"call":"ObterTiposTarefa","param":[{"nPagina":1,"nRegPorPagina":100,"cOrigem":"contas-receber"}]}},"geral_tipostarefa_ObterTiposTarefa_retorno":{"type":"object","properties":{"cCodStatus":{"type":"string","description":"Código do status: \"0\" para sucesso; \"1001\" quando a página não tem registros; \"403\" sem acesso à área da origem."},"cDesStatus":{"type":"string","description":"Descrição do status."},"nPagina":{"type":"integer","description":"Número da página retornada."},"nRegistros":{"type":"integer","description":"Quantidade de registros na página."},"nTotPaginas":{"type":"integer","description":"Total de páginas."},"nTotRegistros":{"type":"integer","description":"Total de registros encontrados."},"listaTiposTarefa":{"type":"array","items":{"type":"object","properties":{"nCodTipoTarefa":{"type":"integer","description":"Código do tipo de tarefa."},"cDescricao":{"type":"string","description":"Descrição para o tipo de tarefa."},"cOrigem":{"type":"string","description":"Origem da tarefa. Pode ser: oportunidade geral cliente produto servico pedido-venda pedido-compra pedido-importacao contas-pagar contas-receber ordem-producao ordem-servico contrato-servico Origem a que o tipo pertence."}}},"description":"Tipos de tarefa da origem, em ordem de descrição."}},"title":"ObterTiposTarefa (retorno)"},"geral_tpativ_ListarTipoAtiv":{"type":"object","title":"ListarTipoAtiv","description":"Listar Tipos de Atividade.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarTipoAtiv"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"filtrar_por_codigo":{"type":"string","description":"Código do Tipo de Atividade da Empresa."},"filtrar_por_descricao":{"type":"string","description":"Descrição do Tipo de Atividade da Empresa."}}}}},"example":{"call":"ListarTipoAtiv","param":[{"filtrar_por_codigo":"","filtrar_por_descricao":""}]}},"geral_tpativ_ListarTipoAtiv_retorno":{"type":"object","properties":{"lista_tipos_atividade":{"type":"array","items":{"type":"object","properties":{"cCodigo":{"type":"string","description":"Código do Tipo de Atividade da Empresa."},"cDescricao":{"type":"string","description":"Descrição do Tipo de Atividade da Empresa."}}},"description":"Lista de Tipo de Atividade da Empresa."}},"title":"ListarTipoAtiv (retorno)"},"geral_unidade_ListarUnidades":{"type":"object","title":"ListarUnidades","description":"Lista as unidades de medidas.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarUnidades"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo":{"type":"string","maxLength":6,"description":"Código da Unidade."}}}}},"example":{"call":"ListarUnidades","param":[{"codigo":""}]}},"geral_unidade_ListarUnidades_retorno":{"type":"object","properties":{"unidade_cadastro":{"type":"array","items":{"type":"object","properties":{"codigo":{"type":"string","description":"Código da Unidade."},"descricao":{"type":"string","description":"Descrição da Unidade."}}},"description":"Dados da Unidade de Medida."}},"title":"ListarUnidades (retorno)"},"geral_vendedores_AlterarVendedor":{"type":"object","title":"AlterarVendedor","description":"Altera os dados de um vendedor","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarVendedor"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo":{"type":"integer","maxLength":15,"description":"Código do vendedor"},"codInt":{"type":"string","maxLength":30,"description":"Código de Integração do vendedor"},"nome":{"type":"string","maxLength":70,"description":"Nome do Vendedor"},"inativo":{"type":"string","maxLength":1,"example":"S","description":"Vendedor inativo (S/N)."},"email":{"type":"string","maxLength":100,"description":"emaill do vendedor."},"fatura_pedido":{"type":"string","maxLength":1,"description":"O vendedor pode faturar um pedido?\n\nInforme \"S\" ou \"N\"."},"visualiza_pedido":{"type":"string","maxLength":1,"description":"Visualiza apenas os pedidos em que é o vendedor.\n\nInformar \"S\" ou \"N\"."},"comissao":{"type":"number","maxLength":10,"description":"Percentual de Comissão."}}}}},"example":{"call":"AlterarVendedor","param":[{"codigo":0,"codInt":"123","nome":"","inativo":"N","email":"teste@minhaempresa.com.br","fatura_pedido":"S","visualiza_pedido":"N","comissao":10.0}]}},"geral_vendedores_AlterarVendedor_retorno":{"type":"object","properties":{"codigo":{"type":"integer","description":"Código do vendedor"},"codInt":{"type":"string","description":"Código de Integração do vendedor"},"status":{"type":"string","description":"Status do processamento"},"descricao":{"type":"string","description":"Descrição do status"}},"title":"AlterarVendedor (retorno)"},"geral_vendedores_ConsultarVendedor":{"type":"object","title":"ConsultarVendedor","description":"Consulta os dados de um vendedor","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarVendedor"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo":{"type":"integer","maxLength":15,"description":"Código do vendedor"},"codInt":{"type":"string","maxLength":30,"description":"Código de Integração do vendedor"}}}}},"example":{"call":"ConsultarVendedor","param":[{"codigo":0,"codInt":"123"}]}},"geral_vendedores_ConsultarVendedor_retorno":{"type":"object","properties":{"codigo":{"type":"integer","description":"Código do Vendedor"},"codInt":{"type":"string","description":"Código de Integração do Vendedor"},"nome":{"type":"string","description":"Nome do Vendedor"},"inativo":{"type":"string","description":"Indica se o vendedor está inativo [S/N]"},"email":{"type":"string","description":"emaill do vendedor."},"fatura_pedido":{"type":"string","description":"O vendedor pode faturar um pedido? Informe \"S\" ou \"N\"."},"visualiza_pedido":{"type":"string","description":"Visualiza apenas os pedidos em que é o vendedor. Informar \"S\" ou \"N\"."},"comissao":{"type":"decimal","description":"Percentual de Comissão."}},"title":"ConsultarVendedor (retorno)"},"geral_vendedores_ExcluirVendedor":{"type":"object","title":"ExcluirVendedor","description":"Exclui um vendedor","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirVendedor"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo":{"type":"integer","maxLength":15,"description":"Código do vendedor"},"codInt":{"type":"string","maxLength":30,"description":"Código de Integração do vendedor"}}}}},"example":{"call":"ExcluirVendedor","param":[{"codigo":0,"codInt":"123"}]}},"geral_vendedores_ExcluirVendedor_retorno":{"type":"object","properties":{"codigo":{"type":"integer","description":"Código do vendedor"},"codInt":{"type":"string","description":"Código de Integração do vendedor"},"status":{"type":"string","description":"Status do processamento"},"descricao":{"type":"string","description":"Descrição do status"}},"title":"ExcluirVendedor (retorno)"},"geral_vendedores_IncluirVendedor":{"type":"object","title":"IncluirVendedor","description":"Inclui um vendedor","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirVendedor"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codInt":{"type":"string","maxLength":30,"description":"Código de Integração do vendedor"},"nome":{"type":"string","maxLength":70,"description":"Nome do Vendedor"},"inativo":{"type":"string","maxLength":1,"example":"S","description":"Vendedor inativo (S/N)."},"email":{"type":"string","maxLength":100,"description":"emaill do vendedor."},"fatura_pedido":{"type":"string","maxLength":1,"description":"O vendedor pode faturar um pedido?\n\nInforme \"S\" ou \"N\"."},"visualiza_pedido":{"type":"string","maxLength":1,"description":"Visualiza apenas os pedidos em que é o vendedor.\n\nInformar \"S\" ou \"N\"."},"comissao":{"type":"number","maxLength":10,"description":"Percentual de Comissão."}},"required":["codInt","nome"]}}},"example":{"call":"IncluirVendedor","param":[{"codInt":"123","nome":"","inativo":"N","email":"teste@minhaempresa.com.br","fatura_pedido":"S","visualiza_pedido":"N","comissao":10.0}]}},"geral_vendedores_IncluirVendedor_retorno":{"type":"object","properties":{"codigo":{"type":"integer","description":"Código do vendedor"},"codInt":{"type":"string","description":"Código de Integração do vendedor"},"status":{"type":"string","description":"Status do processamento"},"descricao":{"type":"string","description":"Descrição do status"}},"title":"IncluirVendedor (retorno)"},"geral_vendedores_ListarVendedores":{"type":"object","title":"ListarVendedores","description":"Listagem de Vendedores","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarVendedores"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15},"registros_por_pagina":{"type":"integer","maxLength":15},"apenas_importado_api":{"type":"string","maxLength":1},"ordenar_por":{"type":"string","maxLength":100},"ordem_descrescente":{"type":"string","maxLength":1},"filtrar_por_data_de":{"type":"string","maxLength":10},"filtrar_por_data_ate":{"type":"string","maxLength":10},"filtrar_apenas_inclusao":{"type":"string","maxLength":1},"filtrar_apenas_alteracao":{"type":"string","maxLength":1},"filtrar_por_email":{"type":"string","maxLength":100,"description":"Filtrar os vendedores por e-mail"},"filtrar_por_nome":{"type":"string","maxLength":100,"description":"Filtrar os vendedores por nome"}}}}},"example":{"call":"ListarVendedores","param":[{"pagina":1,"registros_por_pagina":100,"apenas_importado_api":"N"}]}},"geral_vendedores_ListarVendedores_retorno":{"type":"object","properties":{"pagina":{"type":"integer"},"total_de_paginas":{"type":"integer"},"registros":{"type":"integer"},"total_de_registros":{"type":"integer"},"cadastro":{"type":"array","items":{"type":"object","properties":{"codigo":{"type":"integer","description":"Código do Vendedor"},"codInt":{"type":"string","description":"Código de Integração do Vendedor"},"nome":{"type":"string","description":"Nome do Vendedor"},"inativo":{"type":"string","description":"Indica se o vendedor está inativo [S/N]"},"email":{"type":"string","description":"E-mail do vendedor."},"fatura_pedido":{"type":"string","description":"O vendedor pode faturar um pedido? Informe \"S\" ou \"N\"."},"visualiza_pedido":{"type":"string","description":"Visualiza apenas os pedidos em que é o vendedor. Informar \"S\" ou \"N\"."},"comissao":{"type":"decimal","description":"Percentual de Comissão."}}}}},"title":"ListarVendedores (retorno)"},"geral_vendedores_UpsertVendedor":{"type":"object","title":"UpsertVendedor","description":"Inclui / Altera um vendedor","required":["call","param"],"properties":{"call":{"type":"string","enum":["UpsertVendedor"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo":{"type":"integer","maxLength":15,"description":"Código do vendedor"},"codInt":{"type":"string","maxLength":30,"description":"Código de Integração do vendedor"},"nome":{"type":"string","maxLength":70,"description":"Nome do Vendedor"},"inativo":{"type":"string","maxLength":1,"example":"S","description":"Vendedor inativo (S/N)."},"email":{"type":"string","maxLength":100,"description":"emaill do vendedor."},"fatura_pedido":{"type":"string","maxLength":1,"description":"O vendedor pode faturar um pedido?\n\nInforme \"S\" ou \"N\"."},"visualiza_pedido":{"type":"string","maxLength":1,"description":"Visualiza apenas os pedidos em que é o vendedor.\n\nInformar \"S\" ou \"N\"."},"comissao":{"type":"number","maxLength":10,"description":"Percentual de Comissão."}}}}},"example":{"call":"UpsertVendedor","param":[{"codigo":0,"codInt":"123","nome":"","inativo":"N","email":"teste@minhaempresa.com.br","fatura_pedido":"S","visualiza_pedido":"N","comissao":10.0}]}},"geral_vendedores_UpsertVendedor_retorno":{"type":"object","properties":{"codigo":{"type":"integer","description":"Código do vendedor"},"codInt":{"type":"string","description":"Código de Integração do vendedor"},"status":{"type":"string","description":"Status do processamento"},"descricao":{"type":"string","description":"Descrição do status"}},"title":"UpsertVendedor (retorno)"},"produtos_blocox_ListarNFsBlocoX":{"type":"object","title":"ListarNFsBlocoX","description":"Lista as NFs para o Bloco X (ECF)","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarNFsBlocoX"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página. Padrão 1. A paginação conta itens de nota, não notas."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Itens por página. Padrão 100, máximo 100 (valor maior volta a 100)."},"cOrdenarPor":{"type":"string","maxLength":100,"description":"Ordem dos resultados:\nCODIGO - código da nota (padrão).\nDATA_EMISSAO - data de emissão.\nDATA_ENTRADA - data de saída informada pelo fornecedor.\nDATA_REGISTRO - data do registro do recebimento."},"dEmiInicial":{"type":"string","maxLength":10,"description":"Data de emissão inicial, no formato dd/mm/aaaa."},"dEmiFinal":{"type":"string","maxLength":10,"description":"Data de emissão final, no formato dd/mm/aaaa."},"dSaiEntInicial":{"type":"string","maxLength":10,"description":"Data de saída informada pelo fornecedor, inicial, no formato dd/mm/aaaa."},"dSaiEntFinal":{"type":"string","maxLength":10,"description":"Data de saída informada pelo fornecedor, final, no formato dd/mm/aaaa."},"dRegInicial":{"type":"string","maxLength":10,"description":"Data de registro do recebimento na Omie, inicial, no formato dd/mm/aaaa."},"dRegFinal":{"type":"string","maxLength":10,"description":"Data de registro do recebimento na Omie, final, no formato dd/mm/aaaa."},"cSerie":{"type":"string","maxLength":5,"description":"Série da NF-e (comparação exata)."},"nNFInicial":{"type":"integer","maxLength":15,"description":"Número inicial da NF-e."},"nNFFinal":{"type":"integer","maxLength":15,"description":"Número final da NF-e."},"dIncInicial":{"type":"string","maxLength":10,"description":"Data de inclusão do recebimento, inicial, no formato dd/mm/aaaa."},"dIncFinal":{"type":"string","maxLength":10,"description":"Data de inclusão do recebimento, final, no formato dd/mm/aaaa."},"dAltInicial":{"type":"string","maxLength":10,"description":"Data de alteração do recebimento, inicial, no formato dd/mm/aaaa."},"dAltFinal":{"type":"string","maxLength":10,"description":"Data de alteração do recebimento, final, no formato dd/mm/aaaa."}}}}},"example":{"call":"ListarNFsBlocoX","param":[{"nPagina":1,"nRegPorPagina":100,"cOrdenarPor":"DATA_REGISTRO","dRegInicial":"01/09/2026","dRegFinal":"30/09/2026"}]}},"produtos_blocox_ListarNFsBlocoX_retorno":{"type":"object","properties":{"nPagina":{"type":"integer","description":"Número da página devolvida."},"nTotPaginas":{"type":"integer","description":"Total de páginas (de itens)."},"nRegistros":{"type":"integer","description":"Itens devolvidos nesta página."},"nTotRegistros":{"type":"integer","description":"Total de itens encontrados."},"listaNFs":{"type":"array","items":{"type":"object","properties":{"ide":{"type":"object","properties":{"idNF":{"type":"integer","description":"Código interno da nota fiscal na Omie."},"IdForn":{"type":"integer","description":"Código interno do fornecedor (cadastro de clientes e fornecedores)."},"cnpjForn":{"type":"string","description":"CNPJ do fornecedor."},"razaoForn":{"type":"string","description":"Razão Social do Fornecedor."},"modelo":{"type":"string","description":"Modelo do documento fiscal. Sempre 55."},"serie":{"type":"string","description":"Série do Documento Fiscal"},"nNF":{"type":"string","description":"Número do Documento Fiscal."},"chNFe":{"type":"string","description":"Chave da NF-e."},"dEmi":{"type":"string","description":"Data de emissão da NF-e, no formato dd/mm/aaaa."},"dSaiEnt":{"type":"string","description":"Data do registro do recebimento na Omie, no formato dd/mm/aaaa (apesar do nome, não é a data de saída do fornecedor)."},"dReg":{"type":"string","description":"Data de saída informada pelo fornecedor, no formato dd/mm/aaaa (apesar do nome, não é a data de registro)."},"lCancelada":{"type":"boolean","description":"Indica se a NF-e foi cancelada."},"lDenegada":{"type":"boolean","description":"Indica se a NF-e foi denegada."},"lAjuste":{"type":"boolean","description":"Indica se é uma NF-e de ajuste (finalidade 3)."},"lComplementar":{"type":"boolean","description":"Indica se é uma NF-e complementar (finalidade 2)."},"dInc":{"type":"string","description":"Data de inclusão do recebimento, no formato dd/mm/aaaa."},"dAlt":{"type":"string","description":"Data de alteração do recebimento, no formato dd/mm/aaaa."}},"description":"Cabeçalho da NF-e de entrada."},"itens":{"type":"array","items":{"type":"object","properties":{"nItem":{"type":"integer","description":"Número sequencial do item na nota."},"nIdProd":{"type":"integer","description":"Código interno do produto na Omie."},"cProd":{"type":"string","description":"Código do produto na Omie (ou o código da nota, se o produto não estiver vinculado)."},"uTrib":{"type":"string","description":"Unidade Tributável."},"qTrib":{"type":"decimal","description":"Quantidade do item."},"vUnTrib":{"type":"decimal","description":"Valor unitário do item."},"vProd":{"type":"decimal","description":"Valor da mercadoria no recebimento."},"vDesc":{"type":"decimal","description":"Valor do desconto do item."},"pICMS":{"type":"decimal","description":"Alíquota de ICMS (zerada quando não há crédito)."},"vBC":{"type":"decimal","description":"Base de cálculo do ICMS (zerada quando não há crédito)."},"vICMS":{"type":"decimal","description":"Valor do ICMS (zerado quando não há crédito)."},"pICMSST":{"type":"decimal","description":"Alíquota do ICMS ST (só para indústria ou equiparada)."},"vBCST":{"type":"decimal","description":"Base de cálculo do ICMS ST (só para indústria ou equiparada)."},"vST":{"type":"decimal","description":"Valor do ICMS ST (só para indústria ou equiparada)."},"vNF":{"type":"decimal","description":"Valor total do item na nota."},"EAN":{"type":"string","description":"Código de barras (EAN) do produto informado no item da nota."}}},"description":"Itens de produto da nota marcados para cupom fiscal."}}},"description":"Notas de entrada encontradas, cada uma com o cabeçalho (ide) e os itens da página."}},"title":"ListarNFsBlocoX (retorno)"},"produtos_cest_ListarCEST":{"type":"object","title":"ListarCEST","description":"Listar CEST.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarCEST"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"ordenar_por":{"type":"string","maxLength":100,"example":"CODIGO","description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."},"cCodigo":{"type":"string","maxLength":9,"description":"Código do CEST."},"cDescricao":{"type":"string","maxLength":150,"description":"Descrição do CEST."}}}}},"example":{"call":"ListarCEST","param":[{"pagina":1,"registros_por_pagina":20}]}},"produtos_cest_ListarCEST_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada."},"total_de_paginas":{"type":"integer","description":"Número total de páginas."},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"Total de registros encontrados."},"cadastros":{"type":"array","items":{"type":"object","properties":{"cCodigo":{"type":"string","description":"Código do CEST."},"cDescricao":{"type":"string","description":"Descrição do CEST."}}},"description":"Lista os CESTs encontrados."}},"title":"ListarCEST (retorno)"},"produtos_cfop_ListarCFOP":{"type":"object","title":"ListarCFOP","description":"Listar as CFOPs","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarCFOP"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"ordenar_por":{"type":"string","maxLength":100,"description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."},"filtrar_por_codigo":{"type":"integer","maxLength":6,"description":"Filtrar CFOP por código"},"filtrar_por_descricao":{"type":"string","maxLength":100,"description":"Filtrar CFOP por descrição"}}}}},"example":{"call":"ListarCFOP","param":[{"pagina":1,"registros_por_pagina":50}]}},"produtos_cfop_ListarCFOP_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada"},"total_de_paginas":{"type":"integer","description":"Número total de páginas"},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"total de registros encontrados"},"cadastros":{"type":"array","items":{"type":"object","properties":{"nCodigo":{"type":"string","description":"Código do CFOP."},"cDescricao":{"type":"string","description":"Descrição do CFOP."},"cObservacao":{"type":"string","description":"Observação do CFOP."},"cTipo":{"type":"string","description":"Tipo do CFOP. E-Entrada / S-Saída"}}},"description":"Lista os CFOPs encontrados."}},"title":"ListarCFOP (retorno)"},"produtos_classtrib_ListarClassTrib":{"type":"object","title":"ListarClassTrib","description":"Lista as classificações tributárias do IBS e CBS.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarClassTrib"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"nRegistrosPorPagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página."},"cDescricao":{"type":"string","maxLength":250,"description":"Nome da classificação tributária."},"cCodCst":{"type":"string","maxLength":3,"description":"Código de Situação Tributária (CST) referente a Classificação tributária."}}}}},"example":{"call":"ListarClassTrib","param":[{"nPagina":1,"nRegistrosPorPagina":50}]}},"produtos_classtrib_ListarClassTrib_retorno":{"type":"object","properties":{"nPagina":{"type":"integer","description":"Número da página retornada."},"nTotalPaginas":{"type":"integer","description":"Número total de páginas."},"nRegistrosPorPagina":{"type":"integer","description":"Número de registros retornados na página."},"nTotalRegistros":{"type":"integer","description":"Total de registros encontrados."},"cadastros":{"type":"array","items":{"type":"object","properties":{"cCodigo":{"type":"string","description":"Código da Classificação tributária do IBS e CBS."},"cDescricao":{"type":"string","description":"Nome da classificação tributária."},"cDescrCompl":{"type":"string","description":"Nome da classificação tributária."},"cCodCst":{"type":"string","description":"Código de Situação Tributária (CST) referente a Classificação tributária."}}},"description":"Lista as Classificações tributárias do IBS e CBS."}},"title":"ListarClassTrib (retorno)"},"produtos_cnae_ListarCNAE":{"type":"object","title":"ListarCNAE","description":"Listar os CNAEs cadastrados.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarCNAE"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"ordenar_por":{"type":"string","maxLength":100,"example":"CODIGO","description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."}}}}},"example":{"call":"ListarCNAE","param":[{"pagina":1,"registros_por_pagina":50}]}},"produtos_cnae_ListarCNAE_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada."},"total_de_paginas":{"type":"integer","description":"Número total de páginas."},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"Total de registros encontrados."},"cadastros":{"type":"array","items":{"type":"object","properties":{"nCodigo":{"type":"string","description":"Código CNAE."},"cDescricao":{"type":"string","description":"Descrição CNAE."},"cEstrutura":{"type":"string","description":"Estrutura CNAE."}}},"description":"Lista os CNAEs encontrados."}},"title":"ListarCNAE (retorno)"},"produtos_cofinscst_ListarCstCofins":{"type":"object","title":"ListarCstCofins","description":"Listar CST do COFINS.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarCstCofins"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"ordenar_por":{"type":"string","maxLength":100,"example":"CODIGO","description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."}}}}},"example":{"call":"ListarCstCofins","param":[{"pagina":1,"registros_por_pagina":50}]}},"produtos_cofinscst_ListarCstCofins_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada."},"total_de_paginas":{"type":"integer","description":"Número total de páginas."},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"Total de registros encontrados."},"cadastros":{"type":"array","items":{"type":"object","properties":{"nCodigo":{"type":"string","description":"Código do CST do COFINS."},"cDescricao":{"type":"string","description":"Descrição do CST do COFINS."}}},"description":"Lista os CST do COFINS encontrados."}},"title":"ListarCstCofins (retorno)"},"produtos_comprasresumo_ObterResumoCompras":{"type":"object","title":"ObterResumoCompras","description":"Obtem o resumo das compras de produtos.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterResumoCompras"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"dDataInicio":{"type":"string","maxLength":10,"description":"Data Inicial de Consulta."},"dDataFim":{"type":"string","maxLength":10,"description":"Data final de Consulta."}}}}},"example":{"call":"ObterResumoCompras","param":[{"dDataInicio":"30/09/2026","dDataFim":"30/09/2026"}]}},"produtos_comprasresumo_ObterResumoCompras_retorno":{"type":"object","properties":{"dDataInicio":{"type":"string","description":"Data Inicial de Consulta."},"dDataFim":{"type":"string","description":"Data final de Consulta."},"painelNfeCompra":{"type":"object","properties":{"emitidasFornecedorNfe":{"type":"object","properties":{"entradaNfe":{"type":"object","properties":{"nFaturadas":{"type":"decimal","description":"Quantidade faturada."},"vFaturadas":{"type":"decimal","description":"Valor faturado."},"nCanceladas":{"type":"decimal","description":"Quantidade cancelada."},"vCanceladas":{"type":"decimal","description":"Valor cancelado."},"nPendentes":{"type":"decimal","description":"Quantidade pendente."},"vPendentes":{"type":"decimal","description":"Valor pendente."},"nRejeitadas":{"type":"decimal","description":"Quantidade rejeitada."},"vRejeitadas":{"type":"decimal","description":"Valor rejeitado."},"nTotal":{"type":"decimal","description":"Quantidade total."},"vTotal":{"type":"decimal","description":"Valor total."}},"description":"Exibe os totais de faturamentos das Notas Fiscais (NF-e) de entrada."},"cIcone":{"type":"string"},"cCor":{"type":"string"},"cIconeFat":{"type":"string"},"cCorFat":{"type":"string"},"cIconeCanc":{"type":"string"},"cCorCanc":{"type":"string"},"cIconeRej":{"type":"string"},"cCorRej":{"type":"string"},"cIconePend":{"type":"string"}},"description":"Exibe os totais de faturamentos das Notas Fiscais (NF-e) emitidas pelo própria fornecedor."},"cVisualizar":{"type":"string","description":"Indica se o aplicativo possuí a configuração desse tipo de documento. Pode ser: S N."}},"description":"Exibe os totais de faturamentos de Notas Fiscais de entrada. (NF-e)."},"painelCteCompra":{"type":"object","properties":{"emitidasEmpresaCte":{"type":"object","properties":{"entradaCte":{"type":"object","properties":{"nFaturadas":{"type":"decimal","description":"Quantidade faturada."},"vFaturadas":{"type":"decimal","description":"Valor faturado."},"nCanceladas":{"type":"decimal","description":"Quantidade cancelada."},"vCanceladas":{"type":"decimal","description":"Valor cancelado."},"nTotal":{"type":"decimal","description":"Quantidade total."},"vTotal":{"type":"decimal","description":"Valor total."}},"description":"Exibe os totais de faturamentos dos Conhecimentos de Transporte (CT-e) de entrada."},"cIcone":{"type":"string"},"cCor":{"type":"string"},"cIconeFat":{"type":"string"},"cCorFat":{"type":"string"},"cIconeCanc":{"type":"string"},"cCorCanc":{"type":"string"},"cIconePend":{"type":"string"},"cCorPend":{"type":"string"}},"description":"Exibe os totais de faturamentos dos Conhecimentos de Transporte (CT-e) emitidos pelo fornecedor."},"cVisualizar":{"type":"string","description":"Indica se o aplicativo possuí a configuração desse tipo de documento. Pode ser: S N."}},"description":"Exibe os totais de faturamentos de Conhecimentos de Transporte de entrada. (CT-e)."},"requisicaoCompra":{"type":"object","properties":{"emAberto":{"type":"object","properties":{"nTotal":{"type":"decimal","description":"Quantidade total."},"vTotal":{"type":"decimal","description":"Valor total."}},"description":"Estrutura contendo os valores em aberto."},"cIcone":{"type":"string"},"cCor":{"type":"string"}},"description":"Exibe os totais das Requisições de Compras."},"pedidoCompra":{"type":"object","properties":{"emAberto":{"type":"object","properties":{"nTotal":{"type":"decimal","description":"Quantidade total."},"vTotal":{"type":"decimal","description":"Valor total."}},"description":"Estrutura contendo os valores em aberto."},"cIconePed":{"type":"string"},"cCorPed":{"type":"string"},"recebido":{"type":"object","properties":{"nTotal":{"type":"decimal","description":"Quantidade total."},"vTotal":{"type":"decimal","description":"Valor total."}},"description":"Exibe os totais dos pedidos de compras recebidos."},"cIconeFat":{"type":"string"},"cCorFat":{"type":"string"},"cIcone":{"type":"string"},"cCor":{"type":"string"},"faturarHoje":{"type":"object","properties":{"nTotal":{"type":"decimal","description":"Quantidade total."},"vTotal":{"type":"decimal","description":"Valor total."}}},"compras":{"type":"object","properties":{"nTotal":{"type":"decimal","description":"Quantidade total."},"vTotal":{"type":"decimal","description":"Valor total."}}},"cCorCompras":{"type":"string"},"cCorEmAprov":{"type":"string"},"cIconeCompras":{"type":"string"},"cIconeEmAprov":{"type":"string"},"cVisualizar":{"type":"string","description":"Indica se o aplicativo possuí a configuração desse tipo de documento. Pode ser: S N."}},"description":"Exibe os totais dos Pedidos de Compras."},"faturamentoResumo":{"type":"object","properties":{"nFaturadas":{"type":"decimal","description":"Quantidade faturada."},"vFaturadas":{"type":"decimal","description":"Valor faturado."},"cIconeFat":{"type":"string"},"cCorFat":{"type":"string"},"nCanceladas":{"type":"decimal","description":"Quantidade cancelada."},"vCanceladas":{"type":"decimal","description":"Valor cancelado."},"cIconeCanc":{"type":"string"},"cCorCanc":{"type":"string"},"nPendentes":{"type":"decimal","description":"Quantidade pendente."},"vPendentes":{"type":"decimal","description":"Valor pendente."},"cIconePend":{"type":"string"},"cCorPend":{"type":"string"},"nRejeitadas":{"type":"decimal","description":"Quantidade rejeitada."},"vRejeitadas":{"type":"decimal","description":"Valor rejeitado."},"cIconeRej":{"type":"string"},"cCorRej":{"type":"string"},"nTotal":{"type":"decimal","description":"Quantidade total."},"vTotal":{"type":"decimal","description":"Valor total."},"cIcone":{"type":"string"},"cCor":{"type":"string"}},"description":"Exibe os totais de faturamentos (NF-e + Pedido de Compra)."},"ordemProducao":{"type":"object","properties":{"etapa1":{"type":"object","properties":{"nTotal":{"type":"decimal","description":"Quantidade total."},"cEtapa":{"type":"string","description":"Descrição dada à etapa."},"cIcone":{"type":"string"},"cCor":{"type":"string"}},"description":"Primeira etapa do fluxo de Ordem de Produção."},"etapa2":{"type":"object","properties":{"nTotal":{"type":"decimal","description":"Quantidade total."},"cEtapa":{"type":"string","description":"Descrição dada à etapa."},"cIcone":{"type":"string"},"cCor":{"type":"string"}},"description":"Segunda etapa do fluxo de Ordem de Produção."},"etapa3":{"type":"object","properties":{"nTotal":{"type":"decimal","description":"Quantidade total."},"cEtapa":{"type":"string","description":"Descrição dada à etapa."},"cIcone":{"type":"string"},"cCor":{"type":"string"}},"description":"Terceira etapa do fluxo de Ordem de Produção."},"etapa4":{"type":"object","properties":{"nTotal":{"type":"decimal","description":"Quantidade total."},"cEtapa":{"type":"string","description":"Descrição dada à etapa."},"cIcone":{"type":"string"},"cCor":{"type":"string"}},"description":"Quarta etapa do fluxo de Ordem de Produção."},"etapa5":{"type":"object","properties":{"nTotal":{"type":"decimal","description":"Quantidade total."},"cEtapa":{"type":"string","description":"Descrição dada à etapa."},"cIcone":{"type":"string"},"cCor":{"type":"string"}},"description":"Quinta etapa do fluxo de Ordem de Produção."},"etapa6":{"type":"object","properties":{"nTotal":{"type":"decimal","description":"Quantidade total."},"cEtapa":{"type":"string","description":"Descrição dada à etapa."},"cIcone":{"type":"string"},"cCor":{"type":"string"}},"description":"Sexta etapa do fluxo de Ordem de Produção."},"cVisualizar":{"type":"string","description":"Indica se o aplicativo possuí a configuração desse tipo de documento. Pode ser: S N."}}}},"title":"ObterResumoCompras (retorno)"},"produtos_cte_AlterarCte":{"type":"object","title":"AlterarCte","description":"Método para alteração de informações do CT-e de saída.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarCte"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdCte":{"type":"integer","maxLength":15},"cCategoria":{"type":"string","maxLength":20},"nVendedor":{"type":"integer","maxLength":15},"nProjeto":{"type":"integer","maxLength":15}},"required":["nIdCte"]}}},"example":{"call":"AlterarCte","param":[{"nIdCte":123456,"cCategoria":"1.01.01","nVendedor":0,"nProjeto":0}]}},"produtos_cte_AlterarCte_retorno":{"type":"object","properties":{"nIdCte":{"type":"integer"},"cCodStatus":{"type":"string"},"cDesStatus":{"type":"string"}},"title":"AlterarCte (retorno)"},"produtos_cte_AverbacaoCTe":{"type":"object","title":"AverbacaoCTe","description":"Recebe o XML de averbação do XML.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AverbacaoCTe"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cAppNome":{"type":"string","maxLength":20,"description":"Nome do Aplicativo que emitiu o CT-e.\n\n\nExemplo:\n\nGeradorCT-e"},"cAppVersao":{"type":"string","maxLength":20,"description":"Versão do Aplicativo que emitiu o CT-e.\n\n\nExemplo:\n\n1.02.01"},"cAppId":{"type":"string","maxLength":100,"description":"Identificação do aplicativo que emitiu o CT-e.\n\n\nExemplo:\n\nMaquina01\n\nPS: Informe o código que identifica a instalação do aplicativo.\nCaso o cliente tenha 2 Emissores de CT-e instalados, ele deve indicar: \"01\" e \"02\" ou \"10\" e \"20\" ou ainda informar o Serial do HD da máquina."},"cChaveCte":{"type":"string","maxLength":44,"description":"Chave do CT-e a ser importado.\n\n\nApenas números com 44 digitos."},"cXmlCteAverb":{"type":"string","description":"Xml da Averbação do CT-e.\n\nPreechimento obrigatório.\n\nAntes de enviar, converta os seus seguintes caracteres:\n\n&amp; para &amp;amp;\n> para &amp;gt;\n< para &amp;lt;\n\" para &amp;quot;\n\" para &amp;apos;\n| para &amp;#124;\n\nApós essa conversão aplique o MD5 para enviar no campo \"cMd5CteAverbacao\".\n\nObservação: Para requisições SOAP usar CDATA como demonstra o exemplo abaixo:\n&lt;![CDATA[Conteúdo do campo convertido]]&gt;"},"cMd5CteAverb":{"type":"string","maxLength":32,"description":"MD5 do arquivo XML importado.\n\n\nAplique o MD5 sobre o XML antes de realizar o consumo."}},"required":["cAppId","cAppNome","cAppVersao","cChaveCte","cMd5CteAverb","cXmlCteAverb"]}}},"example":{"call":"AverbacaoCTe","param":[{"cAppNome":"GeradorCTe","cAppVersao":"1.01.02","cAppId":"Cte01","cChaveCte":"","cXmlCteAverb":"","cMd5CteAverb":""}]}},"produtos_cte_AverbacaoCTe_retorno":{"type":"object","properties":{"nIdImportacao":{"type":"integer","description":"ID da Importação do CT-e."},"nIdCte":{"type":"integer","description":"ID do CT-e gerado no Omie."},"cChaveCte":{"type":"string","description":"Chave do CT-e Importado."},"cCodStatus":{"type":"string","description":"Código do Status do processamento."},"cDesStatus":{"type":"string","description":"Descrição do status de processamento."}},"title":"AverbacaoCTe (retorno)"},"produtos_cte_CancelarCTe":{"type":"object","title":"CancelarCTe","description":"Cancela um CT-e.","required":["call","param"],"properties":{"call":{"type":"string","enum":["CancelarCTe"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cAppNome":{"type":"string","maxLength":20,"description":"Nome do Aplicativo que emitiu o CT-e.\n\n\nExemplo:\n\nGeradorCT-e"},"cAppVersao":{"type":"string","maxLength":20,"description":"Versão do Aplicativo que emitiu o CT-e.\n\n\nExemplo:\n\n1.02.01"},"cAppId":{"type":"string","maxLength":100,"description":"Identificação do aplicativo que emitiu o CT-e.\n\n\nExemplo:\n\nMaquina01\n\nPS: Informe o código que identifica a instalação do aplicativo.\nCaso o cliente tenha 2 Emissores de CT-e instalados, ele deve indicar: \"01\" e \"02\" ou \"10\" e \"20\" ou ainda informar o Serial do HD da máquina."},"cChaveCte":{"type":"string","maxLength":44,"description":"Chave do CT-e a ser importado.\n\n\nApenas números com 44 digitos."},"cXmlCteCanc":{"type":"string","description":"Xml de Cancelamento do CT-e.\n\nPreechimento obrigatório.\n\nAntes de enviar, converta os seus seguintes caracteres:\n\n&amp; para &amp;amp;\n> para &amp;gt;\n< para &amp;lt;\n\" para &amp;quot;\n\" para &amp;apos;\n| para &amp;#124;\n\nApós essa conversão aplique o MD5 para enviar no campo \"cMd5CteCanc\".\n\nObservação: Para requisições SOAP usar CDATA como demonstra o exemplo abaixo:\n&lt;![CDATA[Conteúdo do campo convertido]]&gt;"},"cMd5CteCanc":{"type":"string","maxLength":32,"description":"MD5 do arquivo XML importado.\n\n\nAplique o MD5 sobre o XML antes de realizar o consumo."}},"required":["cAppId","cAppNome","cAppVersao","cChaveCte","cMd5CteCanc","cXmlCteCanc"]}}},"example":{"call":"CancelarCTe","param":[{"cAppNome":"GeradorCTe","cAppVersao":"1.01.02","cAppId":"Cte01","cChaveCte":"","cXmlCteCanc":"","cMd5CteCanc":""}]}},"produtos_cte_CancelarCTe_retorno":{"type":"object","properties":{"nIdImportacao":{"type":"integer","description":"ID da Importação do CT-e."},"nIdCte":{"type":"integer","description":"ID do CT-e gerado no Omie."},"cChaveCte":{"type":"string","description":"Chave do CT-e Importado."},"cCodStatus":{"type":"string","description":"Código do Status do processamento."},"cDesStatus":{"type":"string","description":"Descrição do status de processamento."}},"title":"CancelarCTe (retorno)"},"produtos_cte_CartaCorrecaoCTe":{"type":"object","title":"CartaCorrecaoCTe","description":"Carta de Correção da CT-e","required":["call","param"],"properties":{"call":{"type":"string","enum":["CartaCorrecaoCTe"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cAppNome":{"type":"string","maxLength":20,"description":"Nome do Aplicativo que emitiu o CT-e.\n\n\nExemplo:\n\nGeradorCT-e"},"cAppVersao":{"type":"string","maxLength":20,"description":"Versão do Aplicativo que emitiu o CT-e.\n\n\nExemplo:\n\n1.02.01"},"cAppId":{"type":"string","maxLength":100,"description":"Identificação do aplicativo que emitiu o CT-e.\n\n\nExemplo:\n\nMaquina01\n\nPS: Informe o código que identifica a instalação do aplicativo.\nCaso o cliente tenha 2 Emissores de CT-e instalados, ele deve indicar: \"01\" e \"02\" ou \"10\" e \"20\" ou ainda informar o Serial do HD da máquina."},"cChaveCte":{"type":"string","maxLength":44,"description":"Chave do CT-e a ser importado.\n\n\nApenas números com 44 digitos."},"cXmlCteCC":{"type":"string","description":"Xml da Carta de Correção do CT-e.\n\nPreechimento obrigatório.\n\nAntes de enviar, converta os seus seguintes caracteres:\n\n&amp; para &amp;amp;\n> para &amp;gt;\n< para &amp;lt;\n\" para &amp;quot;\n\" para &amp;apos;\n| para &amp;#124;\n\nApós essa conversão aplique o MD5 para enviar no campo \"cMd5CteCC\".\n\nObservação: Para requisições SOAP usar CDATA como demonstra o exemplo abaixo:\n&lt;![CDATA[Conteúdo do campo convertido]]&gt;"},"cMd5CteCC":{"type":"string","maxLength":32,"description":"MD5 do arquivo XML importado.\n\n\nAplique o MD5 sobre o XML antes de realizar o consumo."}},"required":["cAppId","cAppNome","cAppVersao","cChaveCte","cMd5CteCC","cXmlCteCC"]}}},"example":{"call":"CartaCorrecaoCTe","param":[{"cAppNome":"GeradorCTe","cAppVersao":"1.01.02","cAppId":"Cte01","cChaveCte":"","cXmlCteCC":"","cMd5CteCC":""}]}},"produtos_cte_CartaCorrecaoCTe_retorno":{"type":"object","properties":{"nIdImportacao":{"type":"integer","description":"ID da Importação do CT-e."},"nIdCte":{"type":"integer","description":"ID do CT-e gerado no Omie."},"cChaveCte":{"type":"string","description":"Chave do CT-e Importado."},"cCodStatus":{"type":"string","description":"Código do Status do processamento."},"cDesStatus":{"type":"string","description":"Descrição do status de processamento."}},"title":"CartaCorrecaoCTe (retorno)"},"produtos_cte_ExcluirCTe":{"type":"object","title":"ExcluirCTe","description":"Método de exclusão do Conhecimento de Transporte.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirCTe"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdCte":{"type":"integer","maxLength":15}},"required":["nIdCte"]}}},"example":{"call":"ExcluirCTe","param":[{"nIdCte":0}]}},"produtos_cte_ExcluirCTe_retorno":{"type":"object","properties":{"cChaveCte":{"type":"string"},"cCodStatus":{"type":"string"},"cDesStatus":{"type":"string"}},"title":"ExcluirCTe (retorno)"},"produtos_cte_ExcluirFaturaCTe":{"type":"object","title":"ExcluirFaturaCTe","description":"Exclui uma fatura de um grupo de CT-es.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirFaturaCTe"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cAppNome":{"type":"string","maxLength":20,"description":"Nome do Aplicativo que emitiu o CT-e.\n\n\nExemplo:\n\nGeradorCT-e"},"cAppVersao":{"type":"string","maxLength":20,"description":"Versão do Aplicativo que emitiu o CT-e.\n\n\nExemplo:\n\n1.02.01"},"cAppId":{"type":"string","maxLength":100,"description":"Identificação do aplicativo que emitiu o CT-e.\n\n\nExemplo:\n\nMaquina01\n\nPS: Informe o código que identifica a instalação do aplicativo.\nCaso o cliente tenha 2 Emissores de CT-e instalados, ele deve indicar: \"01\" e \"02\" ou \"10\" e \"20\" ou ainda informar o Serial do HD da máquina."},"nIdFaturamento":{"type":"integer","maxLength":15,"description":"ID do faturamento do grupo de CT-es."}},"required":["cAppId","cAppNome","cAppVersao","nIdFaturamento"]}}},"example":{"call":"ExcluirFaturaCTe","param":[{"cAppNome":"GeradorCTe","cAppVersao":"1.01.02","cAppId":"Cte01","nIdFaturamento":0}]}},"produtos_cte_ExcluirFaturaCTe_retorno":{"type":"object","properties":{"nIdFaturamento":{"type":"integer","description":"ID do faturamento do grupo de CT-es."},"cCodStatus":{"type":"string","description":"Código do Status do processamento."},"cDesStatus":{"type":"string","description":"Descrição do status de processamento."}},"title":"ExcluirFaturaCTe (retorno)"},"produtos_cte_FaturarCTe":{"type":"object","title":"FaturarCTe","description":"Gera uma fatura para um grupo de CT-es.","required":["call","param"],"properties":{"call":{"type":"string","enum":["FaturarCTe"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cAppNome":{"type":"string","maxLength":20,"description":"Nome do Aplicativo que emitiu o CT-e.\n\n\nExemplo:\n\nGeradorCT-e"},"cAppVersao":{"type":"string","maxLength":20,"description":"Versão do Aplicativo que emitiu o CT-e.\n\n\nExemplo:\n\n1.02.01"},"cAppId":{"type":"string","maxLength":100,"description":"Identificação do aplicativo que emitiu o CT-e.\n\n\nExemplo:\n\nMaquina01\n\nPS: Informe o código que identifica a instalação do aplicativo.\nCaso o cliente tenha 2 Emissores de CT-e instalados, ele deve indicar: \"01\" e \"02\" ou \"10\" e \"20\" ou ainda informar o Serial do HD da máquina."},"CNPJCliente":{"type":"string","maxLength":20,"description":"CNPJ do Cliente."},"cCategoria":{"type":"string","maxLength":20,"description":"Código da Categoria para geração do título no financeiro."},"nContaCorrente":{"type":"integer","maxLength":15,"description":"Id da Conta Corrente no Omie para a geração do título no financeiro."},"dVencimento":{"type":"string","maxLength":10,"description":"Data de vencimento da fatura.\n\n\nFormato: dd/mm/aaaa."},"nValorFatura":{"type":"number","maxLength":18,"description":"Valor da Fatura."},"cNumeroFatura":{"type":"string","maxLength":20,"description":"Número da Fatura."},"itensFatura":{"type":"array","items":{"type":"object","properties":{"nSeq":{"type":"integer","maxLength":15,"description":"Sequencia do Item da Fatura."},"cChaveCte":{"type":"string","maxLength":44,"description":"Chave do CT-e a ser importado.\n\n\nApenas números com 44 digitos."},"nValorCte":{"type":"number","maxLength":18,"description":"Valor do CT-e.\n\nPreechimento obrigatório."}},"required":["cChaveCte"]},"description":"Itens da Fatura."},"departamentos":{"type":"array","items":{"type":"object","properties":{"idDepartamento":{"type":"string","maxLength":40,"description":"Código do departamento.\n(Gerado internamente, não é visualizado na tela)"},"vDepartamento":{"type":"number","maxLength":18,"description":"Valor do departamento. Preenchimento obrigatório"},"pDepartamento":{"type":"number","maxLength":10,"description":"Percentual do departamento. Preenchimento obrigatório"}},"required":["idDepartamento","pDepartamento","vDepartamento"]},"description":"Distribuição por Departamentos."},"nCliente":{"type":"integer","maxLength":15,"description":"Código do Cliente para geração do título no financeiro."}},"required":["cAppId","cAppNome","cAppVersao","cCategoria","dVencimento","nContaCorrente","nValorFatura"]}}},"example":{"call":"FaturarCTe","param":[{"cAppNome":"GeradorCTe","cAppVersao":"1.01.02","cAppId":"Cte01","CNPJCliente":"","cCategoria":"1.01.02","nContaCorrente":0,"dVencimento":"","nValorFatura":100,"itensFatura":[{"nSeq":1,"cChaveCte":"","nValorCte":30},{"nSeq":2,"cChaveCte":"","nValorCte":70}]}]}},"produtos_cte_FaturarCTe_retorno":{"type":"object","properties":{"nIdFaturamento":{"type":"integer","description":"ID do faturamento do grupo de CT-es."},"cCodStatus":{"type":"string","description":"Código do Status do processamento."},"cDesStatus":{"type":"string","description":"Descrição do status de processamento."}},"title":"FaturarCTe (retorno)"},"produtos_cte_FaturarLoteCTe":{"type":"object","title":"FaturarLoteCTe","description":"Gera uma fatura por lote para um grupo de CT-es.","required":["call","param"],"properties":{"call":{"type":"string","enum":["FaturarLoteCTe"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cAppNome":{"type":"string","maxLength":20,"description":"Nome do Aplicativo que emitiu o CT-e.\n\n\nExemplo:\n\nGeradorCT-e"},"cAppVersao":{"type":"string","maxLength":20,"description":"Versão do Aplicativo que emitiu o CT-e.\n\n\nExemplo:\n\n1.02.01"},"cAppId":{"type":"string","maxLength":100,"description":"Identificação do aplicativo que emitiu o CT-e.\n\n\nExemplo:\n\nMaquina01\n\nPS: Informe o código que identifica a instalação do aplicativo.\nCaso o cliente tenha 2 Emissores de CT-e instalados, ele deve indicar: \"01\" e \"02\" ou \"10\" e \"20\" ou ainda informar o Serial do HD da máquina."},"nIdFaturamentoLote":{"type":"integer","maxLength":15,"description":"Id do faturamento.\n\nPara indicar o início de um novo lote envie 0 (zero) nesse campo.\n\nComo resposta você receberá o nIdFaturamento gerado pelo Omie automaticamente.\n\nNos próximos envios informe o nIdFaturamento recebido para adicionar novos CTes ao lote.\n\nPara concluir o envio de CTes e gerar a fatura do lote informe \"S\" na tag cConcluirFatura.\n\nNa última chamada desse método você pode enviar apenas a tag cConcluirFatura. Opcionalmente, você pode enviar os CTes restantes."},"cConcluirFatura":{"type":"string","maxLength":1},"CNPJCliente":{"type":"string","maxLength":20,"description":"CNPJ do Cliente."},"cCategoria":{"type":"string","maxLength":20,"description":"Código da Categoria para geração do título no financeiro."},"nContaCorrente":{"type":"integer","maxLength":15,"description":"Id da Conta Corrente no Omie para a geração do título no financeiro."},"dVencimento":{"type":"string","maxLength":10,"description":"Data de vencimento da fatura.\n\n\nFormato: dd/mm/aaaa."},"nValorFatura":{"type":"number","maxLength":18,"description":"Valor da Fatura."},"cNumeroFatura":{"type":"string","maxLength":20,"description":"Número da Fatura."},"cListaChavesCTes":{"type":"string"},"itensFaturaLote":{"type":"array","items":{"type":"object","properties":{"cChaveCte":{"type":"string","maxLength":44,"description":"Chave do CT-e a ser importado.\n\n\nApenas números com 44 digitos."},"nValorCte":{"type":"number","maxLength":18,"description":"Valor do CT-e.\n\nPreechimento obrigatório."}},"required":["cChaveCte"]},"description":"Itens da Fatura."},"departamentos":{"type":"array","items":{"type":"object","properties":{"idDepartamento":{"type":"string","maxLength":40,"description":"Código do departamento.\n(Gerado internamente, não é visualizado na tela)"},"vDepartamento":{"type":"number","maxLength":18,"description":"Valor do departamento. Preenchimento obrigatório"},"pDepartamento":{"type":"number","maxLength":10,"description":"Percentual do departamento. Preenchimento obrigatório"}},"required":["idDepartamento","pDepartamento","vDepartamento"]},"description":"Distribuição por Departamentos."},"nCliente":{"type":"integer","maxLength":15,"description":"Código do Cliente para geração do título no financeiro."}},"required":["cAppNome","cAppVersao"]}}},"example":{"call":"FaturarLoteCTe","param":[{"cAppNome":"GeradorCTe","cAppVersao":"1.01.02","cAppId":"Cte01","nIdFaturamento":0,"CNPJCliente":"","cConcluirFatura":"N","itensFatura":[{"nSeq":1,"cChaveCte":"","nValorCte":30},{"nSeq":2,"cChaveCte":"","nValorCte":70}]}]}},"produtos_cte_FaturarLoteCTe_retorno":{"type":"object","properties":{"nIdFaturamentoLote":{"type":"integer","description":"Id do faturamento. Para indicar o início de um novo lote envie 0 (zero) nesse campo. Como resposta você receberá o nIdFaturamento gerado pelo Omie automaticamente. Nos próximos envios informe o nIdFaturamento recebido para adicionar novos CTes ao lote. Para concluir o envio de CTes e gerar a fatura do lote informe \"S\" na tag cConcluirFatura. Na última chamada desse método você pode enviar apenas a tag cConcluirFatura. Opcionalmente, você pode enviar os CTes restantes."},"cCodStatus":{"type":"string","description":"Código do Status do processamento."},"cDesStatus":{"type":"string","description":"Descrição do status de processamento."}},"title":"FaturarLoteCTe (retorno)"},"produtos_cte_ImportarCTe":{"type":"object","title":"ImportarCTe","description":"Importar o XML de um CT-e.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ImportarCTe"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cAppNome":{"type":"string","maxLength":20,"description":"Nome do Aplicativo que emitiu o CT-e.\n\n\nExemplo:\n\nGeradorCT-e"},"cAppVersao":{"type":"string","maxLength":20,"description":"Versão do Aplicativo que emitiu o CT-e.\n\n\nExemplo:\n\n1.02.01"},"cAppId":{"type":"string","maxLength":100,"description":"Identificação do aplicativo que emitiu o CT-e.\n\n\nExemplo:\n\nMaquina01\n\nPS: Informe o código que identifica a instalação do aplicativo.\nCaso o cliente tenha 2 Emissores de CT-e instalados, ele deve indicar: \"01\" e \"02\" ou \"10\" e \"20\" ou ainda informar o Serial do HD da máquina."},"cChaveCte":{"type":"string","maxLength":44,"description":"Chave do CT-e a ser importado.\n\n\nApenas números com 44 digitos."},"cXmlCte":{"type":"string","description":"Xml do CT-e a ser importado.\n\n\nAntes de enviar, converta os seus seguintes caracteres:\n\n&amp; para &amp;amp;\n> para &amp;gt;\n< para &amp;lt;\n\" para &amp;quot;\n\" para &amp;apos;\n| para &amp;#124;\n\nApós essa conversão aplique o MD5 para enviar no campo \"cMd5Cte\".\n\nObservação: Para requisições SOAP usar CDATA como demonstra o exemplo abaixo:\n&lt;![CDATA[Conteúdo do campo convertido]]&gt;"},"cMd5Cte":{"type":"string","maxLength":32,"description":"MD5 do arquivo XML importado.\n\n\nAplique o MD5 sobre o XML antes de realizar o consumo."},"cCategoria":{"type":"string","maxLength":20,"description":"Código da Categoria para geração do título no financeiro."},"nContaCorrente":{"type":"integer","maxLength":15,"description":"Id da Conta Corrente no Omie para a geração do título no financeiro."},"lNaoGerarCR":{"type":"boolean","description":"Não gerar título de contas a receber para o CT-e.\n\nPode ser:\ntrue - inibe a geração do título de Contas a Receber no financeiro.\nfalse - Gera o ítulo de Contas a Receber no financeiro.\n\nO padrão é false."},"nVendedor":{"type":"integer","maxLength":15,"description":"Código do Vendedor para geração do título no financeiro."},"nProjeto":{"type":"integer","maxLength":15,"description":"Código do Projeto para geração do título no financeiro."},"nCliente":{"type":"integer","maxLength":15,"description":"Código do Cliente para geração do título no financeiro."},"cObs":{"type":"string","description":"Observações do CT-e para geração do título no financeiro."},"pis_cst":{"type":"string","maxLength":2,"description":"Código da Situação Tributária do PIS."},"pis_aliquota":{"type":"number","maxLength":10,"description":"Alíquota do PIS."},"cofins_cst":{"type":"string","maxLength":2,"description":"Código da Situação Tributária do COFINS."},"cofins_aliquota":{"type":"number","maxLength":10,"description":"Alíquota do COFINS."},"departamentos":{"type":"array","items":{"type":"object","properties":{"idDepartamento":{"type":"string","maxLength":40,"description":"Código do departamento.\n(Gerado internamente, não é visualizado na tela)"},"vDepartamento":{"type":"number","maxLength":18,"description":"Valor do departamento. Preenchimento obrigatório"},"pDepartamento":{"type":"number","maxLength":10,"description":"Percentual do departamento. Preenchimento obrigatório"}},"required":["idDepartamento","pDepartamento","vDepartamento"]},"description":"Distribuição por Departamentos."}},"required":["cAppId","cAppNome","cAppVersao","cChaveCte","cMd5Cte","cXmlCte"]}}},"example":{"call":"ImportarCTe","param":[{"cAppNome":"GeradorCTe","cAppVersao":"1.01.02","cAppId":"Cte01","cChaveCte":"","cXmlCte":"","cMd5Cte":"","cCategoria":"1.01.02","nContaCorrente":0}]}},"produtos_cte_ImportarCTe_retorno":{"type":"object","properties":{"nIdImportacao":{"type":"integer","description":"ID da Importação do CT-e."},"nIdCte":{"type":"integer","description":"ID do CT-e gerado no Omie."},"cChaveCte":{"type":"string","description":"Chave do CT-e Importado."},"cCodStatus":{"type":"string","description":"Código do Status do processamento."},"cDesStatus":{"type":"string","description":"Descrição do status de processamento."}},"title":"ImportarCTe (retorno)"},"produtos_cte_ListarNFeTransp":{"type":"object","title":"ListarNFeTransp","description":"Listar as NFes na qual a empresa é mencionada como Transportadora.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarNFeTransp"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15},"nRegPorPagina":{"type":"integer","maxLength":15},"dEmiInicial":{"type":"string","maxLength":10,"description":"Data de emissão inicial."},"hEmiInicial":{"type":"string","maxLength":8,"description":"Hora de emissão inicial."},"dEmiFinal":{"type":"string","maxLength":10,"description":"Data de emissão final."},"hEmiFinal":{"type":"string","maxLength":8,"description":"Hora de emissão final."},"chNFe":{"type":"string","maxLength":44,"description":"Chave da nota fiscal."},"tpNF":{"type":"string","maxLength":1,"description":"Tipo de nota fiscal.\nPode ser:\n0 - Entrada.\n1 - Saída."}}}}},"example":{"call":"ListarNFeTransp","param":[{"nPagina":1,"nRegPorPagina":20}]}},"produtos_cte_ListarNFeTransp_retorno":{"type":"object","properties":{"nPagina":{"type":"integer"},"nTotPaginas":{"type":"integer"},"nRegistros":{"type":"integer"},"nTotRegistros":{"type":"integer"},"nfeEncontradas":{"type":"array","items":{"type":"object","properties":{"emitCNPJ":{"type":"string","description":"CNPJ do emitente da NF-e."},"destCNPJ":{"type":"string","description":"CNPJ do destinário da NF-e."},"chNFe":{"type":"string","description":"Chave da NF-e."},"nProt":{"type":"integer","description":"Número do protocolo da NF-e."},"dEmi":{"type":"string","description":"Data de emissão da NF-e."},"hEmi":{"type":"string","description":"Hora de emissão da NF-e."},"versao":{"type":"string","description":"Versão do XML da NF-e."},"tpNF":{"type":"string","description":"Tipo de nota fiscal. Pode ser: 0 - Entrada. 1 - Saída."},"vNF":{"type":"decimal","description":"Valor da nota fiscal."},"cXmlNFe":{"type":"string","description":"XML da nota fiscal."}}},"description":"Lista de NF-es encontradas."}},"title":"ListarNFeTransp (retorno)"},"produtos_cte_StatusFatura":{"type":"object","title":"StatusFatura","description":"Retorna o Status da Fatura inclusa.","required":["call","param"],"properties":{"call":{"type":"string","enum":["StatusFatura"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cAppNome":{"type":"string","maxLength":20,"description":"Nome do Aplicativo que emitiu o CT-e.\n\n\nExemplo:\n\nGeradorCT-e"},"cAppVersao":{"type":"string","maxLength":20,"description":"Versão do Aplicativo que emitiu o CT-e.\n\n\nExemplo:\n\n1.02.01"},"cAppId":{"type":"string","maxLength":100,"description":"Identificação do aplicativo que emitiu o CT-e.\n\n\nExemplo:\n\nMaquina01\n\nPS: Informe o código que identifica a instalação do aplicativo.\nCaso o cliente tenha 2 Emissores de CT-e instalados, ele deve indicar: \"01\" e \"02\" ou \"10\" e \"20\" ou ainda informar o Serial do HD da máquina."},"nIdFaturamento":{"type":"integer","maxLength":15,"description":"ID do faturamento do grupo de CT-es."}},"required":["cAppId","cAppNome","cAppVersao","nIdFaturamento"]}}},"example":{"call":"StatusFatura","param":[{"cAppNome":"GeradorCTe","cAppVersao":"1.01.02","cAppId":"Cte01","nIdFaturamento":0}]}},"produtos_cte_StatusFatura_retorno":{"type":"object","properties":{"cAppNome":{"type":"string","description":"Nome do Aplicativo que emitiu o CT-e. Exemplo: GeradorCT-e"},"cAppVersao":{"type":"string","description":"Versão do Aplicativo que emitiu o CT-e. Exemplo: 1.02.01"},"cAppId":{"type":"string","description":"Identificação do aplicativo que emitiu o CT-e. Exemplo: Maquina01 PS: Informe o código que identifica a instalação do aplicativo. Caso o cliente tenha 2 Emissores de CT-e instalados, ele deve indicar: \"01\" e \"02\" ou \"10\" e \"20\" ou ainda informar o Serial do HD da máquina."},"cChaveCte":{"type":"string","description":"Chave do CT-e a ser importado. Apenas números com 44 digitos."},"nCliente":{"type":"integer","description":"Código do Cliente para geração do título no financeiro."},"cCategoria":{"type":"string","description":"Código da Categoria para geração do título no financeiro."},"nContaCorrente":{"type":"integer","description":"Id da Conta Corrente no Omie para a geração do título no financeiro."},"nVendedor":{"type":"integer","description":"Código do Vendedor para geração do título no financeiro."},"nValorCte":{"type":"decimal","description":"Valor do CT-e."},"nIdFaturamento":{"type":"integer","description":"ID do faturamento do grupo de CT-es."},"dVencimento":{"type":"string","description":"Data de vencimento da fatura."},"dEmi":{"type":"string","description":"Data de emissão inicial."},"hEmi":{"type":"string","description":"Hora de emissão inicial."},"nQtdeCte":{"type":"integer","description":"Quantidade de CTe importadas"},"cExcluido":{"type":"string","description":"Indica se está excluido."},"dExclusao":{"type":"string","description":"Data de Exclusão."},"cStatus":{"type":"string","description":"Status da Fatura."}},"title":"StatusFatura (retorno)"},"produtos_cupomfiscal_CancelarCupom":{"type":"object","title":"CancelarCupom","description":"Cancela um cupom fiscal.","required":["call","param"],"properties":{"call":{"type":"string","enum":["CancelarCupom"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdCupom":{"type":"integer","maxLength":15,"description":"ID do Cupom Fiscal."}},"required":["nIdCupom"]}}},"example":{"call":"CancelarCupom","param":[{"nIdCupom":0}]}},"produtos_cupomfiscal_CancelarCupom_retorno":{"type":"object","properties":{"nIdCupom":{"type":"integer","description":"ID do Cupom Fiscal."},"cCodStatus":{"type":"string","description":"Código do Status do processamento."},"cDesStatus":{"type":"string","description":"Descrição do status de processamento."}},"title":"CancelarCupom (retorno)"},"produtos_cupomfiscal_CancelarNFCE":{"type":"object","title":"CancelarNFCE","description":"Cancelar NFC-e.","required":["call","param"],"properties":{"call":{"type":"string","enum":["CancelarNFCE"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodigoPDV":{"type":"string","maxLength":20,"description":"Código do PDV."},"nNumeroCaixa":{"type":"integer","maxLength":15,"description":"Número do Caixa."},"cDataEmissao":{"type":"string","maxLength":10,"description":"Data de Emissão do Cupom Fiscal.\n\nNo formato \"dd/mm/aaaa\"."},"IdenticacaoNFCE":{"type":"object","properties":{"nNumeroNFCE":{"type":"string","maxLength":20,"description":"Número do NFC-e."},"nSerieNFCE":{"type":"string","maxLength":4,"description":"Número de Série da NFC-e."},"nChaveNFCE":{"type":"string","maxLength":44,"description":"Chave da NFC-e."}},"required":["nChaveNFCE","nNumeroNFCE","nSerieNFCE"],"description":"Indicação da NFC-e."},"DadosCancNFCE":{"type":"object","properties":{"nProtCancNFCE":{"type":"string","maxLength":30,"description":"Número do Protocolo de Cancelamento da NFC-e."},"nChaveCancNFCE":{"type":"string","maxLength":44,"description":"Chave de Cancelamento da NFC-e."},"cXmlCancNFCE":{"type":"string","description":"XML de Cancelamento da NFC-e."},"cDataCancelamento":{"type":"string","maxLength":10,"description":"Data de Cancelamento.\n\nNo formato \"dd/mm/aaaa\"."},"cHoraCancelamento":{"type":"string","maxLength":10,"description":"Hora de Cancelamento.\n\nNo formato \"hh:mm:ss\"."}},"required":["cDataCancelamento","cHoraCancelamento","cXmlCancNFCE","nChaveCancNFCE","nProtCancNFCE"],"description":"Dados do Cancelamento da NFC-e."}},"required":["cDataEmissao","nCodigoPDV","nNumeroCaixa"]}}},"example":{"call":"CancelarNFCE","param":[{"nCodigoPDV":0,"nNumeroCaixa":0,"cDataEmissao":"","IdenticacaoNFCE":{"nNumeroNFCE":0,"nSerieNFCE":0,"nChaveNFCE":""},"DadosCancNFCE":{"nProtCancNFCE":0,"nChaveCancNFCE":"","cXmlCancNFCE":"","cDataCancelamento":"","cHoraCancelamento":""}}]}},"produtos_cupomfiscal_CancelarNFCE_retorno":{"type":"object","properties":{"nIdCupom":{"type":"integer","description":"ID do Cupom Fiscal."},"cCodStatus":{"type":"string","description":"Código do Status do processamento."},"cDesStatus":{"type":"string","description":"Descrição do status de processamento."}},"title":"CancelarNFCE (retorno)"},"produtos_cupomfiscal_CancelarSAT":{"type":"object","title":"CancelarSAT","description":"Cancelar CF-e-SAT.","required":["call","param"],"properties":{"call":{"type":"string","enum":["CancelarSAT"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodigoPDV":{"type":"string","maxLength":20,"description":"Código do PDV."},"nNumeroCaixa":{"type":"integer","maxLength":15,"description":"Número do Caixa."},"cDataEmissao":{"type":"string","maxLength":10,"description":"Data de Emissão do Cupom Fiscal.\n\nNo formato \"dd/mm/aaaa\"."},"IdenticacaoSAT":{"type":"object","properties":{"nNumeroSAT":{"type":"integer","maxLength":15,"description":"Número do CF-e-SAT."},"nChaveSAT":{"type":"string","maxLength":44,"description":"Chave da CF-e-SAT."},"cNumeroSerieSAT":{"type":"string","maxLength":20,"description":"Número de Série do Equipamento SAT."}},"required":["cNumeroSerieSAT","nChaveSAT","nNumeroSAT"],"description":"Indicação do CF-e-SAT."},"DadosCancSAT":{"type":"object","properties":{"nProtCancSAT":{"type":"integer","maxLength":20,"description":"Número do Protocolo de Cancelamento do CF-e-SAT."},"nChaveCancSAT":{"type":"string","maxLength":44,"description":"Número do Protocolo de Cancelamento do CF-e-SAT."},"cXmlCancSAT":{"type":"string","description":"XML de Cancelamento do CF-e-SAT."},"cDataCancelamento":{"type":"string","maxLength":10,"description":"Data de Cancelamento.\n\nNo formato \"dd/mm/aaaa\"."},"cHoraCancelamento":{"type":"string","maxLength":10,"description":"Hora de Cancelamento.\n\nNo formato \"hh:mm:ss\"."}},"required":["cDataCancelamento","cHoraCancelamento","cXmlCancSAT","nChaveCancSAT","nProtCancSAT"],"description":"Dados do Cancelamento do CF-e-SAT."}},"required":["cDataEmissao","nCodigoPDV","nNumeroCaixa"]}}},"example":{"call":"CancelarSAT","param":[{"nCodigoPDV":0,"nNumeroCaixa":0,"cDataEmissao":"","IdenticacaoSAT":{"nNumeroSAT":0,"nChaveSAT":"","cNumeroSerieSAT":""},"DadosCancSAT":{"nProtCancSAT":0,"nChaveCancSAT":"","cXmlCancSAT":"","cDataCancelamento":"","cHoraCancelamento":""}}]}},"produtos_cupomfiscal_CancelarSAT_retorno":{"type":"object","properties":{"nIdCupom":{"type":"integer","description":"ID do Cupom Fiscal."},"cCodStatus":{"type":"string","description":"Código do Status do processamento."},"cDesStatus":{"type":"string","description":"Descrição do status de processamento."}},"title":"CancelarSAT (retorno)"},"produtos_cupomfiscal_DevolverCupom":{"type":"object","title":"DevolverCupom","description":"Realiza a inclusão da devolução do cupom fiscal.","required":["call","param"],"properties":{"call":{"type":"string","enum":["DevolverCupom"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdCupom":{"type":"integer","maxLength":15,"description":"ID do Cupom Fiscal."},"nIdMotivDevol":{"type":"integer","maxLength":15,"description":"ID do motivo da devolução.\n\n\nLista de motivo de devolução em:\n/api/v1/geral/motivodevolucao/"},"nIdCliente":{"type":"integer","maxLength":15,"description":"Código do cliente.\nCaso o cliente não seja informado, será assumido o cliente apontado no Cupom Fiscal\n\nUtilize a tag \"codigo_cliente_omie\" do método \"ListarClientes\" da API\n/api/v1/geral/clientes/\npara obter essa informação."},"itens":{"type":"array","items":{"type":"object","properties":{"nIdItem":{"type":"integer","maxLength":15,"description":"ID do item do cupom fiscal.\nEssa informação não é exibida nas telas do Omie.\n\n\nLista com os itens do cupom em:\n/api/v1/produtos/cupomfiscalconsultar/#CuponsFiscais"},"nQuant":{"type":"string","maxLength":1,"description":"Quantidade do produto a ser devolvida.\n\n\nCaso não seja preenchida será feita a devolução integral do produto."}},"required":["nIdItem"]},"description":"Informações dos produtos que serão devolvidos.\n\nCaso essa tag não seja preenchida será realizado a devolução integral de todos os produtos do cupom fiscal."}},"required":["nIdCupom","nIdMotivDevol"]}}},"example":{"call":"DevolverCupom","param":[{"nIdCupom":0,"nIdMotivDevol":0,"itens":[{"nIdItem":0,"nQuant":0}]}]}},"produtos_cupomfiscal_DevolverCupom_retorno":{"type":"object","properties":{"nIdDevolucao":{"type":"integer","description":"ID da devolução."},"cCodStatus":{"type":"string","description":"Código do Status do processamento."},"cDesStatus":{"type":"string","description":"Descrição do status de processamento."}},"title":"DevolverCupom (retorno)"},"produtos_cupomfiscal_ExcluirCupom":{"type":"object","title":"ExcluirCupom","description":"Exclui um Cupom Fiscal.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirCupom"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdCupom":{"type":"integer","maxLength":15,"description":"ID do Cupom Fiscal."}},"required":["nIdCupom"]}}},"example":{"call":"ExcluirCupom","param":[{"nIdCupom":0}]}},"produtos_cupomfiscal_ExcluirCupom_retorno":{"type":"object","properties":{"nIdCupom":{"type":"integer","description":"ID do Cupom Fiscal."},"cCodStatus":{"type":"string","description":"Código do Status do processamento."},"cDesStatus":{"type":"string","description":"Descrição do status de processamento."}},"title":"ExcluirCupom (retorno)"},"produtos_cupomfiscal_ExcluirCuponsPorNumero":{"type":"object","title":"ExcluirCuponsPorNumero","description":"Excluir cupons por número.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirCuponsPorNumero"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodigoPDV":{"type":"string","maxLength":20,"description":"Código do PDV."},"nNumeroCaixa":{"type":"integer","maxLength":15,"description":"Número do Caixa."},"cDataEmissao":{"type":"string","maxLength":10,"description":"Data de Emissão do Cupom Fiscal.\n\nNo formato \"dd/mm/aaaa\"."},"nNumCupom":{"type":"integer","maxLength":15,"description":"Número do Cupom Fiscal."}},"required":["cDataEmissao","nCodigoPDV","nNumCupom","nNumeroCaixa"]}}},"example":{"call":"ExcluirCuponsPorNumero","param":[{"nCodigoPDV":0,"nNumeroCaixa":0,"cDataEmissao":"","nNumCupom":0}]}},"produtos_cupomfiscal_ExcluirCuponsPorNumero_retorno":{"type":"object","properties":{"nIdCupom":{"type":"integer","description":"ID do Cupom Fiscal."},"cCodStatus":{"type":"string","description":"Código do Status do processamento."},"cDesStatus":{"type":"string","description":"Descrição do status de processamento."}},"title":"ExcluirCuponsPorNumero (retorno)"},"produtos_cupomfiscal_ExcluirLote":{"type":"object","title":"ExcluirLote","description":"Excluir o lote.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirLote"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nNumLote":{"type":"integer","maxLength":15,"description":"Número do Lote do Cupom Fiscal."}},"required":["nNumLote"]}}},"example":{"call":"ExcluirLote","param":[{"nNumLote":0}]}},"produtos_cupomfiscal_ExcluirLote_retorno":{"type":"object","properties":{"nNumLote":{"type":"integer","description":"Número do Lote do Cupom Fiscal."},"cCodStatus":{"type":"string","description":"Código do Status do processamento."},"cDesStatus":{"type":"string","description":"Descrição do status de processamento."}},"title":"ExcluirLote (retorno)"},"produtos_cupomfiscal_ListarCupons":{"type":"object","title":"ListarCupons","description":"Lista os Cupons Fiscais.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarCupons"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página que se deseja resgatar.\nO padrão é \"1\"."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Número de registros retornados por página.\nO padrão é 20.\nO limite máximo é 50 por página."},"cOrdenarPor":{"type":"string","maxLength":100,"description":"Ordem os resultados da página por:\nNUMCUPOM - Número do Cupom Fiscal.\nNUMVENDA - Número da Venda.\nDATAEMISSAO - Data de Emissão."},"cOrdemDecrescente":{"type":"string","maxLength":1,"description":"Indica se a ordem de exibição é Decrescente caso seja informado \"S\"."},"dDtEmisInicial":{"type":"string","maxLength":10,"description":"Data de emissão inicial.\nNo formato dd/mm/aaaa."},"dDtEmisFinal":{"type":"string","maxLength":10,"description":"Data de emissão final.\nNo formato dd/mm/aaaa."},"nNumLote":{"type":"integer","maxLength":15,"description":"Número do Lote do Cupom Fiscal."},"nNumMovimento":{"type":"integer","maxLength":15,"description":"Número do movimento (caixa)."},"cAcao":{"type":"string","maxLength":3,"description":"Ação realizada.\nPode ser:\nADD - Adiciona um cupom.\nTMP - Adiciona um cupom de um caixa em aberto.\nCAN - Cupom Cancelado.\nCTG - Cupom em Contingência.\nINU - Cupom Inutilizado."},"cModelo":{"type":"string","maxLength":2,"description":"Modelo de Cupom Fiscal.\nPode ser:\n00 - ECF\n59 - CFe-SAT\n65 - NFC-e"},"cProcessado":{"type":"string","maxLength":1,"description":"Cupom Fiscal foi processado (S/N)?"},"cCaixaFechado":{"type":"string","maxLength":1,"description":"Caixa está fechado (S/N)?"},"cCancelado":{"type":"string","maxLength":1,"description":"Cupom Fiscal Cancelado (S/N)?"},"cErro":{"type":"string","maxLength":1,"description":"Cupom Fiscal com erro no processamento (S/N)?"},"nCOO":{"type":"integer","maxLength":15,"description":"Número do COO."},"nCCF":{"type":"integer","maxLength":15,"description":"Número do CCF."},"cNumeroSerieECF":{"type":"string","maxLength":20,"description":"Número de Série da Impressora Fiscal."},"nNumeroSAT":{"type":"integer","maxLength":15,"description":"Número do CF-e-SAT."},"nChaveSAT":{"type":"string","maxLength":44,"description":"Chave da CF-e-SAT."},"nNumeroNFCE":{"type":"string","maxLength":20,"description":"Número do NFC-e."},"nSerieNFCE":{"type":"string","maxLength":4,"description":"Número de Série da NFC-e."},"nChaveNFCE":{"type":"string","maxLength":44,"description":"Chave da NFC-e."},"nCodigoPDV":{"type":"string","maxLength":20,"description":"Código do PDV."}}}}},"example":{"call":"ListarCupons","param":[{"nPagina":1,"nRegPorPagina":50,"dDtEmisInicial":"","dDtEmisFinal":""}]}},"produtos_cupomfiscal_ListarCupons_retorno":{"type":"object","properties":{"nPagina":{"type":"integer","description":"Número da página resgatada."},"nTotPaginas":{"type":"integer","description":"Número total de páginas encontradas."},"nRegistros":{"type":"integer","description":"Número de registros retornados na página."},"nTotRegistros":{"type":"integer","description":"Número total de registros encontrados."},"listaCupons":{"type":"array","items":{"type":"object","properties":{"nNumLote":{"type":"integer","description":"Número do Lote do Cupom Fiscal."},"nNumMovimento":{"type":"integer","description":"Número do Movimento (Caixa)."},"dDtEmissao":{"type":"string","description":"Data de emissão do Cupom Fiscal."},"cHrEmisao":{"type":"string","description":"Hora de emissão de Cupom Fiscal."},"nNumVenda":{"type":"integer","description":"Numero da venda."},"nNumCupom":{"type":"integer","description":"Número do Cupom Fiscal."},"nValorNF":{"type":"decimal","description":"Valor do Cupom Fiscal."},"cProcessado":{"type":"string","description":"Cupom Fiscal foi processado (S/N)? Também como retornar como 'E' indicando que o cupom foi excluído."},"cCaixaFechado":{"type":"string","description":"Caixa está fechado (S/N)?"},"cCancelado":{"type":"string","description":"Cupom Fiscal Cancelado (S/N)?"},"cErro":{"type":"string","description":"Cupom Fiscal com erro no processamento (S/N)?"},"cAcao":{"type":"string","description":"Ação realizada. Pode ser: ADD - Adiciona um cupom. TMP - Adiciona um cupom de um caixa em aberto. CAN - Cupom Cancelado. CTG - Cupom em Contingência. INU - Cupom Inutilizado. EXC - Cupom Excluído."},"cModelo":{"type":"string","description":"Modelo de Cupom Fiscal. Pode ser: 00 - ECF 59 - CFe-SAT 65 - NFC-e"},"cChave":{"type":"string","description":"Chave do Cupom Fiscal."},"nIdCupom":{"type":"integer","description":"ID do Cupom Fiscal."}}},"description":"Lista de Cupons Fiscais."}},"title":"ListarCupons (retorno)"},"produtos_cupomfiscal_ObterProximoLote":{"type":"object","title":"ObterProximoLote","description":"Retorna o próximo número de lote disponível.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterProximoLote"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodigoPDV":{"type":"string","maxLength":20,"description":"Código do PDV."}}}}},"example":{"call":"ObterProximoLote","param":[{"nCodigoPDV":""}]}},"produtos_cupomfiscal_ObterProximoLote_retorno":{"type":"object","properties":{"nNumLote":{"type":"integer","description":"Número do Lote do Cupom Fiscal."}},"title":"ObterProximoLote (retorno)"},"produtos_cupomfiscalconsultar_CuponsFiscais":{"type":"object","title":"CuponsFiscais","description":"Listagem dos cupons fiscais.","required":["call","param"],"properties":{"call":{"type":"string","enum":["CuponsFiscais"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página a ser recuperada."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Número de registros por página.\n(máximo 500)."},"dDtEmissaoDe":{"type":"string","maxLength":10,"description":"Data de emissão do Cupom Fiscal - De.\nNo formato dd/mm/aaaa."},"dDtEmissaoAte":{"type":"string","maxLength":10,"description":"Data de emissão do Cupom Fiscal - Até.\nNo formato dd/mm/aaaa."},"dDtInclusaoDe":{"type":"string","maxLength":10,"description":"Data de Inclusão do Cupom Fiscal - De.\nNo formato dd/mm/aaaa."},"dDtInclusaoAte":{"type":"string","maxLength":10,"description":"Data de Inclusão do Cupom Fiscal - Até.\nNo formato dd/mm/aaaa."},"dDtAlteracaoDe":{"type":"string","maxLength":10,"description":"Data da Alteração do Cupom Fiscal - De.\nNo formato dd/mm/aaaa."},"dDtAlteracaoAte":{"type":"string","maxLength":10,"description":"Data da Alteração do Cupom Fiscal - Até.\nNo formato dd/mm/aaaa."}}}}},"example":{"call":"CuponsFiscais","param":[{"nPagina":1,"nRegPorPagina":50}]}},"produtos_cupomfiscalconsultar_CuponsFiscais_retorno":{"type":"object","properties":{"nPagina":{"type":"integer"},"nTotPaginas":{"type":"integer"},"nRegistros":{"type":"integer"},"nTotRegistros":{"type":"integer"},"cupons":{"type":"array","items":{"type":"object","properties":{"cabecalhoCupom":{"type":"object","properties":{"nIdCupom":{"type":"integer","description":"ID do Cupom Fiscal."},"cModeloCupom":{"type":"string","description":"Modelo de Cupom Fiscal. Pode ser: 00 - ECF 59 - CFe-SAT 65 - NFC-e"},"nNumCupom":{"type":"integer","description":"Número do Cupom Fiscal."},"nSerieCupom":{"type":"string","description":"Série do Cupom Fiscal."},"seqCaixa":{"type":"integer","description":"Número sequencial do Caixa."},"cChaveCupom":{"type":"string","description":"Chave do Cupom Fiscal."},"seqCupom":{"type":"integer","description":"Numero sequencial do cupom."},"nValorCupom":{"type":"decimal","description":"Valor do Cupom Fiscal."},"dDtEmissaoCupom":{"type":"string","description":"Data de emissão do Cupom Fiscal."},"cHrEmisaoCupom":{"type":"string","description":"Hora de emissão de Cupom Fiscal."},"idCliente":{"type":"integer","description":"Código do cliente."},"cContingencia":{"type":"string","description":"Indica se o Cupom Fiscal foi Emitido em ambiente de Contingencia. (S/N)."},"nValorTaxa":{"type":"decimal","description":"Valor da Taxa."},"nValorPIS":{"type":"decimal","description":"Valor do PIS."},"nValorCOFINS":{"type":"decimal","description":"Valor do COFINS."},"nValorICMS":{"type":"decimal","description":"Valor do ICMS."},"idVendedor":{"type":"integer","description":"Código do Vendedor."},"info":{"type":"object","properties":{"dDtInclusao":{"type":"string","description":"Data de Inclusão do Documento."},"cHrInclusao":{"type":"string","description":"Hora da Inclusão do Cupom Fiscal. No formato hh:mm:ss."},"uInc":{"type":"string","description":"Usuário da Inclusão do Cupom Fiscal."},"dDtAlteracao":{"type":"string","description":"Data de Alteração do Documento."},"cHrAlteracao":{"type":"string","description":"Hora da Alteração do Cupom Fiscal. No formato hh:mm:ss."},"uAlt":{"type":"string","description":"Usuário da Alteração do Cupom Fiscal."},"cCupomCancelado":{"type":"string","description":"Cupom Fiscal Cancelado (S/N)?"},"cCupomDevolvido":{"type":"string","description":"Cupom Fiscal Devolvido (S/N)?"}},"description":"Informações adicionais do Cupom Fiscal."}},"description":"Informações do cabeçalho do Cupom Fiscal."},"itensCupom":{"type":"array","items":{"type":"object","properties":{"idItem":{"type":"integer","description":"ID do item do cupom fiscal."},"idProduto":{"type":"integer","description":"ID do produto do item do cupom fiscal."},"nQuant":{"type":"decimal","description":"Quantidade do item do cupom fiscal."},"vUnit":{"type":"decimal","description":"Valor unitário do item do cupom fiscal."},"vDesc":{"type":"decimal","description":"Valor desconto do item do cupom fiscal."},"vAcresc":{"type":"decimal","description":"Valor acréscimo do item do cupom fiscal."},"vItem":{"type":"decimal","description":"Valor líquido do item do cupom fiscal."},"nAliqPIS":{"type":"decimal","description":"Alíquota do PIS."},"nValorPIS":{"type":"decimal","description":"Valor do PIS."},"nAliqCOFINS":{"type":"decimal","description":"Alíquota do COFINS."},"nValorCOFINS":{"type":"decimal","description":"Valor do COFINS."},"nAliqICMS":{"type":"decimal","description":"Alíquota do ICMS."},"nValorICMS":{"type":"decimal","description":"Valor do ICMS."},"cCFOP":{"type":"string","description":"CFOP do Item."},"cNCM":{"type":"string","description":"NCM do Item."},"xProd":{"type":"string","description":"Descrição do item do cupom fiscal."},"cUn":{"type":"string","description":"Unidade do item do cupom fiscal."},"cCodigo":{"type":"string","description":"Código do Produto no Cupom Fiscal."},"emiProduto":{"type":"string","description":"Código do PDV do item do cupom fiscal."},"nValorOutros":{"type":"decimal","description":"Outros valores."},"cItemCancelado":{"type":"string","description":"Item do Cupom Fiscal Cancelado (S/N)?"},"cItemDevolvido":{"type":"string","description":"Item do Cupom Fiscal Devolvido (S/N)?"},"nSequencia":{"type":"integer","description":"Sequência do item no Cupom Fiscal."}}},"description":"Informações dos Itens do Cupom Fiscal."},"pagamentosCupom":{"type":"array","items":{"type":"object","properties":{"nCodTitulo":{"type":"integer","description":"Código do título."},"nValorDocumento":{"type":"decimal","description":"Valor do Documento."},"idContaCorrente":{"type":"integer","description":"Código da Conta Corrente."},"cTipoDoc":{"type":"string","description":"Tipo de Documento. Pode ser: 99999 - Outros BOL - Boleto CHQ - Cheque CHT - Cheque de Terceiros CRC - Cartão de Crédito CRD - Cartão de Débito CRE - Creadiário CRT - Cartão DIN - Dinheiro PIX - Pix"},"dDtVencimento":{"type":"string","description":"Data de Vencimento do Documento."},"cNumParcela":{"type":"string","description":"Número da parcela."},"nValorTaxa":{"type":"decimal","description":"Valor da Taxa."},"cCategoria":{"type":"string","description":"Código da Categoria."},"nSequencia":{"type":"integer","description":"Sequência do item no Cupom Fiscal."}}},"description":"Informações dos Pagamentos do Cupom Fiscal."}}},"description":"Lista de Cupons Fiscais."}},"title":"CuponsFiscais (retorno)"},"produtos_cupomfiscalconsultar_CuponsItens":{"type":"object","title":"CuponsItens","description":"Listagem dos itens dos cupons fiscais.","required":["call","param"],"properties":{"call":{"type":"string","enum":["CuponsItens"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página a ser recuperada."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Número de registros por página.\n(máximo 50)."},"dDtEmisDe":{"type":"string","maxLength":10,"description":"Filtrar os títulos pela data de emissão - a partir de."},"dDtEmisAte":{"type":"string","maxLength":10,"description":"Filtrar os títulos pela data de emissão - até."},"dDtIncDe":{"type":"string","maxLength":10,"description":"Data de inclusão."},"dDtIncAte":{"type":"string","maxLength":10,"description":"Data de inclusão."},"dDtAltDe":{"type":"string","maxLength":10,"description":"Data de alteração."},"dDtAltAte":{"type":"string","maxLength":10,"description":"Data de alteração."},"nIdCupom":{"type":"integer","maxLength":15,"description":"ID do Cupom Fiscal."}}}}},"example":{"call":"CuponsItens","param":[{"nPagina":1,"nRegPorPagina":50}]}},"produtos_cupomfiscalconsultar_CuponsItens_retorno":{"type":"object","properties":{"nPagina":{"type":"integer"},"nTotPaginas":{"type":"integer"},"nRegistros":{"type":"integer"},"nTotRegistros":{"type":"integer"},"itens":{"type":"array","items":{"type":"object","properties":{"nIdCupom":{"type":"integer","description":"ID do Cupom Fiscal."},"cModeloCupom":{"type":"string","description":"Modelo de Cupom Fiscal. Pode ser: 00 - ECF 59 - CFe-SAT 65 - NFC-e."},"seqCaixa":{"type":"integer","description":"Número sequencial do Caixa."},"seqCupom":{"type":"integer","description":"Numero sequencial do cupom."},"nNumCupom":{"type":"integer","description":"Número do Cupom Fiscal."},"nValorCupom":{"type":"decimal","description":"Valor do Cupom Fiscal."},"dDtEmissaoCupom":{"type":"string","description":"Data de emissão do Cupom Fiscal."},"cHrEmisaoCupom":{"type":"string","description":"Hora de emissão de Cupom Fiscal."},"cChaveCupom":{"type":"string","description":"Chave do Cupom Fiscal."},"nSerieCupom":{"type":"string","description":"Série do Cupom Fiscal."},"cCupomCancelado":{"type":"string","description":"Cupom Fiscal Cancelado (S/N)?"},"cCupomDevolvido":{"type":"string","description":"Cupom Fiscal Devolvido (S/N)?"},"seqItem":{"type":"integer","description":"Sequência do Item do Cupom Fiscal."},"dDtInclusao":{"type":"string","description":"Data de Inclusão do Documento."},"dDtAlteracao":{"type":"string","description":"Data de Alteração do Documento."},"idCliente":{"type":"integer","description":"Código do cliente."},"cCpfCnpjCliente":{"type":"string","description":"CPF/CNPJ do Cliente."},"cRazaoSocialCliente":{"type":"string","description":"Razão Social do Cliente."},"cItemCancelado":{"type":"string","description":"Item do Cupom Fiscal Cancelado (S/N)?"},"cItemDevolvido":{"type":"string","description":"Item do Cupom Fiscal Devolvido (S/N)?"},"idItem":{"type":"integer","description":"ID do item do cupom fiscal."},"idProduto":{"type":"integer","description":"ID do produto do item do cupom fiscal."},"idMovEstoque":{"type":"integer","description":"Id da movimentação de estoque do item do cupom."},"idAjusteEstoque":{"type":"integer","description":"Id da movimentação de ajuste do estoque do item do cupom fiscal."},"idLocalEstoque":{"type":"integer","description":"Id do local de estoque do item do cupom fiscal."},"idAjusteCanc":{"type":"integer","description":"Id da movimentação de cancelamento de ajuste do estoque do item do cupom fiscal."},"idMovCanc":{"type":"integer","description":"ID do Movimento de Estoque do cancelamento do item do cupom fiscal."},"cNaoMovEstoque":{"type":"string","description":"Indica se o item do cupom fiscal não movimenta estoque."},"nQuant":{"type":"decimal","description":"Quantidade do item do cupom fiscal."},"vUnit":{"type":"decimal","description":"Valor unitário do item do cupom fiscal."},"vDesc":{"type":"decimal","description":"Valor desconto do item do cupom fiscal."},"vAcresc":{"type":"decimal","description":"Valor acréscimo do item do cupom fiscal."},"vItem":{"type":"decimal","description":"Valor líquido do item do cupom fiscal."},"nQuantDev":{"type":"decimal","description":"Quantidade devolvida do item do cupom fiscal."},"emiProduto":{"type":"string","description":"Código do PDV do item do cupom fiscal."},"xProd":{"type":"string","description":"Descrição do item do cupom fiscal."},"cUn":{"type":"string","description":"Unidade do item do cupom fiscal."}}}}},"title":"CuponsItens (retorno)"},"produtos_cupomfiscalconsultar_CuponsPagamentos":{"type":"object","title":"CuponsPagamentos","description":"Listagem dos pagamentos dos cupons fiscais.","required":["call","param"],"properties":{"call":{"type":"string","enum":["CuponsPagamentos"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página a ser recuperada."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Número de registros por página.\n(máximo 50)."},"dDtEmisDe":{"type":"string","maxLength":10,"description":"Filtrar os títulos pela data de emissão - a partir de."},"dDtEmisAte":{"type":"string","maxLength":10,"description":"Filtrar os títulos pela data de emissão - até."},"dDtVencDe":{"type":"string","maxLength":10,"description":"Filtrar os títulos pela data de vencimento - a partir de."},"dDtVencAte":{"type":"string","maxLength":10,"description":"Filtrar os títulos pela data de vencimento - até."},"dDtPagtoDe":{"type":"string","maxLength":10,"description":"Filtrar os títulos pela data de pagamento - a partir de."},"dDtPagtoAte":{"type":"string","maxLength":10,"description":"Filtrar os títulos pela data de pagamento - até."},"dDtPrevDe":{"type":"string","maxLength":10,"description":"Data de previsão."},"dDtPrevAte":{"type":"string","maxLength":10,"description":"Data de previsão."},"dDtIncDe":{"type":"string","maxLength":10,"description":"Data de inclusão."},"dDtIncAte":{"type":"string","maxLength":10,"description":"Data de inclusão."},"dDtAltDe":{"type":"string","maxLength":10,"description":"Data de alteração."},"dDtAltAte":{"type":"string","maxLength":10,"description":"Data de alteração."}}}}},"example":{"call":"CuponsPagamentos","param":[{"nPagina":1,"nRegPorPagina":50}]}},"produtos_cupomfiscalconsultar_CuponsPagamentos_retorno":{"type":"object","properties":{"nPagina":{"type":"integer"},"nTotPaginas":{"type":"integer"},"nRegistros":{"type":"integer"},"nTotRegistros":{"type":"integer"},"empresa":{"type":"object","properties":{"cCNPJ":{"type":"string","description":"CNPJ do estabelecimento."},"cRazaoSocial":{"type":"string","description":"Razão social do estabelecimento."},"cNomeFantasia":{"type":"string","description":"Nome Fantasia do estabelecimento."},"cIE":{"type":"string","description":"Inscrição Estadual do estabelecimento."}},"description":"Informações do estabelecimento."},"pagamentos":{"type":"array","items":{"type":"object","properties":{"nIdCupom":{"type":"integer","description":"ID do Cupom Fiscal."},"cModeloCupom":{"type":"string","description":"Modelo de Cupom Fiscal. Pode ser: 00 - ECF 59 - CFe-SAT 65 - NFC-e."},"seqCaixa":{"type":"integer","description":"Número sequencial do Caixa."},"seqCupom":{"type":"integer","description":"Numero sequencial do cupom."},"nNumCupom":{"type":"integer","description":"Número do Cupom Fiscal."},"nValorCupom":{"type":"decimal","description":"Valor do Cupom Fiscal."},"dDtEmissaoCupom":{"type":"string","description":"Data de emissão do Cupom Fiscal."},"cHrEmisaoCupom":{"type":"string","description":"Hora de emissão de Cupom Fiscal."},"cChaveCupom":{"type":"string","description":"Chave do Cupom Fiscal."},"nSerieCupom":{"type":"string","description":"Série do Cupom Fiscal."},"cCupomCancelado":{"type":"string","description":"Cupom Fiscal Cancelado (S/N)?"},"cCupomDevolvido":{"type":"string","description":"Cupom Fiscal Devolvido (S/N)?"},"seqItem":{"type":"integer","description":"Sequência do item do cupom fiscal."},"cItemAgrupado":{"type":"string","description":"Indica se o título foi gerado de forma agrupada ou individual."},"nValorItem":{"type":"decimal","description":"Valor do Pagamento no item."},"dTransacao":{"type":"string","description":"Data da transação da operação do cartão."},"hTransacao":{"type":"string","description":"Hora da transação da operação do cartão."},"cTpIntegra":{"type":"string","description":"Tipo de Integração do processo de pagamento. Pode ser: 1 = Pagamento integrado com o sistema de automação (TEF). 2= Pagamento não integrado com o sistema de automação (POS)."},"cIndPag":{"type":"string","description":"Código da Forma de Pagamento. Pode ser: 0 = Pagamento à Vista 1 = Pagamento à Prazo."},"cMeioPag":{"type":"string","description":"Código do Meio de pagamento utilizado. Pode ser: 01=Dinheiro 02=Cheque 03=Cartão de Crédito 04=Cartão de Débito 05=Crédito Loja 10=Vale Alimentação 11=Vale Refeição 12=Vale Presente 13=Vale Combustível 15=Boleto Bancário 16=Depósito Bancário 17=Pagamento Instantâneo (PIX) 18=Transferência bancária, Carteira Digital 19=Programa de fidelidade, Cashback, Crédito Virtual 90= Sem pagamento 99=Outros."},"cTpBandeira":{"type":"string","description":"Código da Bandeira da operadora de cartão de crédito/débito. Pode ser: 01=Visa 02=Mastercard 03=American Express 04=Sorocred 05=Diners Club 06=Elo 07=Hipercard 08=Aura 09=Cabal 99=Outros."},"NSU":{"type":"string","description":"Número do NSU (TEF/POS)."},"NSUHost":{"type":"string","description":"NSU (Número Sequencial Único) Identifica uma operação de venda no host."},"TID":{"type":"string","description":"TID (Transaction ID) identifica uma transação realizada via e-commerce pelo adquirente / subadquirente."},"nNumAutorizacaoTEF":{"type":"string","description":"Número de autorização do TEF."},"nParcelaTEF":{"type":"integer","description":"Número de parcelas."},"cRedeTEF":{"type":"string","description":"Nome da rede."},"nValorTEF":{"type":"decimal","description":"Valor autorizado."},"cTipoCartaoTEF":{"type":"string","description":"Tipo de Cartão utilizado (TEF)."},"nParcelaPOS":{"type":"integer","description":"Número de parcelas."},"cRedePOS":{"type":"string","description":"Nome da rede."},"nValorPOS":{"type":"decimal","description":"Valor autorizado."},"cCnpjAdquirente":{"type":"string","description":"CNPJ da instituição de pagamente ou adquirente."},"cEstabelecimento":{"type":"string","description":"Código do estabelecimento."},"nCodTitulo":{"type":"integer","description":"Código do título."},"cBandeira":{"type":"string","description":"Código da Bandeira."},"cCategoria":{"type":"string","description":"Código da Categoria."},"xCategoria":{"type":"string","description":"Descrição da Categoria."},"idContaCorrente":{"type":"integer","description":"Código da Conta Corrente."},"xContaCorrente":{"type":"string","description":"Descrição da Conta Corrente."},"cTipoDoc":{"type":"string","description":"Tipo de Documento. Pode ser: 99999 - Outros BOL - Boleto CHQ - Cheque CHT - Cheque de Terceiros CRC - Cartão de Crédito CRD - Cartão de Débito CRE - Creadiário CRT - Cartão DIN - Dinheiro PIX - Pix."},"cNumParcela":{"type":"string","description":"Número da parcela."},"nValorDocumento":{"type":"decimal","description":"Valor do Documento."},"cNumeroDocumento":{"type":"string","description":"Número do documento."},"cNumeroDocFiscal":{"type":"string","description":"Número do Documento Fiscal."},"dDtEmissao":{"type":"string","description":"Data de Emissão do Documento."},"dDtRegistro":{"type":"string","description":"Data de Registro do Documento."},"dDtVencimento":{"type":"string","description":"Data de Vencimento do Documento."},"dDtPrevisao":{"type":"string","description":"Data de Previsão do Documento."},"dDtPagamento":{"type":"string","description":"Data de Pagamento do Documento."},"dDtInclusao":{"type":"string","description":"Data de Inclusão do Documento."},"dDtAlteracao":{"type":"string","description":"Data de Alteração do Documento."},"cDRE":{"type":"string","description":"Código no DRE."},"cBanco":{"type":"string","description":"Código do Banco."},"idCliente":{"type":"integer","description":"Código do cliente."},"cCpfCnpjCliente":{"type":"string","description":"CPF/CNPJ do Cliente."},"cRazaoSocialCliente":{"type":"string","description":"Razão Social do Cliente."},"cLiquidado":{"type":"string","description":"Indica se o Título está Liquidado (S/N)?"},"nValPago":{"type":"decimal","description":"Valor pago do Título."},"nValAberto":{"type":"decimal","description":"Valor em aberto do Título."},"cNossoNumero":{"type":"string","description":"Identificação do pagamento no Cupom Fiscal."}}}}},"title":"CuponsPagamentos (retorno)"},"produtos_cupomfiscalincluir_FecharCaixa":{"type":"object","title":"FecharCaixa","description":"Efetua o fechamento de um determinado caixa.","required":["call","param"],"properties":{"call":{"type":"string","enum":["FecharCaixa"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"emissor":{"type":"object","properties":{"emiNome":{"type":"string","maxLength":20,"description":"Nome do aplicativo emissor do cupom fiscal.\n\n\nO aplicativo deve ser previamente cadastrado.\nPara isso entre em contato com a nosso suporte."},"emiVersao":{"type":"string","maxLength":20,"description":"Versão do aplicativo emissor do cupom fiscal."},"emiSerial":{"type":"string","maxLength":100,"description":"Serial do HD em que o aplicativo emissor do cupom fiscal está instalado."},"emiId":{"type":"string","maxLength":20,"description":"Identificação do computador onde o aplicativo emissor do cupom fiscal está instalado. É o código do PDV.\nExemplos: \"01\", \"20\", \"55\"."}},"required":["emiId","emiNome","emiVersao"]},"seqCaixa":{"type":"integer","maxLength":15,"description":"Número sequencial do movimento do caixa.\n\nCaso não tenha controle de caixa, enviar um sequencial para cada dia para que seja possível acompanhar os movimentos de caixas por dia."},"fechamento":{"type":"object","properties":{"dAbertura":{"type":"string","maxLength":10,"description":"Data de abertura do caixa."},"hAbertura":{"type":"string","maxLength":8,"description":"Hora de abertura do caixa."},"vAbertura":{"type":"number","maxLength":18,"description":"Valor de abertura do caixa (Caixa Inicial)."},"dFechamento":{"type":"string","maxLength":10,"description":"Data de fechamento do caixa."},"hFechamento":{"type":"string","maxLength":8,"description":"Hora de fechamento do caixa."},"vFechamento":{"type":"number","maxLength":18,"description":"Valor do fechamento do caixa (Caixa Final)."}},"required":["dAbertura","dFechamento","hAbertura","hFechamento"],"description":"Dados do fechamento do caixa."}},"required":["seqCaixa"]}}},"example":{"call":"FecharCaixa","param":[{"emissor":{"emiNome":"OmiePDV","emiVersao":"1.0","emiSerial":"ASDadsADSasdADS","emiId":"01"},"seqCaixa":0}]}},"produtos_cupomfiscalincluir_FecharCaixa_retorno":{"type":"object","properties":{"nIdProc":{"type":"integer","description":"Número de identificação do processamento da solicitação."},"cCodStatus":{"type":"string","description":"Código do status de processamento do cupom fiscal. Se retornar 0 indica que o cupom foi processado com sucesso. Se retornar um valor maior que zero indica o código do erro gerado."},"cDesStatus":{"type":"string","description":"Descrição do status de processamento. Caso ocorra erro, retorna a descrição do erro gerado."},"listaProcessados":{"type":"array","items":{"type":"object","properties":{"idCupom":{"type":"integer","description":"Identificação do cupom fiscal."},"idLote":{"type":"integer","description":"Identificação do lote do cupom fiscal."},"dEmi":{"type":"string","description":"Data da emissão do cupom fiscal."},"vCF":{"type":"decimal","description":"Valor do Cupom Fiscal."}}},"description":"Lista de cupons processados."}},"title":"FecharCaixa (retorno)"},"produtos_cupomfiscalincluir_IncluirCfeSat":{"type":"object","title":"IncluirCfeSat","description":"Incluir Cupom Fiscal para SAT.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirCfeSat"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"emissor":{"type":"object","properties":{"emiNome":{"type":"string","maxLength":20,"description":"Nome do aplicativo emissor do cupom fiscal.\n\n\nO aplicativo deve ser previamente cadastrado.\nPara isso entre em contato com a nosso suporte."},"emiVersao":{"type":"string","maxLength":20,"description":"Versão do aplicativo emissor do cupom fiscal."},"emiSerial":{"type":"string","maxLength":100,"description":"Serial do HD em que o aplicativo emissor do cupom fiscal está instalado."},"emiId":{"type":"string","maxLength":20,"description":"Identificação do computador onde o aplicativo emissor do cupom fiscal está instalado. É o código do PDV.\nExemplos: \"01\", \"20\", \"55\"."}},"required":["emiId","emiNome","emiVersao"]},"sat":{"type":"object","properties":{"satSerie":{"type":"string","maxLength":20,"description":"Número de série do SAT.\n\n\nExemplos:\n\"0001882143\""},"satModelo":{"type":"string","maxLength":20,"description":"Modelo do SAT.\n\n\nExemplo:\n\"DIMEP\""},"satSessao":{"type":"integer","maxLength":15,"description":"Sessão do SAT."},"satProt":{"type":"string","maxLength":20,"description":"Protocolo de envio do Cupom Fiscal."},"satXml":{"type":"string","description":"XML do Cupom Fiscal enviado.\n\nPreechimento obrigatório.\n\nAntes de enviar, converta os seus seguintes caracteres:\n\n&amp; para &amp;amp;\n> para &amp;gt;\n< para &amp;lt;\n\" para &amp;quot;\n\" para &amp;apos;\n| para &amp;#124;\n\nApós essa conversão aplique o MD5 para enviar no campo \"satMd5\".\n\nObservação: Para requisições SOAP usar CDATA como demonstra o exemplo abaixo:\n&lt;![CDATA[Conteúdo do campo convertido]]&gt;"},"satMd5":{"type":"string","maxLength":32,"description":"MD5 do arquivo XML enviado em \"satXML\"."}},"required":["satMd5","satModelo","satProt","satSerie","satSessao","satXml"]},"satCanc":{"type":"object","properties":{"satProtCan":{"type":"string","maxLength":20,"description":"Protocolo de envio do cancelamento do Cupom Fiscal."},"satXmlCan":{"type":"string","description":"XML do Cupom Fiscal enviado.\n\nPreechimento obrigatório.\n\nAntes de enviar, converta os seus seguintes caracteres:\n\n& para &amp;\n> para &gt;\n< para &lt;\n\" para &quot;\n\"  para &apos;\n|  para &#124;\n\nApós essa conversão aplique o MD5 para enviar no campo \"satMd5Can\".\n\nObservação: Para requisições SOAP usar CDATA como demonstra o exemplo abaixo:\n&lt;![CDATA[Conteúdo do campo convertido]]&gt;"},"satMd5Can":{"type":"string","maxLength":32,"description":"MD5 do arquivo XML enviado em \"satXmlCan\"."}},"description":"Dados do Cancelamento do SAT."},"caixa":{"type":"object","properties":{"seqCaixa":{"type":"integer","maxLength":15,"description":"Número sequencial do movimento do caixa.\n\nCaso não tenha controle de caixa, enviar um sequencial para cada dia para que seja possível acompanhar os movimentos de caixas por dia."},"seqCupom":{"type":"integer","maxLength":15,"description":"Número sequencial do cupom fiscal enviado.\n\nNão é o número do cupom fiscal, mas sim o número sequencial de venda."},"lCxAberto":{"type":"boolean","description":"Indica se o Caixa está aberto.\n\nO padrão é false.\n\nQuando esse campo foi preenchido como true não haverá movimentação de estoque e não será gerado título de contas a receber até que o processo de fechamento do caixa seja executado."}},"required":["seqCaixa","seqCupom"],"description":"Caixa"},"cfeSat":{"type":"object","properties":{"nCFe":{"type":"string","maxLength":20,"description":"Número do cupom fiscal ou\nNúmero do Extrato do SAT."},"chCFe":{"type":"string","maxLength":44,"description":"Chave de Acesso do CF-e-SAT."},"tpAmb":{"type":"string","maxLength":1,"description":"Ambiente.\n\nPode ser:\nH-Homologação.\nP-Produção."},"dEmi":{"type":"string","maxLength":10,"description":"Data da emissão do cupom fiscal."},"hEmi":{"type":"string","maxLength":10,"description":"Hora da emissão do cupom fiscal."},"lCanc":{"type":"boolean","description":"Status de cancelamento.\n\ntrue - Cancelado.\nfalse - Ativo."},"det":{"type":"array","items":{"type":"object","properties":{"seqItem":{"type":"integer","maxLength":3,"description":"Número sequencial do item."},"lCanc":{"type":"boolean","description":"Status de cancelamento.\n\ntrue - Cancelado.\nfalse - Ativo."},"prod":{"type":"object","properties":{"cProd":{"type":"string","maxLength":60,"description":"Código do produto conforme destacado no Cupom Fiscal."},"xProd":{"type":"string","maxLength":120,"description":"Descrição do produto conforme destacado no Cupom Fiscal."},"CFOP":{"type":"string","maxLength":10,"description":"CFOP."},"NCM":{"type":"string","maxLength":13,"description":"NCM."},"cEAN":{"type":"string","maxLength":14,"description":"EAN do produto."},"cUn":{"type":"string","maxLength":6,"description":"Unidade de medida."},"nQuant":{"type":"number","maxLength":10,"description":"Quantidade."},"vUnit":{"type":"number","maxLength":18,"description":"Valor unitário."},"vProd":{"type":"number","maxLength":18,"description":"Valor do produto.\n\nvProd = nQuant x vUnit"},"vDesc":{"type":"number","maxLength":18,"description":"Valor do desconto."},"vAcresc":{"type":"number","maxLength":18,"description":"Valor do acréscimo."},"vItem":{"type":"number","maxLength":18,"description":"Valor total do item.\n\nÉ o valor líquido dos produtos vendidos no cupom.\nvItem = vProd - vDesc + vAcresc"}}},"prodIdent":{"type":"object","properties":{"idProduto":{"type":"integer","maxLength":15,"description":"Código do produto."},"emiProduto":{"type":"string","maxLength":60,"description":"Código do produto no emissor de cupom fiscal."},"idLocalEstoque":{"type":"integer","maxLength":15,"description":"Codigo do Local do Estoque.\n\n\nCaso não informado assumirá o Local de Estoque padrão."}}},"imposto":{"type":"object","properties":{"vTotTrib":{"type":"number","maxLength":18,"description":"Valor aproximado dos tributos (IBPT)."},"ICMS":{"type":"object","properties":{"CST":{"type":"string","maxLength":2,"description":"Código da Situação Tributária."},"vBC":{"type":"number","maxLength":18,"description":"Valor da Base de Cálculo."},"pICMS":{"type":"number","maxLength":10,"description":"Alíquota do ICMS."},"vICMS":{"type":"number","maxLength":18,"description":"Valor do ICMS."}}}},"description":"Dados dos impostos.\n\nObrigatórios apenas para Cupom Fiscal SAT."},"lNaoMovEstoque":{"type":"string","maxLength":5,"description":"Indica que o item do Cupom Fiscal não deve movimentar o estoque."},"lote_validade":{"type":"object","properties":{"nIdLote":{"type":"integer","maxLength":15,"description":"Id do Lote do produto.\n\nObrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.."},"nQtdLote":{"type":"number","maxLength":18,"description":"Informe aqui a quantidade do Lote para o produto.\n\nÉ obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações."}},"required":["nQtdLote"],"description":"Informações referentes ao lote e validade do produto.\n\nA tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes \"manualmente\" por API."}},"required":["seqItem"]},"description":"Itens do cupom fiscal."},"outrasInf":{"type":"object","properties":{"nMesa":{"type":"string","maxLength":10,"description":"Número / identificação da mesa."},"nPessoas":{"type":"integer","maxLength":5,"description":"Número/quantidade de pessoas atendidas."}},"description":"Outras informações do cupom fiscal."},"total":{"type":"object","properties":{"vItem":{"type":"number","maxLength":18,"description":"Valor total do item. É o valor líquido dos produtos vendidos no cupom.\n\nvItem = vProd - vDesc + vAcresc"},"vICMS":{"type":"number","maxLength":18,"description":"Valor do ICMS."},"vDesc":{"type":"number","maxLength":18,"description":"Valor do desconto."},"vAcresc":{"type":"number","maxLength":18,"description":"Valor do acréscimo."},"vTaxa":{"type":"number","maxLength":15,"description":"Valor da taxa."},"vCF":{"type":"number","maxLength":18,"description":"Valor do Cupom Fiscal."},"vTotTrib":{"type":"number","maxLength":18,"description":"Valor aproximado dos tributos (IBPT)."}},"required":["vCF"],"description":"Totais do cupom fiscal."}},"required":["chCFe","dEmi","hEmi","nCFe","tpAmb"]},"cupomIdent":{"type":"object","properties":{"idCliente":{"type":"integer","maxLength":15,"description":"Código do cliente.\n\nQuando não informado, assumirá que a venda foi realizada para um cliente consumidor padrão.\n\nCaso não exista um cliente consumidor cadastrado, o mesmo será criado automaticamente."},"idVendedor":{"type":"integer","maxLength":15,"description":"Código do vendedor.\n\nQuando não informado, será criado um vendedor padrão para o emissor de cupom fiscal."},"idProjeto":{"type":"integer","maxLength":15,"description":"Código do projeto.\n\nQuando não informado, será criado um projeto padrão para o emissor de cupom fiscal."},"cUsuario":{"type":"string","maxLength":10,"description":"Código do Usuário.\n\nQuando não informado, assumirá o usuário \"Integração\" como o usuário responsáivel pela emissão do cupom fiscal."},"cPedidoCliente":{"type":"string","maxLength":30,"description":"Número do pedido do cliente.\n\n\nUtilizado somente na Inclusão do Cupom Fiscal."},"cNumeroContrato":{"type":"string","maxLength":30,"description":"Número do contrato do cliente.\n\n\nUtilizado somente na Inclusão do Cupom Fiscal."}}},"formasPag":{"type":"array","items":{"type":"object","properties":{"seqPag":{"type":"integer","maxLength":5,"description":"Sequência do pagamento."},"lCanc":{"type":"boolean","description":"Status de cancelamento.\n\ntrue - Cancelado.\nfalse - Ativo."},"pag":{"type":"object","properties":{"vPag":{"type":"number","maxLength":18,"description":"Valor do pagamento."},"vTroco":{"type":"number","maxLength":18,"description":"Valor do troco."},"vTaxa":{"type":"number","maxLength":15,"description":"Valor da taxa da administradora de cartões."},"pTaxa":{"type":"number","maxLength":6,"description":"Percentual da taxa da administradora de cartões."},"vLiq":{"type":"number","maxLength":18,"description":"Valor líquido do pagamento."}},"required":["vLiq","vPag"]},"pagIdent":{"type":"object","properties":{"cCategoria":{"type":"string","maxLength":20,"description":"Código da categoria.\n\n\nUtilize a tag \"codigo\" do método \"ListarCategorias\" da API\n/api/v1/geral/categorias/ para obter essa informação."},"cTipoPag":{"type":"string","maxLength":5,"description":"Tipo de pagamento.\n\n\nSe não preenchido assumirá o código \"99999\" indicando que a forma de pagamento é desconhecida e as parcelas serão ignoradas, gerando um único lançamento no financeiro.\n\nOpções disponíveis:\n\"BOL\" - Boleto\n\"DIN\" - Dinheiro\n\"CRE\" - Crediário\n\"CRT\" - Cartão\n\"CRC\" - Cartão de Crédito\n\"CRD\" - Cartão de Débito\n\"CHQ\" - Cheque\n\"CHT\" - Cheque de Terceiros\n\"PIX\" - Pix\n\"99999\" - Outros\n\nValor é validado de acordo com o tipo de conta corrente. Veja abaixo por tipo de conta corrente quais valores serão aceitos:\n\nCaixinha => \"DIN\", \"CHQ\", \"CHT\", \"99999\" e \"PIX\"\nAdministradora de Cartões => \"CRT\", \"CRC\" e \"CRD\"\nCarteira Virtual => \"CRT\", \"CRC\" e \"CRD\"\nConta Corrente => \"DIN\", \"CRT\", \"CRC\", \"CRD\", \"BOL\" e \"PIX\"\nCrediário / Carnê => \"CRE\" e \"BOL\""},"idConta":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente."}},"required":["cTipoPag","idConta"]},"TEF":{"type":"object","properties":{"dTransacao":{"type":"string","maxLength":10,"description":"Data da transação."},"hTransacao":{"type":"string","maxLength":10,"description":"Hora da transação."},"cBandeiraTef":{"type":"string","maxLength":30,"description":"Descrição da bandeira do cartão.\n\nExemplos:\nVISA CREDITO\nVISA ELECTRO\nELO DEBITO\nELO CREDITO\nALIMENTACAO\nMAESTRO\nMASTERCARD\nPOLICARD"},"NSU":{"type":"string","maxLength":100,"description":"NSU (Número Sequencial Único) identifica uma operação de venda.\n\nPermite que o processo de conciliação de cartões seja realizado de forma mais assertiva, pois identifica os movimentos registrados pelos adquirentes / subadquirentes possibilitando o cruzamento dos dados com os cupons fiscais.\n\nPara vendas realizadas pelo sistema TEF, o NSU é armazenado automaticamente pelo seu PDV.\n\nPara vendas realizadas pelo sistema POS, o NSU pode ser informado manualmente. Verifique com o seu PDV se esse recurso está disponível."},"NSUHost":{"type":"string","maxLength":200,"description":"NSU (Número Sequencial Único) Identifica uma operação de venda no host."},"TID":{"type":"string","maxLength":200,"description":"TID (Transaction ID) identifica uma transação realizada via e-commerce pelo adquirente / subadquirente.\n\nEssa informação será obtida automaticamente pelo seu PDV, quando se tratar de uma venda via e-commerce."},"nNumeroAut":{"type":"string","maxLength":40,"description":"Número da autorização."},"nParcTef":{"type":"integer","maxLength":2,"description":"Número de parcelas."},"cRedeTef":{"type":"string","maxLength":30,"description":"Descrição da rede de pagamento ou adquirente.\n\nExemplos:\nREDECARD\nSTONE\nVISANET\nBCARD\nCIELO"},"nValorAut":{"type":"number","maxLength":18,"description":"Valor autorizado."},"cTipoCartao":{"type":"string","maxLength":1,"description":"Tipo de cartão (Débito ou Crédito)\n\nPode ser:\n\"D\" - para Débito.\n\"C\" - para Crédito."}}},"POS":{"type":"object","properties":{"dTransacao":{"type":"string","maxLength":10,"description":"Data da transação."},"hTransacao":{"type":"string","maxLength":10,"description":"Hora da transação."},"NSU":{"type":"string","maxLength":100,"description":"NSU (Número Sequencial Único) identifica uma operação de venda.\n\nPermite que o processo de conciliação de cartões seja realizado de forma mais assertiva, pois identifica os movimentos registrados pelos adquirentes / subadquirentes possibilitando o cruzamento dos dados com os cupons fiscais.\n\nPara vendas realizadas pelo sistema TEF, o NSU é armazenado automaticamente pelo seu PDV.\n\nPara vendas realizadas pelo sistema POS, o NSU pode ser informado manualmente. Verifique com o seu PDV se esse recurso está disponível."},"nParcPos":{"type":"integer","maxLength":2,"description":"Número de parcelas."},"cRedePos":{"type":"string","maxLength":30,"description":"Descrição da rede de pagamento ou adquirente.\n\nExemplos:\nREDECARD\nSTONE\nVISANET\nBCARD\nCIELO"},"nValorAut":{"type":"number","maxLength":18,"description":"Valor autorizado."}}},"Cheque":{"type":"object","properties":{"chBanco":{"type":"string","maxLength":5,"description":"Número do Banco."},"chAgencia":{"type":"string","maxLength":4,"description":"Número da Agência."},"chConta":{"type":"string","maxLength":15,"description":"Número da Conta."},"chSerie":{"type":"string","maxLength":10,"description":"Série do Cheque."},"chNumero":{"type":"string","maxLength":15,"description":"Número do Cheque."},"chVencimento":{"type":"string","maxLength":10,"description":"Data de vencimento do cheque."}},"description":"Informações do Cheque."},"parcelas":{"type":"array","items":{"type":"object","properties":{"nParc":{"type":"string","maxLength":7,"description":"Número da parcela.\n\nFormato: 999/999.\n\nExemplos:\n001/001\n001/003\n002/003\n003/003"},"dVenc":{"type":"string","maxLength":10,"description":"Data de vencimento da parcela.\n\nFormato: dd/mm/aaaa."},"vParc":{"type":"number","maxLength":18,"description":"Valor da parcela."}}}},"PIX":{"type":"object","properties":{"nIdPix":{"type":"integer","maxLength":15,"description":"ID do lançamento PIX.\nO conteúdo desse campo é o código interno gerado pelo Omie ao gerar o PIX.\n\nÉ obrigatório o preenchimento das tags \"nIdPix\" ou \"cCodInt\".\n\nUtilize a tag \"nIdPix\" do método \"ListarPix\" da API\n/api/v1/financas/pix/\npara obter essa informação."},"cCodIntPix":{"type":"string","maxLength":60,"description":"Código do lançamento gerado pelo integrador.\n\nÉ obrigatório o preenchimento das tags \"nIdPix\" ou \"cCodInt\".\n\nUtilize a tag \"cCodInt\" do método \"ListarPix\" da API\n/api/v1/financas/pix/\npara obter essa informação."}},"required":["cCodIntPix","nIdPix"]},"lNaoGerarTitulo":{"type":"string","maxLength":5,"description":"Indica que a parcela não deve gerar um título no financeiro."}},"required":["seqPag"]}},"departamentos":{"type":"array","items":{"type":"object","properties":{"idDepartamento":{"type":"string","maxLength":40,"description":"Código do departamento.\n(Gerado internamente, não é visualizado na tela)"},"vDepartamento":{"type":"number","maxLength":18,"description":"Valor do departamento. Preenchimento obrigatório"},"pDepartamento":{"type":"number","maxLength":10,"description":"Percentual do departamento. Preenchimento obrigatório"}},"required":["pDepartamento","vDepartamento"]},"description":"Distribuição por Departamentos."},"categorias":{"type":"array","items":{"type":"object","properties":{"idCategoria":{"type":"string","maxLength":20,"description":"Código da Categoria.\n(Gerado internamente, não é visualizado na tela)"},"vCategoria":{"type":"number","maxLength":18,"description":"Valor da categoria"},"pCategoria":{"type":"number","maxLength":10,"description":"Percentual da categoria"}}},"description":"Distribuição por Categorias."}}}}},"example":{"call":"IncluirCfeSat","param":[{"caixa":{"lCxAberto":true,"seqCaixa":3428,"seqCupom":384559},"cfeSat":{"chCFe":"99999999999999999999999999999999999999999999","dEmi":"07/02/2022","det":[{"imposto":{"ICMS":{"CST":"60"},"vTotTrib":5.98},"lCanc":false,"prod":{"cUn":"UN","vAcresc":0,"vDesc":0,"vItem":21.47,"vProd":19.0,"vUnit":19.0},"prodIdent":{"emiProduto":"30218001","idLocalEstoque":393938380,"idProduto":453975843},"seqItem":1}],"hEmi":"16:53:23","lCanc":false,"nCFe":"034799","total":{"vAcresc":0,"vCF":28.82,"vDesc":0,"vItem":25.5,"vTotTrib":8.33},"tpAmb":"P"},"cupomIdent":{"idCliente":423856753},"emissor":{"emiId":"001","emiNome":"SeuPDV","emiSerial":"X128992","emiVersao":"04.08"},"formasPag":[{"lCanc":false,"pag":{"pTaxa":2.65,"vLiq":28.82,"vPag":28.82,"vTaxa":0.76,"vTroco":0},"pagIdent":{"cCategoria":"1.01.95","cTipoPag":"CRC","idConta":372946272},"parcelas":[{"dVenc":"10/02/2022","nParc":1,"vParc":28.82}],"seqPag":1}],"sat":{"satMd5":"f13df5c85a499d7cekei3f7dacd31c6b5","satModelo":"DIMEP","satProt":"12345678","satSerie":"000756735","satSessao":"68670","satXml":"SEU_XML"}}]}},"produtos_cupomfiscalincluir_IncluirCfeSat_retorno":{"type":"object","properties":{"idCupom":{"type":"integer","description":"Identificação do cupom fiscal."},"idLote":{"type":"integer","description":"Identificação do lote do cupom fiscal."},"cCodStatus":{"type":"string","description":"Código do status de processamento do cupom fiscal. Se retornar 0 indica que o cupom foi processado com sucesso. Se retornar um valor maior que zero indica o código do erro gerado."},"cDesStatus":{"type":"string","description":"Descrição do status de processamento. Caso ocorra erro, retorna a descrição do erro gerado."}},"title":"IncluirCfeSat (retorno)"},"produtos_cupomfiscalincluir_IncluirCupom":{"type":"object","title":"IncluirCupom","description":"Incluir Cupom Fiscal (ECF).","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirCupom"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"emissor":{"type":"object","properties":{"emiNome":{"type":"string","maxLength":20,"description":"Nome do aplicativo emissor do cupom fiscal.\n\n\nO aplicativo deve ser previamente cadastrado.\nPara isso entre em contato com a nosso suporte."},"emiVersao":{"type":"string","maxLength":20,"description":"Versão do aplicativo emissor do cupom fiscal."},"emiSerial":{"type":"string","maxLength":100,"description":"Serial do HD em que o aplicativo emissor do cupom fiscal está instalado."},"emiId":{"type":"string","maxLength":20,"description":"Identificação do computador onde o aplicativo emissor do cupom fiscal está instalado. É o código do PDV.\nExemplos: \"01\", \"20\", \"55\"."}},"required":["emiId","emiNome","emiVersao"]},"ecf":{"type":"object","properties":{"ecfSerie":{"type":"string","maxLength":20,"description":"Número de série da impressora fiscal.\n\n\nExemplos:\n\"BE051475610000207422\"\n\"EP121710000000018789\"\n\"SW040900000000009860\"\n\"DR0815BR000000462568\""},"ecfModelo":{"type":"string","maxLength":20,"description":"Modelo da Impressora Fiscal.\n\n\nExemplo:\n\"MP-2100 TH FI\""}},"required":["ecfModelo","ecfSerie"]},"caixa":{"type":"object","properties":{"seqCaixa":{"type":"integer","maxLength":15,"description":"Número sequencial do movimento do caixa.\n\nCaso não tenha controle de caixa, enviar um sequencial para cada dia para que seja possível acompanhar os movimentos de caixas por dia."},"seqCupom":{"type":"integer","maxLength":15,"description":"Número sequencial do cupom fiscal enviado.\n\nNão é o número do cupom fiscal, mas sim o número sequencial de venda."},"lCxAberto":{"type":"boolean","description":"Indica se o Caixa está aberto.\n\nO padrão é false.\n\nQuando esse campo foi preenchido como true não haverá movimentação de estoque e não será gerado título de contas a receber até que o processo de fechamento do caixa seja executado."}},"required":["seqCaixa","seqCupom"],"description":"Caixa"},"cupom":{"type":"object","properties":{"nCOO":{"type":"integer","maxLength":15,"description":"Número do cupom fiscal ou\nnúmero do Contador de Ordem de Operação (COO)."},"nCCF":{"type":"integer","maxLength":15,"description":"Número do Contador de Cupom Fiscal (CCF)."},"tpAmb":{"type":"string","maxLength":1,"description":"Ambiente.\n\n\nPode ser:\nH-Homologação.\nP-Produção."},"dEmi":{"type":"string","maxLength":10,"description":"Data da emissão do cupom fiscal."},"hEmi":{"type":"string","maxLength":10,"description":"Hora da emissão do cupom fiscal."},"lCanc":{"type":"boolean","description":"Status de cancelamento.\n\ntrue - Cancelado.\nfalse - Ativo."},"det":{"type":"array","items":{"type":"object","properties":{"seqItem":{"type":"integer","maxLength":3,"description":"Número sequencial do item."},"lCanc":{"type":"boolean","description":"Status de cancelamento.\n\ntrue - Cancelado.\nfalse - Ativo."},"prod":{"type":"object","properties":{"cProd":{"type":"string","maxLength":60,"description":"Código do produto conforme destacado no Cupom Fiscal."},"xProd":{"type":"string","maxLength":120,"description":"Descrição do produto conforme destacado no Cupom Fiscal."},"CFOP":{"type":"string","maxLength":10,"description":"CFOP."},"NCM":{"type":"string","maxLength":13,"description":"NCM."},"cEAN":{"type":"string","maxLength":14,"description":"EAN do produto."},"cUn":{"type":"string","maxLength":6,"description":"Unidade de medida."},"nQuant":{"type":"number","maxLength":10,"description":"Quantidade."},"vUnit":{"type":"number","maxLength":18,"description":"Valor unitário."},"vProd":{"type":"number","maxLength":18,"description":"Valor do produto.\n\nvProd = nQuant x vUnit"},"vDesc":{"type":"number","maxLength":18,"description":"Valor do desconto."},"vAcresc":{"type":"number","maxLength":18,"description":"Valor do acréscimo."},"vItem":{"type":"number","maxLength":18,"description":"Valor total do item.\n\nÉ o valor líquido dos produtos vendidos no cupom.\nvItem = vProd - vDesc + vAcresc"}}},"prodIdent":{"type":"object","properties":{"idProduto":{"type":"integer","maxLength":15,"description":"Código do produto."},"emiProduto":{"type":"string","maxLength":60,"description":"Código do produto no emissor de cupom fiscal."},"idLocalEstoque":{"type":"integer","maxLength":15,"description":"Codigo do Local do Estoque.\n\n\nCaso não informado assumirá o Local de Estoque padrão."}}},"imposto":{"type":"object","properties":{"vTotTrib":{"type":"number","maxLength":18,"description":"Valor aproximado dos tributos (IBPT)."},"ICMS":{"type":"object","properties":{"CST":{"type":"string","maxLength":2,"description":"Código da Situação Tributária."},"vBC":{"type":"number","maxLength":18,"description":"Valor da Base de Cálculo."},"pICMS":{"type":"number","maxLength":10,"description":"Alíquota do ICMS."},"vICMS":{"type":"number","maxLength":18,"description":"Valor do ICMS."}}}},"description":"Dados dos impostos.\n\nObrigatórios apenas para Cupom Fiscal SAT."},"lNaoMovEstoque":{"type":"string","maxLength":5,"description":"Indica que o item do Cupom Fiscal não deve movimentar o estoque."},"lote_validade":{"type":"object","properties":{"nIdLote":{"type":"integer","maxLength":15,"description":"Id do Lote do produto.\n\nObrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.."},"nQtdLote":{"type":"number","maxLength":18,"description":"Informe aqui a quantidade do Lote para o produto.\n\nÉ obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações."}},"required":["nQtdLote"],"description":"Informações referentes ao lote e validade do produto.\n\nA tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes \"manualmente\" por API."}},"required":["seqItem"]},"description":"Itens do cupom fiscal."},"outrasInf":{"type":"object","properties":{"nMesa":{"type":"string","maxLength":10,"description":"Número / identificação da mesa."},"nPessoas":{"type":"integer","maxLength":5,"description":"Número/quantidade de pessoas atendidas."}},"description":"Outras informações do cupom fiscal."},"total":{"type":"object","properties":{"vItem":{"type":"number","maxLength":18,"description":"Valor total do item. É o valor líquido dos produtos vendidos no cupom.\n\nvItem = vProd - vDesc + vAcresc"},"vICMS":{"type":"number","maxLength":18,"description":"Valor do ICMS."},"vDesc":{"type":"number","maxLength":18,"description":"Valor do desconto."},"vAcresc":{"type":"number","maxLength":18,"description":"Valor do acréscimo."},"vTaxa":{"type":"number","maxLength":15,"description":"Valor da taxa."},"vCF":{"type":"number","maxLength":18,"description":"Valor do Cupom Fiscal."},"vTotTrib":{"type":"number","maxLength":18,"description":"Valor aproximado dos tributos (IBPT)."}},"required":["vCF"],"description":"Totais do cupom fiscal."}},"required":["dEmi","hEmi","nCCF","nCOO","tpAmb"]},"cupomIdent":{"type":"object","properties":{"idCliente":{"type":"integer","maxLength":15,"description":"Código do cliente.\n\nQuando não informado, assumirá que a venda foi realizada para um cliente consumidor padrão.\n\nCaso não exista um cliente consumidor cadastrado, o mesmo será criado automaticamente."},"idVendedor":{"type":"integer","maxLength":15,"description":"Código do vendedor.\n\nQuando não informado, será criado um vendedor padrão para o emissor de cupom fiscal."},"idProjeto":{"type":"integer","maxLength":15,"description":"Código do projeto.\n\nQuando não informado, será criado um projeto padrão para o emissor de cupom fiscal."},"cUsuario":{"type":"string","maxLength":10,"description":"Código do Usuário.\n\nQuando não informado, assumirá o usuário \"Integração\" como o usuário responsáivel pela emissão do cupom fiscal."},"cPedidoCliente":{"type":"string","maxLength":30,"description":"Número do pedido do cliente.\n\n\nUtilizado somente na Inclusão do Cupom Fiscal."},"cNumeroContrato":{"type":"string","maxLength":30,"description":"Número do contrato do cliente.\n\n\nUtilizado somente na Inclusão do Cupom Fiscal."}}},"formasPag":{"type":"array","items":{"type":"object","properties":{"seqPag":{"type":"integer","maxLength":5,"description":"Sequência do pagamento."},"lCanc":{"type":"boolean","description":"Status de cancelamento.\n\ntrue - Cancelado.\nfalse - Ativo."},"pag":{"type":"object","properties":{"vPag":{"type":"number","maxLength":18,"description":"Valor do pagamento."},"vTroco":{"type":"number","maxLength":18,"description":"Valor do troco."},"vTaxa":{"type":"number","maxLength":15,"description":"Valor da taxa da administradora de cartões."},"pTaxa":{"type":"number","maxLength":6,"description":"Percentual da taxa da administradora de cartões."},"vLiq":{"type":"number","maxLength":18,"description":"Valor líquido do pagamento."}},"required":["vLiq","vPag"]},"pagIdent":{"type":"object","properties":{"cCategoria":{"type":"string","maxLength":20,"description":"Código da categoria.\n\n\nUtilize a tag \"codigo\" do método \"ListarCategorias\" da API\n/api/v1/geral/categorias/ para obter essa informação."},"cTipoPag":{"type":"string","maxLength":5,"description":"Tipo de pagamento.\n\n\nSe não preenchido assumirá o código \"99999\" indicando que a forma de pagamento é desconhecida e as parcelas serão ignoradas, gerando um único lançamento no financeiro.\n\nOpções disponíveis:\n\"BOL\" - Boleto\n\"DIN\" - Dinheiro\n\"CRE\" - Crediário\n\"CRT\" - Cartão\n\"CRC\" - Cartão de Crédito\n\"CRD\" - Cartão de Débito\n\"CHQ\" - Cheque\n\"CHT\" - Cheque de Terceiros\n\"PIX\" - Pix\n\"99999\" - Outros\n\nValor é validado de acordo com o tipo de conta corrente. Veja abaixo por tipo de conta corrente quais valores serão aceitos:\n\nCaixinha => \"DIN\", \"CHQ\", \"CHT\", \"99999\" e \"PIX\"\nAdministradora de Cartões => \"CRT\", \"CRC\" e \"CRD\"\nCarteira Virtual => \"CRT\", \"CRC\" e \"CRD\"\nConta Corrente => \"DIN\", \"CRT\", \"CRC\", \"CRD\", \"BOL\" e \"PIX\"\nCrediário / Carnê => \"CRE\" e \"BOL\""},"idConta":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente."}},"required":["cTipoPag","idConta"]},"TEF":{"type":"object","properties":{"dTransacao":{"type":"string","maxLength":10,"description":"Data da transação."},"hTransacao":{"type":"string","maxLength":10,"description":"Hora da transação."},"cBandeiraTef":{"type":"string","maxLength":30,"description":"Descrição da bandeira do cartão.\n\nExemplos:\nVISA CREDITO\nVISA ELECTRO\nELO DEBITO\nELO CREDITO\nALIMENTACAO\nMAESTRO\nMASTERCARD\nPOLICARD"},"NSU":{"type":"string","maxLength":100,"description":"NSU (Número Sequencial Único) identifica uma operação de venda.\n\nPermite que o processo de conciliação de cartões seja realizado de forma mais assertiva, pois identifica os movimentos registrados pelos adquirentes / subadquirentes possibilitando o cruzamento dos dados com os cupons fiscais.\n\nPara vendas realizadas pelo sistema TEF, o NSU é armazenado automaticamente pelo seu PDV.\n\nPara vendas realizadas pelo sistema POS, o NSU pode ser informado manualmente. Verifique com o seu PDV se esse recurso está disponível."},"NSUHost":{"type":"string","maxLength":200,"description":"NSU (Número Sequencial Único) Identifica uma operação de venda no host."},"TID":{"type":"string","maxLength":200,"description":"TID (Transaction ID) identifica uma transação realizada via e-commerce pelo adquirente / subadquirente.\n\nEssa informação será obtida automaticamente pelo seu PDV, quando se tratar de uma venda via e-commerce."},"nNumeroAut":{"type":"string","maxLength":40,"description":"Número da autorização."},"nParcTef":{"type":"integer","maxLength":2,"description":"Número de parcelas."},"cRedeTef":{"type":"string","maxLength":30,"description":"Descrição da rede de pagamento ou adquirente.\n\nExemplos:\nREDECARD\nSTONE\nVISANET\nBCARD\nCIELO"},"nValorAut":{"type":"number","maxLength":18,"description":"Valor autorizado."},"cTipoCartao":{"type":"string","maxLength":1,"description":"Tipo de cartão (Débito ou Crédito)\n\nPode ser:\n\"D\" - para Débito.\n\"C\" - para Crédito."}}},"POS":{"type":"object","properties":{"dTransacao":{"type":"string","maxLength":10,"description":"Data da transação."},"hTransacao":{"type":"string","maxLength":10,"description":"Hora da transação."},"NSU":{"type":"string","maxLength":100,"description":"NSU (Número Sequencial Único) identifica uma operação de venda.\n\nPermite que o processo de conciliação de cartões seja realizado de forma mais assertiva, pois identifica os movimentos registrados pelos adquirentes / subadquirentes possibilitando o cruzamento dos dados com os cupons fiscais.\n\nPara vendas realizadas pelo sistema TEF, o NSU é armazenado automaticamente pelo seu PDV.\n\nPara vendas realizadas pelo sistema POS, o NSU pode ser informado manualmente. Verifique com o seu PDV se esse recurso está disponível."},"nParcPos":{"type":"integer","maxLength":2,"description":"Número de parcelas."},"cRedePos":{"type":"string","maxLength":30,"description":"Descrição da rede de pagamento ou adquirente.\n\nExemplos:\nREDECARD\nSTONE\nVISANET\nBCARD\nCIELO"},"nValorAut":{"type":"number","maxLength":18,"description":"Valor autorizado."}}},"Cheque":{"type":"object","properties":{"chBanco":{"type":"string","maxLength":5,"description":"Número do Banco."},"chAgencia":{"type":"string","maxLength":4,"description":"Número da Agência."},"chConta":{"type":"string","maxLength":15,"description":"Número da Conta."},"chSerie":{"type":"string","maxLength":10,"description":"Série do Cheque."},"chNumero":{"type":"string","maxLength":15,"description":"Número do Cheque."},"chVencimento":{"type":"string","maxLength":10,"description":"Data de vencimento do cheque."}},"description":"Informações do Cheque."},"parcelas":{"type":"array","items":{"type":"object","properties":{"nParc":{"type":"string","maxLength":7,"description":"Número da parcela.\n\nFormato: 999/999.\n\nExemplos:\n001/001\n001/003\n002/003\n003/003"},"dVenc":{"type":"string","maxLength":10,"description":"Data de vencimento da parcela.\n\nFormato: dd/mm/aaaa."},"vParc":{"type":"number","maxLength":18,"description":"Valor da parcela."}}}},"PIX":{"type":"object","properties":{"nIdPix":{"type":"integer","maxLength":15,"description":"ID do lançamento PIX.\nO conteúdo desse campo é o código interno gerado pelo Omie ao gerar o PIX.\n\nÉ obrigatório o preenchimento das tags \"nIdPix\" ou \"cCodInt\".\n\nUtilize a tag \"nIdPix\" do método \"ListarPix\" da API\n/api/v1/financas/pix/\npara obter essa informação."},"cCodIntPix":{"type":"string","maxLength":60,"description":"Código do lançamento gerado pelo integrador.\n\nÉ obrigatório o preenchimento das tags \"nIdPix\" ou \"cCodInt\".\n\nUtilize a tag \"cCodInt\" do método \"ListarPix\" da API\n/api/v1/financas/pix/\npara obter essa informação."}},"required":["cCodIntPix","nIdPix"]},"lNaoGerarTitulo":{"type":"string","maxLength":5,"description":"Indica que a parcela não deve gerar um título no financeiro."}},"required":["seqPag"]}},"departamentos":{"type":"array","items":{"type":"object","properties":{"idDepartamento":{"type":"string","maxLength":40,"description":"Código do departamento.\n(Gerado internamente, não é visualizado na tela)"},"vDepartamento":{"type":"number","maxLength":18,"description":"Valor do departamento. Preenchimento obrigatório"},"pDepartamento":{"type":"number","maxLength":10,"description":"Percentual do departamento. Preenchimento obrigatório"}},"required":["pDepartamento","vDepartamento"]},"description":"Distribuição por Departamentos."},"categorias":{"type":"array","items":{"type":"object","properties":{"idCategoria":{"type":"string","maxLength":20,"description":"Código da Categoria.\n(Gerado internamente, não é visualizado na tela)"},"vCategoria":{"type":"number","maxLength":18,"description":"Valor da categoria"},"pCategoria":{"type":"number","maxLength":10,"description":"Percentual da categoria"}}},"description":"Distribuição por Categorias."}}}}},"example":{"call":"IncluirCupom","param":[{"emissor":{"emiNome":"EmissorPDV","emiVersao":"1.0","emiSerial":"781818814968638","emiId":"001"},"ecf":{"ecfSerie":"BE051475610000201537","ecfModelo":"MP-2100 TH FI"},"caixa":{"seqCaixa":"75716","seqCupom":"1790776571"},"cupom":{"nCOO":"1790776571","nCCF":"1790776571","dEmi":"30/09/2026","hEmi":"13:14:30","lCanc":false,"det":[{"seqItem":1,"lCanc":false,"prod":{"cProd":"700309","xProd":"Misiones de Rengo Carmenere 2016","CFOP":"5.101","NCM":"2204.21.00","cEAN":"","cUn":"GF","nQuant":10,"vUnit":5.5,"vProd":55,"vDesc":0,"vAcresc":0,"vItem":55},"prodIdent":{"idProduto":369356862,"emiProduto":"3229"},"imposto":{"vTotTrib":5,"ICMS":{"CST":"00","vBC":55,"pICMS":18,"vICMS":9.9}}},{"seqItem":2,"lCanc":false,"prod":{"cProd":"700307","xProd":"Periquita Reserva 2014","CFOP":"5.101","NCM":"2204.21.00","cEAN":"","cUn":"GF","nQuant":10,"vUnit":4,"vProd":40,"vDesc":0,"vAcresc":0,"vItem":40},"prodIdent":{"idProduto":369356851,"emiProduto":"3224"},"imposto":{"vTotTrib":5,"ICMS":{"CST":"00","vBC":40,"pICMS":18,"vICMS":7.2}}}],"outrasInf":{"nMesa":0,"nPessoas":0},"total":{"vItem":95,"vICMS":17.1,"vDesc":0,"vAcresc":0,"vTaxa":3,"vCF":95,"vTotTrib":10}},"cupomIdent":{"idCliente":0,"idVendedor":0,"idProjeto":0,"cUsuario":""},"formasPag":[{"seqPag":1,"lCanc":false,"pag":{"vPag":40,"vTroco":0,"vTaxa":0,"pTaxa":0,"vLiq":40},"pagIdent":{"cCategoria":"1.01.03","cTipoPag":"CRT","idConta":1610386},"TEF":{"NSU":"1029333","nNumeroAut":"2222","nValorAut":100,"cTipoCartao":"D","cRedeTef":"VISANET","cBandeiraTef":"VISA","nParcTef":2},"parcelas":[{"nParc":1,"dVenc":"01/10/2026","vParc":25},{"nParc":2,"dVenc":"27/12/2026","vParc":15}]},{"seqPag":2,"lCanc":false,"pag":{"vPag":55,"vTroco":0,"vTaxa":0,"pTaxa":0,"vLiq":55},"pagIdent":{"cCategoria":"1.01.03","cTipoPag":"CHQ","idConta":1208238},"Cheque":{"chBanco":"001","chAgencia":"4321","chConta":"003004","chSerie":"01","chNumero":"01234"}}]}]}},"produtos_cupomfiscalincluir_IncluirCupom_retorno":{"type":"object","properties":{"idCupom":{"type":"integer","description":"Identificação do cupom fiscal."},"idLote":{"type":"integer","description":"Identificação do lote do cupom fiscal."},"cCodStatus":{"type":"string","description":"Código do status de processamento do cupom fiscal. Se retornar 0 indica que o cupom foi processado com sucesso. Se retornar um valor maior que zero indica o código do erro gerado."},"cDesStatus":{"type":"string","description":"Descrição do status de processamento. Caso ocorra erro, retorna a descrição do erro gerado."}},"title":"IncluirCupom (retorno)"},"produtos_cupomfiscalincluir_IncluirNfce":{"type":"object","title":"IncluirNfce","description":"Incluir Nota Fiscal Consumidor Eletrônico.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirNfce"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"emissor":{"type":"object","properties":{"emiNome":{"type":"string","maxLength":20,"description":"Nome do aplicativo emissor do cupom fiscal.\n\n\nO aplicativo deve ser previamente cadastrado.\nPara isso entre em contato com a nosso suporte."},"emiVersao":{"type":"string","maxLength":20,"description":"Versão do aplicativo emissor do cupom fiscal."},"emiSerial":{"type":"string","maxLength":100,"description":"Serial do HD em que o aplicativo emissor do cupom fiscal está instalado."},"emiId":{"type":"string","maxLength":20,"description":"Identificação do computador onde o aplicativo emissor do cupom fiscal está instalado. É o código do PDV.\nExemplos: \"01\", \"20\", \"55\"."}},"required":["emiId","emiNome","emiVersao"]},"nfce":{"type":"object","properties":{"nfceProt":{"type":"string","maxLength":30,"description":"Protocolo de envio da NFC-e."},"nfceXml":{"type":"string","description":"XML da NFC-e enviada.\n\nPreechimento obrigatório.\n\nAntes de enviar, converta os seus seguintes caracteres:\n\n&amp; para &amp;amp;\n> para &amp;gt;\n< para &amp;lt;\n\" para &amp;quot;\n\" para &amp;apos;\n| para &amp;#124;\n\nApós essa conversão aplique o MD5 para enviar no campo \"nfceMd5\".\n\nObservação: Para requisições SOAP usar CDATA como demonstra o exemplo abaixo:\n&lt;![CDATA[Conteúdo do campo convertido]]&gt;"},"nfceMd5":{"type":"string","maxLength":32,"description":"MD5 do arquivo XML enviado em \"nfceXml\"."}},"required":["nfceMd5","nfceProt","nfceXml"]},"nfceCanc":{"type":"object","properties":{"nfceProtCan":{"type":"string","maxLength":30,"description":"Protocolo de cancelamento da NFC-e."},"nfceXmlCan":{"type":"string","description":"XML da NFC-e cancelada.\n\nPreechimento obrigatório para indicar o cancelamento da NFC-e.\n\nAntes de enviar, converta os seus seguintes caracteres:\n\n&amp; para &amp;amp;\n> para &amp;gt;\n< para &amp;lt;\n\" para &amp;quot;\n\" para &amp;apos;\n| para &amp;#124;\n\nApós essa conversão aplique o MD5 para enviar no campo \"nfceMd5Can\".\n\nObservação: Para requisições SOAP usar CDATA como demonstra o exemplo abaixo:\n&lt;![CDATA[Conteúdo do campo convertido]]&gt;"},"nfceMd5Can":{"type":"string","maxLength":32,"description":"MD5 do arquivo XML enviado em \"nfceXmlCan\"."}},"required":["nfceXmlCan"],"description":"Dados do cancelamento da NFC-e."},"caixa":{"type":"object","properties":{"seqCaixa":{"type":"integer","maxLength":15,"description":"Número sequencial do movimento do caixa.\n\nCaso não tenha controle de caixa, enviar um sequencial para cada dia para que seja possível acompanhar os movimentos de caixas por dia."},"seqCupom":{"type":"integer","maxLength":15,"description":"Número sequencial do cupom fiscal enviado.\n\nNão é o número do cupom fiscal, mas sim o número sequencial de venda."},"lCxAberto":{"type":"boolean","description":"Indica se o Caixa está aberto.\n\nO padrão é false.\n\nQuando esse campo foi preenchido como true não haverá movimentação de estoque e não será gerado título de contas a receber até que o processo de fechamento do caixa seja executado."}},"required":["seqCaixa","seqCupom"],"description":"Caixa"},"NFe":{"type":"object","properties":{"nNF":{"type":"string","maxLength":20,"description":"Número da Nota Fiscal Consumidor Eletrônico."},"serie":{"type":"string","maxLength":4,"description":"Série da Nota Fiscal Consumidor Eletrônico."},"chNFe":{"type":"string","maxLength":44,"description":"Chave de Acesso da Nota Fiscal Consumidor Eletrônico."},"tpAmb":{"type":"string","maxLength":1,"description":"Ambiente.\n\n\nPode ser:\nH-Homologação.\nP-Produção."},"tpEmis":{"type":"string","maxLength":1,"description":"Tipo de emissão da Nota Fiscal Consumidor Eletrônico.\n\n\nPode ser:\n1 - Emissão normal.\n9 - Emissão em contingência."},"cTipoAcao":{"type":"string","maxLength":100,"description":"Ação para o faturamento de serviços.\n\nEssa tag é deve ser apenas na inclusão de cupons fiscais com itens de serviço quando a tag 'servicos' estiver preenchida.\n\nIndica se as ordens de serviço faturadas para o cupom ou rps serão geradas de forma agrupada ou individual.\n\n'AGRUPADO' (Default).\n'AGRUPADO-SALAO-PARCEIRO'\n'INDIVIDUAL'"},"dEmi":{"type":"string","maxLength":10,"description":"Data da emissão do cupom fiscal."},"hEmi":{"type":"string","maxLength":10,"description":"Hora da emissão do cupom fiscal."},"lCanc":{"type":"boolean","description":"Status de cancelamento.\n\ntrue - Cancelado.\nfalse - Ativo."},"det":{"type":"array","items":{"type":"object","properties":{"seqItem":{"type":"integer","maxLength":3,"description":"Número sequencial do item."},"lCanc":{"type":"boolean","description":"Status de cancelamento.\n\ntrue - Cancelado.\nfalse - Ativo."},"prod":{"type":"object","properties":{"cProd":{"type":"string","maxLength":60,"description":"Código do produto conforme destacado no Cupom Fiscal."},"xProd":{"type":"string","maxLength":120,"description":"Descrição do produto conforme destacado no Cupom Fiscal."},"CFOP":{"type":"string","maxLength":10,"description":"CFOP."},"NCM":{"type":"string","maxLength":13,"description":"NCM."},"cEAN":{"type":"string","maxLength":14,"description":"EAN do produto."},"cUn":{"type":"string","maxLength":6,"description":"Unidade de medida."},"nQuant":{"type":"number","maxLength":10,"description":"Quantidade."},"vUnit":{"type":"number","maxLength":18,"description":"Valor unitário."},"vProd":{"type":"number","maxLength":18,"description":"Valor do produto.\n\nvProd = nQuant x vUnit"},"vDesc":{"type":"number","maxLength":18,"description":"Valor do desconto."},"vAcresc":{"type":"number","maxLength":18,"description":"Valor do acréscimo."},"vItem":{"type":"number","maxLength":18,"description":"Valor total do item.\n\nÉ o valor líquido dos produtos vendidos no cupom.\nvItem = vProd - vDesc + vAcresc"}}},"prodIdent":{"type":"object","properties":{"idProduto":{"type":"integer","maxLength":15,"description":"Código do produto."},"emiProduto":{"type":"string","maxLength":60,"description":"Código do produto no emissor de cupom fiscal."},"idLocalEstoque":{"type":"integer","maxLength":15,"description":"Codigo do Local do Estoque.\n\n\nCaso não informado assumirá o Local de Estoque padrão."}}},"imposto":{"type":"object","properties":{"vTotTrib":{"type":"number","maxLength":18,"description":"Valor aproximado dos tributos (IBPT)."},"ICMS":{"type":"object","properties":{"CST":{"type":"string","maxLength":2,"description":"Código da Situação Tributária."},"vBC":{"type":"number","maxLength":18,"description":"Valor da Base de Cálculo."},"pICMS":{"type":"number","maxLength":10,"description":"Alíquota do ICMS."},"vICMS":{"type":"number","maxLength":18,"description":"Valor do ICMS."}}}},"description":"Dados dos impostos.\n\nObrigatórios apenas para Cupom Fiscal SAT."},"lNaoMovEstoque":{"type":"string","maxLength":5,"description":"Indica que o item do Cupom Fiscal não deve movimentar o estoque."},"lote_validade":{"type":"object","properties":{"nIdLote":{"type":"integer","maxLength":15,"description":"Id do Lote do produto.\n\nObrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.."},"nQtdLote":{"type":"number","maxLength":18,"description":"Informe aqui a quantidade do Lote para o produto.\n\nÉ obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações."}},"required":["nQtdLote"],"description":"Informações referentes ao lote e validade do produto.\n\nA tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes \"manualmente\" por API."}},"required":["seqItem"]},"description":"Itens do cupom fiscal."},"outrasInf":{"type":"object","properties":{"nMesa":{"type":"string","maxLength":10,"description":"Número / identificação da mesa."},"nPessoas":{"type":"integer","maxLength":5,"description":"Número/quantidade de pessoas atendidas."}},"description":"Outras informações do cupom fiscal."},"total":{"type":"object","properties":{"vItem":{"type":"number","maxLength":18,"description":"Valor total do item. É o valor líquido dos produtos vendidos no cupom.\n\nvItem = vProd - vDesc + vAcresc"},"vICMS":{"type":"number","maxLength":18,"description":"Valor do ICMS."},"vDesc":{"type":"number","maxLength":18,"description":"Valor do desconto."},"vAcresc":{"type":"number","maxLength":18,"description":"Valor do acréscimo."},"vTaxa":{"type":"number","maxLength":15,"description":"Valor da taxa."},"vCF":{"type":"number","maxLength":18,"description":"Valor do Cupom Fiscal."},"vTotTrib":{"type":"number","maxLength":18,"description":"Valor aproximado dos tributos (IBPT)."}},"required":["vCF"],"description":"Totais do cupom fiscal."}},"required":["chNFe","dEmi","hEmi","nNF","tpAmb","tpEmis"]},"cupomIdent":{"type":"object","properties":{"idCliente":{"type":"integer","maxLength":15,"description":"Código do cliente.\n\nQuando não informado, assumirá que a venda foi realizada para um cliente consumidor padrão.\n\nCaso não exista um cliente consumidor cadastrado, o mesmo será criado automaticamente."},"idVendedor":{"type":"integer","maxLength":15,"description":"Código do vendedor.\n\nQuando não informado, será criado um vendedor padrão para o emissor de cupom fiscal."},"idProjeto":{"type":"integer","maxLength":15,"description":"Código do projeto.\n\nQuando não informado, será criado um projeto padrão para o emissor de cupom fiscal."},"cUsuario":{"type":"string","maxLength":10,"description":"Código do Usuário.\n\nQuando não informado, assumirá o usuário \"Integração\" como o usuário responsáivel pela emissão do cupom fiscal."},"cPedidoCliente":{"type":"string","maxLength":30,"description":"Número do pedido do cliente.\n\n\nUtilizado somente na Inclusão do Cupom Fiscal."},"cNumeroContrato":{"type":"string","maxLength":30,"description":"Número do contrato do cliente.\n\n\nUtilizado somente na Inclusão do Cupom Fiscal."}}},"formasPag":{"type":"array","items":{"type":"object","properties":{"seqPag":{"type":"integer","maxLength":5,"description":"Sequência do pagamento."},"lCanc":{"type":"boolean","description":"Status de cancelamento.\n\ntrue - Cancelado.\nfalse - Ativo."},"pag":{"type":"object","properties":{"vPag":{"type":"number","maxLength":18,"description":"Valor do pagamento."},"vTroco":{"type":"number","maxLength":18,"description":"Valor do troco."},"vTaxa":{"type":"number","maxLength":15,"description":"Valor da taxa da administradora de cartões."},"pTaxa":{"type":"number","maxLength":6,"description":"Percentual da taxa da administradora de cartões."},"vLiq":{"type":"number","maxLength":18,"description":"Valor líquido do pagamento."}},"required":["vLiq","vPag"]},"pagIdent":{"type":"object","properties":{"cCategoria":{"type":"string","maxLength":20,"description":"Código da categoria.\n\n\nUtilize a tag \"codigo\" do método \"ListarCategorias\" da API\n/api/v1/geral/categorias/ para obter essa informação."},"cTipoPag":{"type":"string","maxLength":5,"description":"Tipo de pagamento.\n\n\nSe não preenchido assumirá o código \"99999\" indicando que a forma de pagamento é desconhecida e as parcelas serão ignoradas, gerando um único lançamento no financeiro.\n\nOpções disponíveis:\n\"BOL\" - Boleto\n\"DIN\" - Dinheiro\n\"CRE\" - Crediário\n\"CRT\" - Cartão\n\"CRC\" - Cartão de Crédito\n\"CRD\" - Cartão de Débito\n\"CHQ\" - Cheque\n\"CHT\" - Cheque de Terceiros\n\"PIX\" - Pix\n\"99999\" - Outros\n\nValor é validado de acordo com o tipo de conta corrente. Veja abaixo por tipo de conta corrente quais valores serão aceitos:\n\nCaixinha => \"DIN\", \"CHQ\", \"CHT\", \"99999\" e \"PIX\"\nAdministradora de Cartões => \"CRT\", \"CRC\" e \"CRD\"\nCarteira Virtual => \"CRT\", \"CRC\" e \"CRD\"\nConta Corrente => \"DIN\", \"CRT\", \"CRC\", \"CRD\", \"BOL\" e \"PIX\"\nCrediário / Carnê => \"CRE\" e \"BOL\""},"idConta":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente."}},"required":["cTipoPag","idConta"]},"TEF":{"type":"object","properties":{"dTransacao":{"type":"string","maxLength":10,"description":"Data da transação."},"hTransacao":{"type":"string","maxLength":10,"description":"Hora da transação."},"cBandeiraTef":{"type":"string","maxLength":30,"description":"Descrição da bandeira do cartão.\n\nExemplos:\nVISA CREDITO\nVISA ELECTRO\nELO DEBITO\nELO CREDITO\nALIMENTACAO\nMAESTRO\nMASTERCARD\nPOLICARD"},"NSU":{"type":"string","maxLength":100,"description":"NSU (Número Sequencial Único) identifica uma operação de venda.\n\nPermite que o processo de conciliação de cartões seja realizado de forma mais assertiva, pois identifica os movimentos registrados pelos adquirentes / subadquirentes possibilitando o cruzamento dos dados com os cupons fiscais.\n\nPara vendas realizadas pelo sistema TEF, o NSU é armazenado automaticamente pelo seu PDV.\n\nPara vendas realizadas pelo sistema POS, o NSU pode ser informado manualmente. Verifique com o seu PDV se esse recurso está disponível."},"NSUHost":{"type":"string","maxLength":200,"description":"NSU (Número Sequencial Único) Identifica uma operação de venda no host."},"TID":{"type":"string","maxLength":200,"description":"TID (Transaction ID) identifica uma transação realizada via e-commerce pelo adquirente / subadquirente.\n\nEssa informação será obtida automaticamente pelo seu PDV, quando se tratar de uma venda via e-commerce."},"nNumeroAut":{"type":"string","maxLength":40,"description":"Número da autorização."},"nParcTef":{"type":"integer","maxLength":2,"description":"Número de parcelas."},"cRedeTef":{"type":"string","maxLength":30,"description":"Descrição da rede de pagamento ou adquirente.\n\nExemplos:\nREDECARD\nSTONE\nVISANET\nBCARD\nCIELO"},"nValorAut":{"type":"number","maxLength":18,"description":"Valor autorizado."},"cTipoCartao":{"type":"string","maxLength":1,"description":"Tipo de cartão (Débito ou Crédito)\n\nPode ser:\n\"D\" - para Débito.\n\"C\" - para Crédito."}}},"POS":{"type":"object","properties":{"dTransacao":{"type":"string","maxLength":10,"description":"Data da transação."},"hTransacao":{"type":"string","maxLength":10,"description":"Hora da transação."},"NSU":{"type":"string","maxLength":100,"description":"NSU (Número Sequencial Único) identifica uma operação de venda.\n\nPermite que o processo de conciliação de cartões seja realizado de forma mais assertiva, pois identifica os movimentos registrados pelos adquirentes / subadquirentes possibilitando o cruzamento dos dados com os cupons fiscais.\n\nPara vendas realizadas pelo sistema TEF, o NSU é armazenado automaticamente pelo seu PDV.\n\nPara vendas realizadas pelo sistema POS, o NSU pode ser informado manualmente. Verifique com o seu PDV se esse recurso está disponível."},"nParcPos":{"type":"integer","maxLength":2,"description":"Número de parcelas."},"cRedePos":{"type":"string","maxLength":30,"description":"Descrição da rede de pagamento ou adquirente.\n\nExemplos:\nREDECARD\nSTONE\nVISANET\nBCARD\nCIELO"},"nValorAut":{"type":"number","maxLength":18,"description":"Valor autorizado."}}},"Cheque":{"type":"object","properties":{"chBanco":{"type":"string","maxLength":5,"description":"Número do Banco."},"chAgencia":{"type":"string","maxLength":4,"description":"Número da Agência."},"chConta":{"type":"string","maxLength":15,"description":"Número da Conta."},"chSerie":{"type":"string","maxLength":10,"description":"Série do Cheque."},"chNumero":{"type":"string","maxLength":15,"description":"Número do Cheque."},"chVencimento":{"type":"string","maxLength":10,"description":"Data de vencimento do cheque."}},"description":"Informações do Cheque."},"parcelas":{"type":"array","items":{"type":"object","properties":{"nParc":{"type":"string","maxLength":7,"description":"Número da parcela.\n\nFormato: 999/999.\n\nExemplos:\n001/001\n001/003\n002/003\n003/003"},"dVenc":{"type":"string","maxLength":10,"description":"Data de vencimento da parcela.\n\nFormato: dd/mm/aaaa."},"vParc":{"type":"number","maxLength":18,"description":"Valor da parcela."}}}},"PIX":{"type":"object","properties":{"nIdPix":{"type":"integer","maxLength":15,"description":"ID do lançamento PIX.\nO conteúdo desse campo é o código interno gerado pelo Omie ao gerar o PIX.\n\nÉ obrigatório o preenchimento das tags \"nIdPix\" ou \"cCodInt\".\n\nUtilize a tag \"nIdPix\" do método \"ListarPix\" da API\n/api/v1/financas/pix/\npara obter essa informação."},"cCodIntPix":{"type":"string","maxLength":60,"description":"Código do lançamento gerado pelo integrador.\n\nÉ obrigatório o preenchimento das tags \"nIdPix\" ou \"cCodInt\".\n\nUtilize a tag \"cCodInt\" do método \"ListarPix\" da API\n/api/v1/financas/pix/\npara obter essa informação."}},"required":["cCodIntPix","nIdPix"]},"lNaoGerarTitulo":{"type":"string","maxLength":5,"description":"Indica que a parcela não deve gerar um título no financeiro."}},"required":["seqPag"]}},"departamentos":{"type":"array","items":{"type":"object","properties":{"idDepartamento":{"type":"string","maxLength":40,"description":"Código do departamento.\n(Gerado internamente, não é visualizado na tela)"},"vDepartamento":{"type":"number","maxLength":18,"description":"Valor do departamento. Preenchimento obrigatório"},"pDepartamento":{"type":"number","maxLength":10,"description":"Percentual do departamento. Preenchimento obrigatório"}},"required":["pDepartamento","vDepartamento"]},"description":"Distribuição por Departamentos."},"categorias":{"type":"array","items":{"type":"object","properties":{"idCategoria":{"type":"string","maxLength":20,"description":"Código da Categoria.\n(Gerado internamente, não é visualizado na tela)"},"vCategoria":{"type":"number","maxLength":18,"description":"Valor da categoria"},"pCategoria":{"type":"number","maxLength":10,"description":"Percentual da categoria"}}},"description":"Distribuição por Categorias."},"servicos":{"type":"array","items":{"type":"object","properties":{"nCodServ":{"type":"integer","maxLength":15,"description":"ID do serviço.  (Gerado internamente, não é visualizado na tela).\n\nPode ser obtido através da API 'api/v1/servicos/servico/#ListarCadastroServico'.\n\nObrigatório em \"IncluirRps\"; opcional nas demais operações que reutilizam esta\nestrutura, como \"IncluirNfce\"."},"nItem":{"type":"integer","maxLength":3,"description":"Sequencia do item de serviço.\n\nObrigatório em \"IncluirRps\"; opcional nas demais operações que reutilizam esta estrutura, como \"IncluirNfce\"."},"nQtde":{"type":"number","maxLength":18,"description":"Quantidade de serviços.\n\nObrigatório em \"IncluirRps\"; opcional nas demais operações que reutilizam esta estrutura, como \"IncluirNfce\"."},"nValorUni":{"type":"number","maxLength":18,"description":"Valor Unitário do serviço.\n\nObrigatório em \"IncluirRps\"; opcional nas demais operações que reutilizam esta estrutura, como \"IncluirNfce\"."},"nValorTot":{"type":"number","maxLength":18,"description":"Valor Total do serviço.\n\nObrigatório em \"IncluirRps\"; opcional nas demais operações que reutilizam esta estrutura, como \"IncluirNfce\"."},"cMunFG":{"type":"string","maxLength":7,"description":"Código IBGE do município de ocorrência do fato gerador do ISSQN.\n\n(Cidade de prestação do serviço).\n\nObrigatório em \"IncluirRps\"; opcional nas demais operações que reutilizam esta\nestrutura, como \"IncluirNfce\"."},"vAcresc":{"type":"number","maxLength":18,"description":"Valor de acréscimo."},"vDesc":{"type":"number","maxLength":18,"description":"Valor de desconto."},"nValorDed":{"type":"number","maxLength":18,"description":"Valor dedução para redução da Base de Calculo."},"nValorCom":{"type":"number","maxLength":18,"description":"Valor de comissão do vendedor - salão Parceiro.\n\nEssa tag só deve ser informada na modalidade 'salão parceiro'.\n\n(Obrigatória) se a Tag 'rps.cTipoAcao' for preenchida como 'AGRUPADO-SALAO-PARCEIRO.'\n\nObs. É um recurso exclusivo para atender a lei do salão parceiro nas emissões de NFS-e. Não tem relação com o valor de comissão do ERP."},"cCnpjVend":{"type":"string","maxLength":20,"description":"CNPJ do vendedor - salão Parceiro.\n\nEssa tag só deve ser informada na modalidade 'salão parceiro'.\n\n(Obrigatória) se a Tag 'rps.cTipoAcao' for preenchida como 'AGRUPADO-SALAO-PARCEIRO.'\n\nObs. É um recurso exclusivo para atender a lei do salão parceiro nas emissões de NFS-e. Não tem relação com o cadastro de vendedores ou clientes do ERP."},"cNomeVend":{"type":"string","maxLength":100,"description":"Nome do vendedor - salão Parceiro.\n\nEssa tag só deve ser informada na modalidade 'salão parceiro'.\n\n(Obrigatória) se a Tag 'rps.cTipoAcao' for preenchida como 'AGRUPADO-SALAO-PARCEIRO.'\n\nObs. É um recurso exclusivo para atender a lei do salão parceiro nas emissões de NFS-e. Não tem relação com o cadastro de vendedores ou clientes do ERP."}}},"description":"Informações dos Itens de serviço."}}}}},"example":{"call":"IncluirNfce","param":[{"NFe":{"chNFe":"99999999999999999999999999999999999999999999","dEmi":"dd/mm/aaaa","det":[{"lCanc":false,"lNaoMovEstoque":false,"prod":{"CFOP":"5405","NCM":"04061090","cEAN":"SEM GTIN","cProd":"325","cUn":"UN","nQuant":1,"vAcresc":0,"vDesc":0,"vItem":15,"vProd":15,"vUnit":15,"xProd":"REQUEIJAO CREMOSO 400GR MINAS MILK"},"prodIdent":{"emiProduto":"325","idLocalEstoque":"1205784081","idProduto":1208514897},"seqItem":1}],"hEmi":"08:24:01","lCanc":false,"nNF":"000016064","serie":"002","total":{"vAcresc":"0.00","vCF":"25.00","vDesc":"0.00","vICMS":"0.00","vItem":"25.00","vTaxa":0,"vTotTrib":0},"tpAmb":"P","tpEmis":"1"},"caixa":{"lCxAberto":false,"seqCaixa":710,"seqCupom":1012303},"cupomIdent":{"idCliente":120834285,"idProjeto":0,"idVendedor":0},"emissor":{"emiId":"0001","emiNome":"SEU_PDV","emiSerial":"WD-WXS1A499REDFTB58F00D65","emiVersao":"1.9.00"},"formasPag":[{"Parcelas":[{"dVenc":"dd/mm/aaaa","nParc":"001/001","vParc":25}],"TEF":{"NSU":"","cBandeiraTef":"","cRedeTef":"Outros","cTipoCartao":"","nNumeroAut":"","nParcTef":0,"nValorAut":25},"lCanc":false,"lNaoGerarTitulo":false,"pag":{"pTaxa":0,"vLiq":25,"vPag":25,"vTaxa":0,"vTroco":0},"pagIdent":{"cCategoria":"1.01.03","cTipoPag":"CRT","idConta":1298842804},"seqPag":1}],"nfce":{"nfceMd5":"754d4c0594e4ebcbcf7fdd75547f9d7d","nfceProt":"999999999999999","nfceXml":"SEU_XML"}}]}},"produtos_cupomfiscalincluir_IncluirNfce_retorno":{"type":"object","properties":{"idCupom":{"type":"integer","description":"Identificação do cupom fiscal."},"idLote":{"type":"integer","description":"Identificação do lote do cupom fiscal."},"cCodStatus":{"type":"string","description":"Código do status de processamento do cupom fiscal. Se retornar 0 indica que o cupom foi processado com sucesso. Se retornar um valor maior que zero indica o código do erro gerado."},"cDesStatus":{"type":"string","description":"Descrição do status de processamento. Caso ocorra erro, retorna a descrição do erro gerado."}},"title":"IncluirNfce (retorno)"},"produtos_cupomfiscalincluir_IncluirRps":{"type":"object","title":"IncluirRps","description":"Incluir Cupom RPS.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirRps"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"emissor":{"type":"object","properties":{"emiNome":{"type":"string","maxLength":20,"description":"Nome do aplicativo emissor do cupom fiscal.\n\n\nO aplicativo deve ser previamente cadastrado.\nPara isso entre em contato com a nosso suporte."},"emiVersao":{"type":"string","maxLength":20,"description":"Versão do aplicativo emissor do cupom fiscal."},"emiSerial":{"type":"string","maxLength":100,"description":"Serial do HD em que o aplicativo emissor do cupom fiscal está instalado."},"emiId":{"type":"string","maxLength":20,"description":"Identificação do computador onde o aplicativo emissor do cupom fiscal está instalado. É o código do PDV.\nExemplos: \"01\", \"20\", \"55\"."}},"required":["emiId","emiNome","emiVersao"]},"caixa":{"type":"object","properties":{"seqCaixa":{"type":"integer","maxLength":15,"description":"Número sequencial do movimento do caixa.\n\nCaso não tenha controle de caixa, enviar um sequencial para cada dia para que seja possível acompanhar os movimentos de caixas por dia."},"seqCupom":{"type":"integer","maxLength":15,"description":"Número sequencial do cupom fiscal enviado.\n\nNão é o número do cupom fiscal, mas sim o número sequencial de venda."},"lCxAberto":{"type":"boolean","description":"Indica se o Caixa está aberto.\n\nO padrão é false.\n\nQuando esse campo foi preenchido como true não haverá movimentação de estoque e não será gerado título de contas a receber até que o processo de fechamento do caixa seja executado."}},"required":["seqCaixa","seqCupom"],"description":"Caixa"},"cupomIdent":{"type":"object","properties":{"idCliente":{"type":"integer","maxLength":15,"description":"Código do cliente.\n\nQuando não informado, assumirá que a venda foi realizada para um cliente consumidor padrão.\n\nCaso não exista um cliente consumidor cadastrado, o mesmo será criado automaticamente."},"idVendedor":{"type":"integer","maxLength":15,"description":"Código do vendedor.\n\nQuando não informado, será criado um vendedor padrão para o emissor de cupom fiscal."},"idProjeto":{"type":"integer","maxLength":15,"description":"Código do projeto.\n\nQuando não informado, será criado um projeto padrão para o emissor de cupom fiscal."},"cUsuario":{"type":"string","maxLength":10,"description":"Código do Usuário.\n\nQuando não informado, assumirá o usuário \"Integração\" como o usuário responsáivel pela emissão do cupom fiscal."},"cPedidoCliente":{"type":"string","maxLength":30,"description":"Número do pedido do cliente.\n\n\nUtilizado somente na Inclusão do Cupom Fiscal."},"cNumeroContrato":{"type":"string","maxLength":30,"description":"Número do contrato do cliente.\n\n\nUtilizado somente na Inclusão do Cupom Fiscal."}}},"formasPag":{"type":"array","items":{"type":"object","properties":{"seqPag":{"type":"integer","maxLength":5,"description":"Sequência do pagamento."},"lCanc":{"type":"boolean","description":"Status de cancelamento.\n\ntrue - Cancelado.\nfalse - Ativo."},"pag":{"type":"object","properties":{"vPag":{"type":"number","maxLength":18,"description":"Valor do pagamento."},"vTroco":{"type":"number","maxLength":18,"description":"Valor do troco."},"vTaxa":{"type":"number","maxLength":15,"description":"Valor da taxa da administradora de cartões."},"pTaxa":{"type":"number","maxLength":6,"description":"Percentual da taxa da administradora de cartões."},"vLiq":{"type":"number","maxLength":18,"description":"Valor líquido do pagamento."}},"required":["vLiq","vPag"]},"pagIdent":{"type":"object","properties":{"cCategoria":{"type":"string","maxLength":20,"description":"Código da categoria.\n\n\nUtilize a tag \"codigo\" do método \"ListarCategorias\" da API\n/api/v1/geral/categorias/ para obter essa informação."},"cTipoPag":{"type":"string","maxLength":5,"description":"Tipo de pagamento.\n\n\nSe não preenchido assumirá o código \"99999\" indicando que a forma de pagamento é desconhecida e as parcelas serão ignoradas, gerando um único lançamento no financeiro.\n\nOpções disponíveis:\n\"BOL\" - Boleto\n\"DIN\" - Dinheiro\n\"CRE\" - Crediário\n\"CRT\" - Cartão\n\"CRC\" - Cartão de Crédito\n\"CRD\" - Cartão de Débito\n\"CHQ\" - Cheque\n\"CHT\" - Cheque de Terceiros\n\"PIX\" - Pix\n\"99999\" - Outros\n\nValor é validado de acordo com o tipo de conta corrente. Veja abaixo por tipo de conta corrente quais valores serão aceitos:\n\nCaixinha => \"DIN\", \"CHQ\", \"CHT\", \"99999\" e \"PIX\"\nAdministradora de Cartões => \"CRT\", \"CRC\" e \"CRD\"\nCarteira Virtual => \"CRT\", \"CRC\" e \"CRD\"\nConta Corrente => \"DIN\", \"CRT\", \"CRC\", \"CRD\", \"BOL\" e \"PIX\"\nCrediário / Carnê => \"CRE\" e \"BOL\""},"idConta":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente."}},"required":["cTipoPag","idConta"]},"TEF":{"type":"object","properties":{"dTransacao":{"type":"string","maxLength":10,"description":"Data da transação."},"hTransacao":{"type":"string","maxLength":10,"description":"Hora da transação."},"cBandeiraTef":{"type":"string","maxLength":30,"description":"Descrição da bandeira do cartão.\n\nExemplos:\nVISA CREDITO\nVISA ELECTRO\nELO DEBITO\nELO CREDITO\nALIMENTACAO\nMAESTRO\nMASTERCARD\nPOLICARD"},"NSU":{"type":"string","maxLength":100,"description":"NSU (Número Sequencial Único) identifica uma operação de venda.\n\nPermite que o processo de conciliação de cartões seja realizado de forma mais assertiva, pois identifica os movimentos registrados pelos adquirentes / subadquirentes possibilitando o cruzamento dos dados com os cupons fiscais.\n\nPara vendas realizadas pelo sistema TEF, o NSU é armazenado automaticamente pelo seu PDV.\n\nPara vendas realizadas pelo sistema POS, o NSU pode ser informado manualmente. Verifique com o seu PDV se esse recurso está disponível."},"NSUHost":{"type":"string","maxLength":200,"description":"NSU (Número Sequencial Único) Identifica uma operação de venda no host."},"TID":{"type":"string","maxLength":200,"description":"TID (Transaction ID) identifica uma transação realizada via e-commerce pelo adquirente / subadquirente.\n\nEssa informação será obtida automaticamente pelo seu PDV, quando se tratar de uma venda via e-commerce."},"nNumeroAut":{"type":"string","maxLength":40,"description":"Número da autorização."},"nParcTef":{"type":"integer","maxLength":2,"description":"Número de parcelas."},"cRedeTef":{"type":"string","maxLength":30,"description":"Descrição da rede de pagamento ou adquirente.\n\nExemplos:\nREDECARD\nSTONE\nVISANET\nBCARD\nCIELO"},"nValorAut":{"type":"number","maxLength":18,"description":"Valor autorizado."},"cTipoCartao":{"type":"string","maxLength":1,"description":"Tipo de cartão (Débito ou Crédito)\n\nPode ser:\n\"D\" - para Débito.\n\"C\" - para Crédito."}}},"POS":{"type":"object","properties":{"dTransacao":{"type":"string","maxLength":10,"description":"Data da transação."},"hTransacao":{"type":"string","maxLength":10,"description":"Hora da transação."},"NSU":{"type":"string","maxLength":100,"description":"NSU (Número Sequencial Único) identifica uma operação de venda.\n\nPermite que o processo de conciliação de cartões seja realizado de forma mais assertiva, pois identifica os movimentos registrados pelos adquirentes / subadquirentes possibilitando o cruzamento dos dados com os cupons fiscais.\n\nPara vendas realizadas pelo sistema TEF, o NSU é armazenado automaticamente pelo seu PDV.\n\nPara vendas realizadas pelo sistema POS, o NSU pode ser informado manualmente. Verifique com o seu PDV se esse recurso está disponível."},"nParcPos":{"type":"integer","maxLength":2,"description":"Número de parcelas."},"cRedePos":{"type":"string","maxLength":30,"description":"Descrição da rede de pagamento ou adquirente.\n\nExemplos:\nREDECARD\nSTONE\nVISANET\nBCARD\nCIELO"},"nValorAut":{"type":"number","maxLength":18,"description":"Valor autorizado."}}},"Cheque":{"type":"object","properties":{"chBanco":{"type":"string","maxLength":5,"description":"Número do Banco."},"chAgencia":{"type":"string","maxLength":4,"description":"Número da Agência."},"chConta":{"type":"string","maxLength":15,"description":"Número da Conta."},"chSerie":{"type":"string","maxLength":10,"description":"Série do Cheque."},"chNumero":{"type":"string","maxLength":15,"description":"Número do Cheque."},"chVencimento":{"type":"string","maxLength":10,"description":"Data de vencimento do cheque."}},"description":"Informações do Cheque."},"parcelas":{"type":"array","items":{"type":"object","properties":{"nParc":{"type":"string","maxLength":7,"description":"Número da parcela.\n\nFormato: 999/999.\n\nExemplos:\n001/001\n001/003\n002/003\n003/003"},"dVenc":{"type":"string","maxLength":10,"description":"Data de vencimento da parcela.\n\nFormato: dd/mm/aaaa."},"vParc":{"type":"number","maxLength":18,"description":"Valor da parcela."}}}},"PIX":{"type":"object","properties":{"nIdPix":{"type":"integer","maxLength":15,"description":"ID do lançamento PIX.\nO conteúdo desse campo é o código interno gerado pelo Omie ao gerar o PIX.\n\nÉ obrigatório o preenchimento das tags \"nIdPix\" ou \"cCodInt\".\n\nUtilize a tag \"nIdPix\" do método \"ListarPix\" da API\n/api/v1/financas/pix/\npara obter essa informação."},"cCodIntPix":{"type":"string","maxLength":60,"description":"Código do lançamento gerado pelo integrador.\n\nÉ obrigatório o preenchimento das tags \"nIdPix\" ou \"cCodInt\".\n\nUtilize a tag \"cCodInt\" do método \"ListarPix\" da API\n/api/v1/financas/pix/\npara obter essa informação."}},"required":["cCodIntPix","nIdPix"]},"lNaoGerarTitulo":{"type":"string","maxLength":5,"description":"Indica que a parcela não deve gerar um título no financeiro."}},"required":["seqPag"]}},"departamentos":{"type":"array","items":{"type":"object","properties":{"idDepartamento":{"type":"string","maxLength":40,"description":"Código do departamento.\n(Gerado internamente, não é visualizado na tela)"},"vDepartamento":{"type":"number","maxLength":18,"description":"Valor do departamento. Preenchimento obrigatório"},"pDepartamento":{"type":"number","maxLength":10,"description":"Percentual do departamento. Preenchimento obrigatório"}},"required":["pDepartamento","vDepartamento"]},"description":"Distribuição por Departamentos."},"categorias":{"type":"array","items":{"type":"object","properties":{"idCategoria":{"type":"string","maxLength":20,"description":"Código da Categoria.\n(Gerado internamente, não é visualizado na tela)"},"vCategoria":{"type":"number","maxLength":18,"description":"Valor da categoria"},"pCategoria":{"type":"number","maxLength":10,"description":"Percentual da categoria"}}},"description":"Distribuição por Categorias."},"servicos":{"type":"array","items":{"type":"object","properties":{"nCodServ":{"type":"integer","maxLength":15,"description":"ID do serviço.  (Gerado internamente, não é visualizado na tela).\n\nPode ser obtido através da API 'api/v1/servicos/servico/#ListarCadastroServico'.\n\nObrigatório em \"IncluirRps\"; opcional nas demais operações que reutilizam esta\nestrutura, como \"IncluirNfce\"."},"nItem":{"type":"integer","maxLength":3,"description":"Sequencia do item de serviço.\n\nObrigatório em \"IncluirRps\"; opcional nas demais operações que reutilizam esta estrutura, como \"IncluirNfce\"."},"nQtde":{"type":"number","maxLength":18,"description":"Quantidade de serviços.\n\nObrigatório em \"IncluirRps\"; opcional nas demais operações que reutilizam esta estrutura, como \"IncluirNfce\"."},"nValorUni":{"type":"number","maxLength":18,"description":"Valor Unitário do serviço.\n\nObrigatório em \"IncluirRps\"; opcional nas demais operações que reutilizam esta estrutura, como \"IncluirNfce\"."},"nValorTot":{"type":"number","maxLength":18,"description":"Valor Total do serviço.\n\nObrigatório em \"IncluirRps\"; opcional nas demais operações que reutilizam esta estrutura, como \"IncluirNfce\"."},"cMunFG":{"type":"string","maxLength":7,"description":"Código IBGE do município de ocorrência do fato gerador do ISSQN.\n\n(Cidade de prestação do serviço).\n\nObrigatório em \"IncluirRps\"; opcional nas demais operações que reutilizam esta\nestrutura, como \"IncluirNfce\"."},"vAcresc":{"type":"number","maxLength":18,"description":"Valor de acréscimo."},"vDesc":{"type":"number","maxLength":18,"description":"Valor de desconto."},"nValorDed":{"type":"number","maxLength":18,"description":"Valor dedução para redução da Base de Calculo."},"nValorCom":{"type":"number","maxLength":18,"description":"Valor de comissão do vendedor - salão Parceiro.\n\nEssa tag só deve ser informada na modalidade 'salão parceiro'.\n\n(Obrigatória) se a Tag 'rps.cTipoAcao' for preenchida como 'AGRUPADO-SALAO-PARCEIRO.'\n\nObs. É um recurso exclusivo para atender a lei do salão parceiro nas emissões de NFS-e. Não tem relação com o valor de comissão do ERP."},"cCnpjVend":{"type":"string","maxLength":20,"description":"CNPJ do vendedor - salão Parceiro.\n\nEssa tag só deve ser informada na modalidade 'salão parceiro'.\n\n(Obrigatória) se a Tag 'rps.cTipoAcao' for preenchida como 'AGRUPADO-SALAO-PARCEIRO.'\n\nObs. É um recurso exclusivo para atender a lei do salão parceiro nas emissões de NFS-e. Não tem relação com o cadastro de vendedores ou clientes do ERP."},"cNomeVend":{"type":"string","maxLength":100,"description":"Nome do vendedor - salão Parceiro.\n\nEssa tag só deve ser informada na modalidade 'salão parceiro'.\n\n(Obrigatória) se a Tag 'rps.cTipoAcao' for preenchida como 'AGRUPADO-SALAO-PARCEIRO.'\n\nObs. É um recurso exclusivo para atender a lei do salão parceiro nas emissões de NFS-e. Não tem relação com o cadastro de vendedores ou clientes do ERP."}}},"description":"Informações dos Itens de serviço."},"rps":{"type":"object","properties":{"numero":{"type":"integer","maxLength":15,"description":"Número do cupom."},"serie":{"type":"string","maxLength":4,"description":"Série do Cupom."},"dEmi":{"type":"string","maxLength":10,"description":"Data da emissão do cupom fiscal."},"hEmi":{"type":"string","maxLength":10,"description":"Hora da emissão do cupom fiscal."},"totalRps":{"type":"object","properties":{"vItem":{"type":"number","maxLength":18,"description":"Valor total do item. É o valor líquido dos produtos vendidos no cupom.\n\nvItem = vProd - vDesc + vAcresc"},"vDesc":{"type":"number","maxLength":18,"description":"Valor do desconto."},"vRPS":{"type":"number","maxLength":18}},"required":["vItem","vRPS"],"description":"Total do cupom RPS."},"cTipoAcao":{"type":"string","maxLength":100,"description":"Ação para o faturamento de serviços.\n\nEssa tag é deve ser apenas na inclusão de cupons fiscais com itens de serviço quando a tag 'servicos' estiver preenchida.\n\nIndica se as ordens de serviço faturadas para o cupom ou rps serão geradas de forma agrupada ou individual.\n\n'AGRUPADO' (Default).\n'AGRUPADO-SALAO-PARCEIRO'\n'INDIVIDUAL'"}},"required":["dEmi","hEmi","numero","serie"],"description":"Informe os detalhes do Cupom/RPS"}}}}},"example":{"call":"IncluirRps","param":[{"emissor":{"emiNome":"SEU_PDV","emiVersao":"1.3.0","emiSerial":"1.0","emiId":"02"},"caixa":{"seqCaixa":1206,"seqCupom":2508},"cupomIdent":{"idCliente":"","idVendedor":0,"idProjeto":0,"cUsuario":""},"servicos":[{"nCodServ":200000027377888,"nItem":1,"nQtde":3,"nValorUni":2,"nValorTot":6,"cMunFG":"3550308","vDesc":0},{"nCodServ":200000027377888,"nItem":2,"nQtde":1,"nValorUni":2,"nValorTot":2,"cMunFG":"3550308","vDesc":0},{"nCodServ":200000027377888,"nItem":3,"nQtde":1,"nValorUni":2,"nValorTot":2,"cMunFG":"3550308","vDesc":0}],"rps":{"numero":2508,"serie":"4","dEmi":"27/03/2025","hEmi":"16:52:56","totalRps":{"vItem":10.0,"vDesc":0,"vRPS":10.0}},"formasPag":[{"seqPag":1,"lCanc":false,"pag":{"vPag":10.0,"vLiq":10.0},"pagIdent":{"cCategoria":"1.01.03","idConta":200000005530780,"cTipoPag":"CRT"},"parcelas":[{"nParc":"001/001","dVenc":"08/05/2025","vParc":10.0}]}]}]}},"produtos_cupomfiscalincluir_IncluirRps_retorno":{"type":"object","properties":{"idCupom":{"type":"integer","description":"Identificação do cupom fiscal."},"cCodStatus":{"type":"string","description":"Código do status de processamento do cupom fiscal. Se retornar 0 indica que o cupom foi processado com sucesso. Se retornar um valor maior que zero indica o código do erro gerado."},"cDesStatus":{"type":"string","description":"Descrição do status de processamento. Caso ocorra erro, retorna a descrição do erro gerado."}},"title":"IncluirRps (retorno)"},"produtos_cupomfiscalincluir_InutilizarNfce":{"type":"object","title":"InutilizarNfce","description":"Inutiliza um lote de NFC-e.","required":["call","param"],"properties":{"call":{"type":"string","enum":["InutilizarNfce"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"emissor":{"type":"object","properties":{"emiNome":{"type":"string","maxLength":20,"description":"Nome do aplicativo emissor do cupom fiscal.\n\n\nO aplicativo deve ser previamente cadastrado.\nPara isso entre em contato com a nosso suporte."},"emiVersao":{"type":"string","maxLength":20,"description":"Versão do aplicativo emissor do cupom fiscal."},"emiSerial":{"type":"string","maxLength":100,"description":"Serial do HD em que o aplicativo emissor do cupom fiscal está instalado."},"emiId":{"type":"string","maxLength":20,"description":"Identificação do computador onde o aplicativo emissor do cupom fiscal está instalado. É o código do PDV.\nExemplos: \"01\", \"20\", \"55\"."}},"required":["emiId","emiNome","emiVersao"]},"nfceInut":{"type":"object","properties":{"nfceProtInut":{"type":"string","maxLength":30,"description":"Protocolo de inutilização da NFC-e."},"nfceXmlInut":{"type":"string","description":"XML da inutização de NFC-e.\n\nPreechimento obrigatório.\n\nAntes de enviar, converta os seus seguintes caracteres:\n\n&amp; para &amp;amp;\n> para &amp;gt;\n< para &amp;lt;\n\" para &amp;quot;\n\" para &amp;apos;\n| para &amp;#124;\n\nApós essa conversão aplique o MD5 para enviar no campo \"nfceMd5Inut\".\n\nObservação: Para requisições SOAP usar CDATA como demonstra o exemplo abaixo:\n&lt;![CDATA[Conteúdo do campo convertido]]&gt;"},"nfceMd5Inut":{"type":"string","maxLength":32,"description":"MD5 do arquivo XML enviado em \"nfceXmlInut\"."}},"required":["nfceMd5Inut","nfceProtInut","nfceXmlInut"]}}}}},"example":{"call":"InutilizarNfce","param":[{"emissor":{"emiNome":"OmiePDV","emiVersao":"1.0","emiSerial":"ASDadsADSasdADS","emiId":"01"},"nfceInut":{"nfceProtInut":0,"nfceXmlInut":"","nfceMd5Inut":""}}]}},"produtos_cupomfiscalincluir_InutilizarNfce_retorno":{"type":"object","properties":{"nIdProc":{"type":"integer","description":"Número de identificação do processamento da solicitação."},"cCodStatus":{"type":"string","description":"Código do status de processamento do cupom fiscal. Se retornar 0 indica que o cupom foi processado com sucesso. Se retornar um valor maior que zero indica o código do erro gerado."},"cDesStatus":{"type":"string","description":"Descrição do status de processamento. Caso ocorra erro, retorna a descrição do erro gerado."}},"title":"InutilizarNfce (retorno)"},"produtos_devolucaovendafaturamento_FaturarDevolucaoVenda":{"type":"object","title":"FaturarDevolucaoVenda","description":"Faturar uma Devolução de Venda.","required":["call","param"],"properties":{"call":{"type":"string","enum":["FaturarDevolucaoVenda"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodDevol":{"type":"integer","maxLength":15,"description":"Código da Devolução de Venda."}},"required":["nCodDevol"]}}},"example":{"call":"FaturarDevolucaoVenda","param":[{"nCodDevol":0}]}},"produtos_devolucaovendafaturamento_FaturarDevolucaoVenda_retorno":{"type":"object","properties":{"nCodDevol":{"type":"integer","description":"Código da Devolução de Venda."},"cCodStatus":{"type":"string","description":"Código do Status."},"cDescStatus":{"type":"string","description":"Descrição do Status."}},"title":"FaturarDevolucaoVenda (retorno)"},"produtos_devolucaovendafaturamento_StatusDevolucaoVenda":{"type":"object","title":"StatusDevolucaoVenda","description":"Obter status de uma Devolução de Venda.","required":["call","param"],"properties":{"call":{"type":"string","enum":["StatusDevolucaoVenda"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodDevol":{"type":"integer","maxLength":15,"description":"Id da Devolução do Pedido do Venda."}},"required":["nCodDevol"]}}},"example":{"call":"StatusDevolucaoVenda","param":[{"nCodDevol":0}]}},"produtos_devolucaovendafaturamento_StatusDevolucaoVenda_retorno":{"type":"object","properties":{"nCodDevol":{"type":"integer","description":"Id da Devolução do Pedido de Venda."},"cNumPed":{"type":"string","description":"Número da Devolução do Pedido de Venda."},"cEtapa":{"type":"string"},"cCancelada":{"type":"string","description":"NF-e cancelada? (S/N)."},"cFaturada":{"type":"string","description":"NF-e faturada? (S/N)."},"cAmbiente":{"type":"string","description":"Ambiente que a nota foi gerada."},"vTotal":{"type":"decimal","description":"Valor total do pedido."},"ListaNfe":{"type":"array","items":{"type":"object","properties":{"cNumLote":{"type":"integer","description":"Número do lote da NF-e."},"cStatusLote":{"type":"string","description":"Status do Lote da NF-e."},"cRecibo":{"type":"integer","description":"Recibo."},"cContingencia":{"type":"string","description":"NF-e emitida em contingência."},"cNumNfe":{"type":"string","description":"Número da NF-e gerada."},"cSerieNfe":{"type":"string","description":"Série da NF-e."},"cStatusNfe":{"type":"string","description":"Status da NF-e."},"cChaveNfe":{"type":"string","description":"Chave de Acesso da NF-e."},"cProtocolo":{"type":"integer","description":"Número do Protocolo."},"cTipo":{"type":"string","description":"Tipo de Emissão. Pode ser: E - Entrada S - Saída."},"dEmissao":{"type":"string","description":"Data da Emissão da NF-e."},"hEmissao":{"type":"string","description":"Hora da Emissão da NF-e."},"dFatura":{"type":"string","description":"Data do faturamento."},"hFatura":{"type":"string","description":"Hora de Faturamento."},"dSaida":{"type":"string","description":"Data de Saída."},"hSaida":{"type":"string","description":"Hora de Saída da NF-e."},"listaMensagens":{"type":"array","items":{"type":"object","properties":{"cCodigo":{"type":"string","description":"Código da mensagem de erro ou aviso."},"cDescricao":{"type":"string","description":"Descrição da mensagem de erro ou aviso."},"cCorrecao":{"type":"string","description":"Correção da descrição de mensagem de erro ou aviso."}}},"description":"Mensagens de Erros."},"cXmlDistr":{"type":"string","description":"XML de distribuição da NF-e."},"cUrlDanfe":{"type":"string","description":"Link para o DANFE da NF-e gerada."}}},"description":"Lista de NF-es geradas."},"cCodStatus":{"type":"string"},"cDescStatus":{"type":"string"}},"title":"StatusDevolucaoVenda (retorno)"},"produtos_dfedocs_ObterCTe":{"type":"object","title":"ObterCTe","description":"Obtém as informações do CT-e.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterCTe"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdCTe":{"type":"integer","maxLength":15}},"required":["nIdCTe"]}}},"example":{"call":"ObterCTe","param":[{"nIdCTe":0}]}},"produtos_dfedocs_ObterCTe_retorno":{"type":"object","properties":{"cNumCTe":{"type":"string","description":"Número do CTe."},"nChaveCTe":{"type":"string","description":"Chave do CTe."},"dDataEmisCTe":{"type":"string","description":"Data da emissão do CTe."},"cModeloCTe":{"type":"string","description":"Modelo do CTe."},"cXmlCTe":{"type":"string","description":"XML do CTe."},"cPdf":{"type":"string","description":"Link do PDF."},"cLinkPortal":{"type":"string","description":"Link para acessar os documentos no portal Omie."},"cCodStatus":{"type":"string"},"cDesStatus":{"type":"string"}},"title":"ObterCTe (retorno)"},"produtos_dfedocs_ObterCupom":{"type":"object","title":"ObterCupom","description":"Obtém o cupom.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterCupom"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdCupom":{"type":"integer","maxLength":15}},"required":["nIdCupom"]}}},"example":{"call":"ObterCupom","param":[{"nIdCupom":0}]}},"produtos_dfedocs_ObterCupom_retorno":{"type":"object","properties":{"cNumCupom":{"type":"integer","description":"Número do Cupom Fiscal."},"nChaveCupom":{"type":"integer","description":"Chave do Cupom Fiscal."},"dDataEmisCupom":{"type":"string","description":"Data da emissão do Cupom Fiscal."},"cXmlCupom":{"type":"string","description":"XML do Cupom Fiscal."},"cModeloCupom":{"type":"string","description":"Modelo do Cupom Fiscal (NFCe = 60\\SAT = 59)."},"cPdf":{"type":"string","description":"Link do PDF."},"cLinkPortal":{"type":"string","description":"Link para acessar os documentos no Portal Omie."},"cCodStatus":{"type":"string"},"cDesStatus":{"type":"string"}},"title":"ObterCupom (retorno)"},"produtos_dfedocs_ObterDanfeSimp":{"type":"object","title":"ObterDanfeSimp","description":"Obtém informações de uma Nota fiscal com danfe simplificado.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterDanfeSimp"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdNfe":{"type":"integer","maxLength":15}},"required":["nIdNfe"]}}},"example":{"call":"ObterDanfeSimp","param":[{"nIdNfe":0}]}},"produtos_dfedocs_ObterDanfeSimp_retorno":{"type":"object","properties":{"cNumNfe":{"type":"string","description":"Número da Nota Fiscal."},"nChaveNfe":{"type":"string","description":"Chave da Nota Fiscal."},"cPdf":{"type":"string","description":"Link do PDF do Danfe simplificado."},"cCodStatus":{"type":"string"},"cDesStatus":{"type":"string"}},"title":"ObterDanfeSimp (retorno)"},"produtos_dfedocs_ObterNfe":{"type":"object","title":"ObterNfe","description":"Obtém a nota fiscal eletrônica.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterNfe"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdNfe":{"type":"integer","maxLength":15}},"required":["nIdNfe"]}}},"example":{"call":"ObterNfe","param":[{"nIdNfe":0}]}},"produtos_dfedocs_ObterNfe_retorno":{"type":"object","properties":{"cNumNfe":{"type":"string","description":"Número da Nota Fiscal."},"nChaveNfe":{"type":"string","description":"Chave da Nota Fiscal."},"dDataEmisNfe":{"type":"string","description":"Data da emissão da Nota Fiscal."},"cXmlNfe":{"type":"string","description":"XML da Nota Fiscal."},"cPdf":{"type":"string","description":"Link do PDF."},"cLinkPortal":{"type":"string","description":"Link para acessar os documentos no portal Omie."},"cCodStatus":{"type":"string"},"cDesStatus":{"type":"string"}},"title":"ObterNfe (retorno)"},"produtos_dfedocs_ObterPedVenda":{"type":"object","title":"ObterPedVenda","description":"Obtém informações de um pedido de venda.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterPedVenda"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdPed":{"type":"integer","maxLength":15}},"required":["nIdPed"]}}},"example":{"call":"ObterPedVenda","param":[{"nIdPed":0}]}},"produtos_dfedocs_ObterPedVenda_retorno":{"type":"object","properties":{"cNumPed":{"type":"string","description":"Retorna o número do pedido de venda."},"cPdfPed":{"type":"string","description":"PDF do pedido de venda."},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro durante o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodigoStatus\"."}},"title":"ObterPedVenda (retorno)"},"produtos_etapafat_ListarEtapasFaturamento":{"type":"object","title":"ListarEtapasFaturamento","description":"Lista as etapas do faturamento","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarEtapasFaturamento"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"ordenar_por":{"type":"string","maxLength":100,"description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."}}}}},"example":{"call":"ListarEtapasFaturamento","param":[{"pagina":1,"registros_por_pagina":20}]}},"produtos_etapafat_ListarEtapasFaturamento_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada"},"total_de_paginas":{"type":"integer","description":"Número total de páginas"},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"total de registros encontrados"},"cadastros":{"type":"array","items":{"type":"object","properties":{"cCodOperacao":{"type":"string","description":"Código da Operação de faturamento."},"cDescOperacao":{"type":"string","description":"Descrição da Operação de faturamento."},"etapas":{"type":"array","items":{"type":"object","properties":{"cCodigo":{"type":"string","description":"Código da etapa do processo de faturamento."},"cDescricao":{"type":"string","description":"Descrição da etapa do processo de faturamento."},"cDescrPadrao":{"type":"string","description":"Descrição padrão da etapa do processo de faturamento."},"cInativo":{"type":"string","description":"Indica se a etapa do processo está Inativa \"S\" = INATIVA \"N\" = ATIVA"}}},"description":"Lista de etapas"}}},"description":"Lista de etapas do processo de faturamento."}},"title":"ListarEtapasFaturamento (retorno)"},"produtos_formaspagcompras_ListarFormasPagCompras":{"type":"object","title":"ListarFormasPagCompras","description":"Listar formas de Pagamento de Compras.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarFormasPagCompras"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"ordenar_por":{"type":"string","maxLength":100,"example":"CODIGO","description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."}}}}},"example":{"call":"ListarFormasPagCompras","param":[{"pagina":1,"registros_por_pagina":50}]}},"produtos_formaspagcompras_ListarFormasPagCompras_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada."},"total_de_paginas":{"type":"integer","description":"Número total de páginas."},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"Total de registros encontrados."},"cadastros":{"type":"array","items":{"type":"object","properties":{"cCodigo":{"type":"string","description":"Código da forma de pagamento."},"nQtdeParc":{"type":"integer","description":"Quantidade de parcelas."},"cDescricao":{"type":"string","description":"Descrição da forma de pagamento."},"cListaParc":{"type":"string","description":"Lista de dias de vencimentos."},"nDiasParc":{"type":"integer","description":"Dias de deslocamento para geração da parcela."}}},"description":"Lista as formas de pagamento de compras encontradas."}},"title":"ListarFormasPagCompras (retorno)"},"produtos_formaspagvendas_ListarFormasPagVendas":{"type":"object","title":"ListarFormasPagVendas","description":"Lista as formas de pagamento de vendas.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarFormasPagVendas"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"ordenar_por":{"type":"string","maxLength":100,"example":"CODIGO","description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."}}}}},"example":{"call":"ListarFormasPagVendas","param":[{"pagina":1,"registros_por_pagina":50}]}},"produtos_formaspagvendas_ListarFormasPagVendas_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada."},"total_de_paginas":{"type":"integer","description":"Número total de páginas."},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"Total de registros encontrados."},"cadastros":{"type":"array","items":{"type":"object","properties":{"cCodigo":{"type":"string","description":"Código da forma de pagamento."},"nQtdeParc":{"type":"integer","description":"Quantidade de parcelas."},"cDescricao":{"type":"string","description":"Descrição da forma de pagamento."},"cListaParc":{"type":"string","description":"Lista de dias de vencimentos."},"nDiasParc":{"type":"integer","description":"Dias de deslocamento para geração da parcela."}}},"description":"Lista os CESTs encontrados."}},"title":"ListarFormasPagVendas (retorno)"},"produtos_freteecommerce_VincularCotacao":{"type":"object","title":"VincularCotacao","description":"Faz o vinculo entre uma cotação e o pedido.","required":["call","param"],"properties":{"call":{"type":"string","enum":["VincularCotacao"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdPedido":{"type":"integer","maxLength":15,"description":"Código interno do pedido de venda. Obrigatório."},"cCodigoOperadora":{"type":"string","maxLength":50,"description":"Código da operadora responsável pela cotação. Obrigatório. Hoje só INTELIPOST é atendida."},"cCodigoCotacao":{"type":"string","maxLength":100,"description":"Código da cotação na operadora de frete (gerado no checkout da loja). Obrigatório."},"cCodigoEntrega":{"type":"string","maxLength":50,"description":"Código da opção de entrega escolhida dentro da cotação, na operadora. Obrigatório."}},"required":["cCodigoCotacao","cCodigoEntrega","cCodigoOperadora","nIdPedido"]}}},"example":{"call":"VincularCotacao","param":[{"nIdPedido":3478512690,"cCodigoOperadora":"INTELIPOST","cCodigoCotacao":"481516234","cCodigoEntrega":"1"}]}},"produtos_freteecommerce_VincularCotacao_retorno":{"type":"object","properties":{"cCodStatus":{"type":"string","description":"Código do status. \"0\" é sucesso; outro valor indica recusa, com o motivo em cDesStatus."},"cDesStatus":{"type":"string","description":"Descrição do status ou motivo da recusa."}},"title":"VincularCotacao (retorno)"},"produtos_frete_CancelarCotacao":{"type":"object","title":"CancelarCotacao","description":"Cancelamento de uma cotação de frete.","required":["call","param"],"properties":{"call":{"type":"string","enum":["CancelarCotacao"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdPedido":{"type":"integer","maxLength":15,"description":"ID do Pedido de Venda."}},"required":["nIdPedido"]}}},"example":{"call":"CancelarCotacao","param":[{"nIdPedido":3478512690}]}},"produtos_frete_CancelarCotacao_retorno":{"type":"object","properties":{"cCodStatus":{"type":"string","description":"Código do Status"},"cDesStatus":{"type":"string","description":"Descrição do Status"}},"title":"CancelarCotacao (retorno)"},"produtos_frete_CotarFrete":{"type":"object","title":"CotarFrete","description":"Realiza a cotação de frete.","required":["call","param"],"properties":{"call":{"type":"string","enum":["CotarFrete"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdPedido":{"type":"integer","maxLength":15,"description":"ID do Pedido de Venda."}},"required":["nIdPedido"]}}},"example":{"call":"CotarFrete","param":[{"nIdPedido":3478512690}]}},"produtos_frete_CotarFrete_retorno":{"type":"object","properties":{"listaCotacao":{"type":"array","items":{"type":"object","properties":{"nIdFrete":{"type":"integer","description":"ID do frete. É utilizado para identificar a opção de entrega, esse campo será utilizado para gerar o frete. Essa informação é obtida executando o método CotarFrete, onde é retornado as opções de entrega disponíveis."},"nDiasEntrega":{"type":"integer","description":"Prazo em dias para a entrega ser efetuada."},"cTipoServico":{"type":"string","description":"Tipo do serviço de entrega. Exemplo: Correios PAC Correios SEDEX"},"cDescricaoServico":{"type":"string","description":"Descrição do serviço de entrega."},"cMetodoFrete":{"type":"string","description":"Método de envio. Exemplo: STANDARD EXPRESS"},"nValorFrete":{"type":"decimal","description":"Valor do frete."},"cNomeTransportadora":{"type":"string","description":"Nome da empresa responsável pela entrega."}}},"description":"lista de opções de frete encontrados."},"cCodStatus":{"type":"string","description":"Código do Status"},"cDesStatus":{"type":"string","description":"Descrição do Status"}},"title":"CotarFrete (retorno)"},"produtos_frete_GerarEtiqueta":{"type":"object","title":"GerarEtiqueta","description":"Gera as etiquetas do frete.","required":["call","param"],"properties":{"call":{"type":"string","enum":["GerarEtiqueta"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdPedido":{"type":"integer","maxLength":15,"description":"ID do Pedido de Venda."}},"required":["nIdPedido"]}}},"example":{"call":"GerarEtiqueta","param":[{"nIdPedido":3478512690}]}},"produtos_frete_GerarEtiqueta_retorno":{"type":"object","properties":{"listaEtiqueta":{"type":"array","items":{"type":"object","properties":{"cUrlEtiqueta":{"type":"string","description":"URL da etiqueta em formato PDF."}}},"description":"Lista das etiquetas."},"cDesStatus":{"type":"string","description":"Descrição do Status"},"cCodStatus":{"type":"string","description":"Código do Status"}},"title":"GerarEtiqueta (retorno)"},"produtos_frete_GerarFrete":{"type":"object","title":"GerarFrete","description":"Gera o frete de um pedido de venda.","required":["call","param"],"properties":{"call":{"type":"string","enum":["GerarFrete"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdPedido":{"type":"integer","maxLength":15,"description":"ID do Pedido de Venda."}},"required":["nIdPedido"]}}},"example":{"call":"GerarFrete","param":[{"nIdPedido":3478512690}]}},"produtos_frete_GerarFrete_retorno":{"type":"object","properties":{"nIdPedido":{"type":"integer","description":"ID do Pedido de Venda."},"cUrlRastreio":{"type":"string","description":"URL de rastreio do frete."},"listaVolume":{"type":"array","items":{"type":"object","properties":{"cCodigoRastreio":{"type":"string","description":"Código de rastreio do volume do frete."}}},"description":"Lista de volumes do frete."},"cDesStatus":{"type":"string","description":"Descrição do Status"},"cCodStatus":{"type":"string","description":"Código do Status"}},"title":"GerarFrete (retorno)"},"produtos_frete_ListarStatusFrete":{"type":"object","title":"ListarStatusFrete","description":"Obtem a listagem contendo os status das entregas.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarStatusFrete"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página. Padrão 1."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Registros por página. Padrão 100, máximo 100 (valor maior volta a 100)."},"cCodigoStatus":{"type":"string","maxLength":3,"description":"Filtra pelo código do status da entrega (3 caracteres; precisa existir na tabela de status de frete)."},"dStatus":{"type":"string","description":"Filtra pela data da última atualização do status, no formato dd/mm/aaaa."},"hStatus":{"type":"string","maxLength":8,"description":"Filtra pela hora exata da última atualização do status, no formato hh:mm:ss."},"nIdTransp":{"type":"integer","maxLength":15,"description":"Filtra pelo código da transportadora do pedido (código interno do cadastro de clientes e fornecedores)."}}}}},"example":{"call":"ListarStatusFrete","param":[{"nPagina":1,"nRegPorPagina":20}]}},"produtos_frete_ListarStatusFrete_retorno":{"type":"object","properties":{"nPagina":{"type":"integer","description":"Número da página devolvida."},"nTotPaginas":{"type":"integer","description":"Total de páginas."},"nRegistros":{"type":"integer","description":"Registros devolvidos nesta página."},"nTotRegistros":{"type":"integer","description":"Total de registros encontrados."},"listaStatusFrete":{"type":"array","items":{"type":"object","properties":{"nIdPedido":{"type":"integer","description":"Código interno do pedido de venda."},"dEntrega":{"type":"string","description":"Previsão de entrega informada pela operadora, no formato dd/mm/aaaa."},"cCodigoOperadora":{"type":"string","description":"Código da operadora de frete (ex.: CORREIOS, MELHORENVIO, INTELIPOST)."},"cCodigoRastreio":{"type":"string","description":"Código de rastreio do volume na operadora."},"cCodigoStatus":{"type":"string","description":"Código do status da entrega, com 3 caracteres, conforme a tabela de status de frete da Omie."},"cDescricaoStatus":{"type":"string","description":"Descrição do status da entrega."},"dStatus":{"type":"string","description":"Data da última atualização do status, no formato dd/mm/aaaa."},"hStatus":{"type":"string","description":"Hora da última atualização do status, no formato hh:mm:ss."},"nIdTransp":{"type":"integer","description":"Código da transportadora do pedido de venda (código interno do cadastro de clientes e fornecedores)."}}}},"cCodStatus":{"type":"string","description":"Preenchido só quando nada é encontrado (\"100\", com o aviso em cDesStatus)."},"cDesStatus":{"type":"string","description":"Descrição do aviso quando nada é encontrado."}},"title":"ListarStatusFrete (retorno)"},"produtos_frete_ObterRastreio":{"type":"object","title":"ObterRastreio","description":"Obtem a URL de rastreio do frete.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterRastreio"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdPedido":{"type":"integer","maxLength":15,"description":"ID do Pedido de Venda."}},"required":["nIdPedido"]}}},"example":{"call":"ObterRastreio","param":[{"nIdPedido":3478512690}]}},"produtos_frete_ObterRastreio_retorno":{"type":"object","properties":{"cCodRastreio":{"type":"string","description":"Código de Rastreio do Pedido"},"cUrlRastreio":{"type":"string","description":"URL do rastreio do frete."},"cDesStatus":{"type":"string","description":"Descrição do Status"},"cCodStatus":{"type":"string","description":"Código do Status"}},"title":"ObterRastreio (retorno)"},"produtos_frete_SelecionarFrete":{"type":"object","title":"SelecionarFrete","description":"Seleciona o frete a partir das opção de uma cotação.","required":["call","param"],"properties":{"call":{"type":"string","enum":["SelecionarFrete"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdFrete":{"type":"integer","maxLength":15,"description":"ID do frete.\n\nÉ utilizado para identificar a opção de entrega, esse campo será utilizado para gerar o frete.\n\nEssa informação é obtida executando o método CotarFrete, onde é retornado as opções de entrega disponíveis."},"lGratis":{"type":"boolean","description":"Indica se o frete amarrado ao pedido é grátis"}},"required":["nIdFrete"]}}},"example":{"call":"SelecionarFrete","param":[{"nIdFrete":3478519021,"lGratis":false}]}},"produtos_frete_SelecionarFrete_retorno":{"type":"object","properties":{"cCodStatus":{"type":"string","description":"Código do Status"},"cDesStatus":{"type":"string","description":"Descrição do Status"}},"title":"SelecionarFrete (retorno)"},"produtos_frete_StatusFrete":{"type":"object","title":"StatusFrete","description":"Obtêm o status da entrega.","required":["call","param"],"properties":{"call":{"type":"string","enum":["StatusFrete"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdPedido":{"type":"integer","maxLength":15,"description":"ID do Pedido de Venda."}},"required":["nIdPedido"]}}},"example":{"call":"StatusFrete","param":[{"nIdPedido":3478512690}]}},"produtos_frete_StatusFrete_retorno":{"type":"object","properties":{"dEntrega":{"type":"string","description":"Previsão de entrega informada pela operadora, no formato dd/mm/aaaa."},"cCodigoOperadora":{"type":"string","description":"Código da operadora de frete (ex.: CORREIOS, MELHORENVIO, INTELIPOST)."},"cCodigoRastreio":{"type":"string","description":"Código de rastreio do volume na operadora."},"cCodigoStatus":{"type":"string","description":"Código do status da entrega, com 3 caracteres, conforme a tabela de status de frete da Omie."},"cDescricaoStatus":{"type":"string","description":"Descrição do status da entrega."},"dStatus":{"type":"string","description":"Data da última atualização do status, no formato dd/mm/aaaa."},"hStatus":{"type":"string","description":"Hora da última atualização do status, no formato hh:mm:ss."},"nIdTransp":{"type":"integer","description":"Código da transportadora do pedido de venda (código interno do cadastro de clientes e fornecedores)."},"cCodStatus":{"type":"string","description":"Código do status do processamento. \"0\" é sucesso; outro valor indica recusa, com o motivo em cDesStatus."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento."}},"title":"StatusFrete (retorno)"},"produtos_frete_VincularFrete":{"type":"object","title":"VincularFrete","description":"Vincular um Tipo de serviço de Frete a um pedido.","required":["call","param"],"properties":{"call":{"type":"string","enum":["VincularFrete"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdPedido":{"type":"integer","maxLength":15,"description":"Código interno do pedido de venda."},"cCodigoOperadora":{"type":"string","maxLength":50,"description":"Código da operadora de frete integrada e habilitada na empresa (ex.: CORREIOS, MELHORENVIO, MANDAE, FRENET, LOGGI, INTELIPOST, TOTALEXPRESS, FRETERAPIDO)."},"cTipoServico":{"type":"string","maxLength":100,"description":"Tipo do serviço de entrega.\n\nExemplo:\nCorreios PAC\nCorreios SEDEX\n03220\nF_3"},"cNomeTransportadora":{"type":"string","maxLength":100,"description":"Nome da empresa responsável pela entrega. Nas operadoras com serviço cadastrado o nome vem do cadastro do serviço."},"nDiasEntrega":{"type":"integer","maxLength":4,"description":"Prazo de entrega em dias."},"lGratis":{"type":"boolean","description":"true deixa o frete sem custo para o cliente."},"cCodigoCotacao":{"type":"string","maxLength":100,"description":"Código da cotação.\n\nUsado somente quando o cCodigoOperadora == \"INTELIPOST\""}},"required":["cCodigoOperadora","cTipoServico","nIdPedido"]}}},"example":{"call":"VincularFrete","param":[{"nIdPedido":3478512690,"cCodigoOperadora":"CORREIOS","cTipoServico":"03298","nDiasEntrega":5,"lGratis":false}]}},"produtos_frete_VincularFrete_retorno":{"type":"object","properties":{"cCodStatus":{"type":"string","description":"Código do Status"},"cDesStatus":{"type":"string","description":"Descrição do Status"}},"title":"VincularFrete (retorno)"},"produtos_icbscst_ListarCSTIbsCbs":{"type":"object","title":"ListarCSTIbsCbs","description":"Listagem das CST's do IBS e CBS.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarCSTIbsCbs"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"nRegistrosPorPagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página."},"cDescricao":{"type":"string","maxLength":64,"description":"Descrição do CST do IBS e CBS."}}}}},"example":{"call":"ListarCSTIbsCbs","param":[{"nPagina":1,"nRegistrosPorPagina":50}]}},"produtos_icbscst_ListarCSTIbsCbs_retorno":{"type":"object","properties":{"nPagina":{"type":"integer","description":"Número da página retornada."},"nTotalPaginas":{"type":"integer","description":"Número total de páginas."},"nRegistrosPorPagina":{"type":"integer","description":"Número de registros retornados na página."},"nTotalRegistros":{"type":"integer","description":"Total de registros encontrados."},"cadastros":{"type":"array","items":{"type":"object","properties":{"cCodigo":{"type":"string","description":"Código do CST do IBS e CBS."},"cDescricao":{"type":"string","description":"Descrição do CST do IBS e CBS."}}},"description":"Lista os CST's do IBS e CBS."}},"title":"ListarCSTIbsCbs (retorno)"},"produtos_icmscsosn_ListarCSOSN":{"type":"object","title":"ListarCSOSN","description":"Listar os CSOSN do ICMS.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarCSOSN"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"ordenar_por":{"type":"string","maxLength":100,"example":"CODIGO","description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."}}}}},"example":{"call":"ListarCSOSN","param":[{"pagina":1,"registros_por_pagina":50}]}},"produtos_icmscsosn_ListarCSOSN_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada."},"total_de_paginas":{"type":"integer","description":"Número total de páginas."},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"Total de registros encontrados."},"cadastros":{"type":"array","items":{"type":"object","properties":{"nCodigo":{"type":"string","description":"Código do CSOSN do ICMS."},"cDescricao":{"type":"string","description":"Descrição do CSOSN do ICMS."}}},"description":"Lista os CSOSN do ICMS encontrados."}},"title":"ListarCSOSN (retorno)"},"produtos_icmscst_ListarCST":{"type":"object","title":"ListarCST","description":"Listar os CSTs do ICMS.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarCST"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"ordenar_por":{"type":"string","maxLength":100,"example":"CODIGO","description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."}}}}},"example":{"call":"ListarCST","param":[{"pagina":1,"registros_por_pagina":50}]}},"produtos_icmscst_ListarCST_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada."},"total_de_paginas":{"type":"integer","description":"Número total de páginas."},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"Total de registros encontrados."},"cadastros":{"type":"array","items":{"type":"object","properties":{"nCodigo":{"type":"string","description":"Código do CST do ICMS."},"cDescricao":{"type":"string","description":"Descrição do CST do ICMS."}}},"description":"Lista os CSTs do ICMS encontrados."}},"title":"ListarCST (retorno)"},"produtos_icmsorigem_ListarOrigMerc":{"type":"object","title":"ListarOrigMerc","description":"Listar a origem da mercadoria do ICMS.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarOrigMerc"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"ordenar_por":{"type":"string","maxLength":100,"example":"CODIGO","description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."}}}}},"example":{"call":"ListarOrigMerc","param":[{"pagina":1,"registros_por_pagina":50}]}},"produtos_icmsorigem_ListarOrigMerc_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada."},"total_de_paginas":{"type":"integer","description":"Número total de páginas."},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"Total de registros encontrados."},"cadastros":{"type":"array","items":{"type":"object","properties":{"nCodigo":{"type":"string","description":"Código da Origem da Mercadoria do ICMS."},"cDescricao":{"type":"string","description":"Descrição da Origem da Mercadoria do ICMS."}}},"description":"Lista as Origem da Mercadoria do ICMS."}},"title":"ListarOrigMerc (retorno)"},"produtos_ipicst_ListarCstIpi":{"type":"object","title":"ListarCstIpi","description":"Listar CST do IPI.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarCstIpi"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"ordenar_por":{"type":"string","maxLength":100,"example":"CODIGO","description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."}}}}},"example":{"call":"ListarCstIpi","param":[{"pagina":1,"registros_por_pagina":50}]}},"produtos_ipicst_ListarCstIpi_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada."},"total_de_paginas":{"type":"integer","description":"Número total de páginas."},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"Total de registros encontrados."},"cadastros":{"type":"array","items":{"type":"object","properties":{"nCodigo":{"type":"string","description":"Código do CST do IPI."},"cDescricao":{"type":"string","description":"Descrição do CST do IPI."}}},"description":"Lista os CSTs do IPI encontrados."}},"title":"ListarCstIpi (retorno)"},"produtos_ipienq_ListarEnqIpi":{"type":"object","title":"ListarEnqIpi","description":"Listar Enquadramento do IPI.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarEnqIpi"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"ordenar_por":{"type":"string","maxLength":100,"example":"CODIGO","description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."}}}}},"example":{"call":"ListarEnqIpi","param":[{"pagina":1,"registros_por_pagina":50}]}},"produtos_ipienq_ListarEnqIpi_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada."},"total_de_paginas":{"type":"integer","description":"Número total de páginas."},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"Total de registros encontrados."},"cadastros":{"type":"array","items":{"type":"object","properties":{"nCodigo":{"type":"string","description":"Código do Enquadramento do IPI."},"cDescricao":{"type":"string","description":"Descrição do Enquadramento do IPI."}}},"description":"Lista os Enquadramentos do IPI."}},"title":"ListarEnqIpi (retorno)"},"produtos_ncm_ConsultarNCM":{"type":"object","title":"ConsultarNCM","description":"Consulta um NCM.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarNCM"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cCodigo":{"type":"string","maxLength":13,"description":"Código do NCM.\nNo formato 9999.99.99."}},"required":["cCodigo"]}}},"example":{"call":"ConsultarNCM","param":[{"cCodigo":""}]}},"produtos_ncm_ConsultarNCM_retorno":{"type":"object","properties":{"cCodigo":{"type":"string","description":"Código do NCM. No formato 9999.99.99."},"cEX":{"type":"string","description":"EX."},"cDescricao":{"type":"string","description":"Descrição do NCM."}},"title":"ConsultarNCM (retorno)"},"produtos_ncm_ListarNCM":{"type":"object","title":"ListarNCM","description":"Lista os NCMs cadastrados.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarNCM"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página que se deseja resgatar.\nO padrão é \"1\"."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Número de registros retornados por página.\nO padrão é 20.\nO limite máximo é 50 por página."},"cOrdenarPor":{"type":"string","maxLength":100,"description":"Ordem os resultados da página por:\nCODIGO - Código do NCM.\nDESCRICAO - Nome do NCM."},"cOrdemDecrescente":{"type":"string","maxLength":1,"description":"Indica se a ordem de exibição é Decrescente caso seja informado \"S\"."},"cCodigo":{"type":"string","maxLength":13,"description":"Código do NCM.\nNo formato 9999.99.99."},"cDescricao":{"type":"string","maxLength":200,"description":"Descrição do NCM."}}}}},"example":{"call":"ListarNCM","param":[{"nPagina":1,"nRegPorPagina":50}]}},"produtos_ncm_ListarNCM_retorno":{"type":"object","properties":{"nPagina":{"type":"integer","description":"Número da página resgatada."},"nTotPaginas":{"type":"integer","description":"Número total de páginas encontradas."},"nRegistros":{"type":"integer","description":"Número de registros retornados na página."},"nTotRegistros":{"type":"integer","description":"Número total de registros encontrados."},"listaNCM":{"type":"array","items":{"type":"object","properties":{"cCodigo":{"type":"string","description":"Código do NCM. No formato 9999.99.99."},"cEX":{"type":"string","description":"EX."},"cDescricao":{"type":"string","description":"Descrição do NCM."}}},"description":"Lista de NCM."}},"title":"ListarNCM (retorno)"},"produtos_nf_NotaFiscalCancelar":{"type":"object","title":"NotaFiscalCancelar","description":"Cancela uma Nota Fiscal.","required":["call","param"],"properties":{"call":{"type":"string","enum":["NotaFiscalCancelar"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_nf":{"type":"integer","maxLength":15,"description":"Código interno da nota fiscal. Informe este ou codigo_nf_integracao."},"codigo_nf_integracao":{"type":"string","maxLength":20,"description":"Código de integração da nota fiscal. Informe este ou codigo_nf."},"dtCanc":{"type":"string","maxLength":10,"description":"Data do cancelamento, no formato dd/mm/aaaa. Obrigatório."},"xJust":{"type":"string","description":"Justificativa do cancelamento. Obrigatório."}},"required":["dtCanc","xJust"]}}},"example":{"call":"NotaFiscalCancelar","param":[{"codigo_nf":3478700021,"dtCanc":"09/10/2026","xJust":"Pedido cancelado pelo cliente antes da saída da mercadoria"}]}},"produtos_nf_NotaFiscalCancelar_retorno":{"type":"object","properties":{"codigo_nf":{"type":"integer","description":"Código interno da nota fiscal."},"codigo_nf_integracao":{"type":"string","description":"Código de integração da nota fiscal."},"nf_numero":{"type":"string","description":"Número da Nota Fiscal"},"nf_serie":{"type":"string","description":"Série da NF"},"nf_tipo":{"type":"string","description":"Tipo da nota: 0 entrada, 1 saída."},"codigo_status":{"type":"string","description":"\"0\" quando a solicitação foi registrada; \"999\" quando não foi, com o motivo no aviso da chamada."},"descricao_status":{"type":"string","description":"Descrição do resultado."}},"title":"NotaFiscalCancelar (retorno)"},"produtos_nf_NotaFiscalCartaCorrecao":{"type":"object","title":"NotaFiscalCartaCorrecao","description":"Efetua uma solicitação da Carta de Correção","required":["call","param"],"properties":{"call":{"type":"string","enum":["NotaFiscalCartaCorrecao"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_nf":{"type":"integer","maxLength":15,"description":"Código interno da nota fiscal. Informe este ou codigo_nf_integracao."},"codigo_nf_integracao":{"type":"string","maxLength":20,"description":"Código de integração da nota fiscal. Informe este ou codigo_nf."},"xCorrecao":{"type":"string","description":"Texto da correção. Obrigatório. Os acentos são removidos antes do envio."}},"required":["xCorrecao"]}}},"example":{"call":"NotaFiscalCartaCorrecao","param":[{"codigo_nf":3478700021,"xCorrecao":"Corrigir o endereco de entrega para Rua das Flores, 120, Centro"}]}},"produtos_nf_NotaFiscalCartaCorrecao_retorno":{"type":"object","properties":{"codigo_nf":{"type":"integer","description":"Código interno da nota fiscal."},"codigo_nf_integracao":{"type":"string","description":"Código de integração da nota fiscal."},"nf_numero":{"type":"string","description":"Número da Nota Fiscal"},"nf_serie":{"type":"string","description":"Série da Nota Fiscal"},"nf_tipo":{"type":"string","description":"Tipo da nota: 0 entrada, 1 saída."},"codigo_status":{"type":"string","description":"\"0\" quando a solicitação foi registrada; \"999\" quando não foi, com o motivo no aviso da chamada."},"descricao_status":{"type":"string","description":"Retorno do envio da carta de correção."}},"title":"NotaFiscalCartaCorrecao (retorno)"},"produtos_nf_NotaFiscalInutilizar":{"type":"object","title":"NotaFiscalInutilizar","description":"Inutiliza uma Nota Fiscal.","required":["call","param"],"properties":{"call":{"type":"string","enum":["NotaFiscalInutilizar"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_nf":{"type":"integer","maxLength":15,"description":"Código interno da nota fiscal. Informe este ou codigo_nf_integracao."},"codigo_nf_integracao":{"type":"string","maxLength":20,"description":"Código de integração da nota fiscal. Informe este ou codigo_nf."},"dtInut":{"type":"string","maxLength":10,"description":"Data da inutilização, no formato dd/mm/aaaa. Obrigatório."},"xJust":{"type":"string","description":"Justificativa da inutilização. Obrigatório."}},"required":["dtInut","xJust"]}}},"example":{"call":"NotaFiscalInutilizar","param":[{"codigo_nf":3478700022,"dtInut":"09/10/2026","xJust":"Numeração não utilizada por falha na transmissão da nota"}]}},"produtos_nf_NotaFiscalInutilizar_retorno":{"type":"object","properties":{"codigo_nf":{"type":"integer","description":"Código interno da nota fiscal."},"codigo_nf_integracao":{"type":"string","description":"Código de integração da nota fiscal."},"nf_numero":{"type":"string","description":"Número da Nota Fiscal"},"nf_serie":{"type":"string","description":"Série da NF"},"nf_tipo":{"type":"string","description":"Tipo da nota: 0 entrada, 1 saída."},"codigo_status":{"type":"string","description":"\"0\" quando a solicitação foi registrada; \"999\" quando não foi, com o motivo no aviso da chamada."},"descricao_status":{"type":"string","description":"Descrição do resultado."}},"title":"NotaFiscalInutilizar (retorno)"},"produtos_nf_NotaFiscalStatus":{"type":"object","title":"NotaFiscalStatus","description":"Retorna o status da Nota Fiscal","required":["call","param"],"properties":{"call":{"type":"string","enum":["NotaFiscalStatus"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_empresa":{"type":"integer","maxLength":15,"description":"Ignorado pela consulta (a empresa vem da nota)."},"codigo_empresa_integracao":{"type":"string","maxLength":20,"description":"Ignorado pela consulta."},"codigo_nf":{"type":"integer","maxLength":15,"description":"Código interno da nota fiscal. Informe este ou codigo_nf_integracao."},"codigo_nf_integracao":{"type":"string","maxLength":20,"description":"Código de integração da nota fiscal. Informe este ou codigo_nf."}}}}},"example":{"call":"NotaFiscalStatus","param":[{"codigo_nf":3478700021}]}},"produtos_nf_NotaFiscalStatus_retorno":{"type":"object","properties":{"integracao":{"type":"object","properties":{"codigo_empresa":{"type":"integer","description":"Código da empresa emitente da nota."},"codigo_empresa_integracao":{"type":"string","description":"Vem como informado no pedido."},"codigo_nf":{"type":"integer","description":"Código da Nota Fiscal"},"codigo_nf_integracao":{"type":"string","description":"Código de Integração da Nota Fiscal."}},"description":"Identificação da nota."},"dados_lote":{"type":"object","properties":{"numero":{"type":"integer","description":"Número do lote"},"ambiente":{"type":"string","description":"Ambiente do lote: P produção, H homologação."},"status":{"type":"string","description":"Status do Lote"},"status_sefaz":{"type":"string","description":"Código de status devolvido pela SEFAZ."},"data_envio":{"type":"string","description":"Data de envio"},"hora_envio":{"type":"string","description":"Hora de envio do lote, no formato hh:mm:ss."},"data_retorno":{"type":"string","description":"Data de retorno do lote, no formato dd/mm/aaaa."},"hora_retorno":{"type":"string","description":"Hora de retorno do lote, no formato hh:mm:ss."},"recibo":{"type":"integer","description":"Número do recibo de envio do lote na SEFAZ."}},"description":"Lote de envio da NF-e à SEFAZ."},"dados_nota_fiscal":{"type":"object","properties":{"numero":{"type":"string","description":"Número da Nota Fiscal"},"serie":{"type":"string","description":"Série da Nota Fiscal"},"tipo":{"type":"string","description":"Tipo da nota: 0 entrada, 1 saída."},"data_emissao":{"type":"string","description":"Data de Emissão"},"valor_total":{"type":"decimal","description":"Valor Total"},"status":{"type":"string"},"status_sefaz":{"type":"string","description":"Código de status devolvido pela SEFAZ."},"chave_nfe":{"type":"string","description":"Chave de acesso da NF-e (44 dígitos)."},"protocolo":{"type":"integer","description":"Número do protocolo de autorização."},"digVal":{"type":"string"},"faturada":{"type":"string","description":"S quando a NF-e foi autorizada."}},"description":"Dados da NF-e."},"dados_cancelamento":{"type":"object","properties":{"nfCanc":{"type":"string","description":"S quando a nota foi cancelada."},"dtCanc":{"type":"string","description":"Data do cancelamento, no formato dd/mm/aaaa."},"dtRet":{"type":"string","description":"Data de retorno do cancelamento"},"hrRet":{"type":"string","description":"Hora de retorno do cancelamento"},"xJust":{"type":"string","description":"Motivo do cancelamento."}},"description":"Dados do cancelamento, quando houver."},"mensagens":{"type":"array","items":{"type":"object","properties":{"codigo":{"type":"string","description":"Código da mensagem."},"tipo":{"type":"string","description":"Tipo da mensagem."},"descricao":{"type":"string","description":"Descrição da mensagem."},"correcao":{"type":"string","description":"Orientação de correção."}}},"description":"Mensagens de retorno da SEFAZ para o lote (rejeições e avisos)."}},"title":"NotaFiscalStatus (retorno)"},"produtos_nfce_ImportarNFCe":{"type":"object","title":"ImportarNFCe","description":"Importa o XML de uma Nota Fiscal do Consumidor Eletrônica.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ImportarNFCe"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"emiNome":{"type":"string","maxLength":20,"description":"Nome do aplicativo emissor do cupom fiscal.\nO aplicativo deve ser previamente cadastrado. Para isso entre em contato com a nosso suporte."},"emiVersao":{"type":"string","maxLength":20,"description":"Versão do aplicativo emissor do cupom fiscal."},"emiId":{"type":"string","maxLength":20,"description":"Identificação do computador onde o aplicativo emissor do cupom fiscal está instalado. É o código do PDV.\nExemplos: \"01\", \"20\", \"55\"."},"chNFe":{"type":"string","maxLength":44,"description":"Chave de Acesso da Nota Fiscal Consumidor Eletrônico."},"nfceXml":{"type":"string","description":"XML da NFC-e enviada.\n\nPreechimento obrigatório.\n\nAntes de enviar, converta os seus seguintes caracteres:\n\n&amp; para &amp;amp;\n> para &amp;gt;\n< para &amp;lt;\n\" para &amp;quot;\n\" para &amp;apos;\n| para &amp;#124;\n\nApós essa conversão aplique o MD5 para enviar no campo \"nfceMd5\".\n\nObservação: Para requisições SOAP usar CDATA como demonstra o exemplo abaixo:\n&lt;![CDATA[Conteúdo do campo convertido]]&gt;."},"nfceMd5":{"type":"string","maxLength":32,"description":"MD5 do arquivo XML enviado em \"nfceXml\"."},"cAcaoCliente":{"type":"string","maxLength":15,"description":"Ação a ser executada com relação a tag idCliente.\n\nPode ser:\n\n- CONSUMIDOR: assumirá que a venda foi realizada para um cliente consumidor padrão. Caso não exista um cliente consumidor cadastrado, o mesmo será criado automaticamente.\n\n- ERRO (padrão): Exigirá a definição de um idCliente válido.\n\n- INCLUIR: Com base nos dados do XML irá fazer a inclusão de um novo cliente."},"idCliente":{"type":"integer","maxLength":15,"description":"Código do cliente.\n\n- Se no XML não houver informações do cliente assumirá que a venda foi realizada para um cliente consumidor padrão. Caso não exista um cliente consumidor cadastrado, o mesmo será criado automaticamente.\n\n- Se no XML houver informações do cliente, seus dados serão consultados no Omie com base no CPF/CNPJ, caso não seja encontrado a tag cAcaoCliente será avaliada.\n\nPossível valores para tag cAcaoCliente:\n\n- CONSUMIDOR: assumirá que a venda foi realizada para um cliente consumidor padrão. Caso não exista um cliente consumidor cadastrado, o mesmo será criado automaticamente.\n\n- ERRO (padrão): Exigirá a definição de um idCliente válido.\n\n- INCLUIR: Com base nos dados do XML irá fazer a inclusão de um novo cliente."},"idVendedor":{"type":"integer","maxLength":15,"description":"Código do vendedor.\n\nQuando não informado, será criado um vendedor padrão para o emissor de cupom fiscal."},"idProjeto":{"type":"integer","maxLength":15,"description":"Código do projeto.\n\nQuando não informado, será criado um projeto padrão para o emissor de cupom fiscal."},"idLocalEstoque":{"type":"integer","maxLength":15,"description":"Código do Local do Estoque.\n\nCaso não informado assumirá o Local de Estoque padrão."},"cNaoMovEstoque":{"type":"string","maxLength":1,"description":"Indica que os items do Cupom Fiscal não devem movimentar o estoque.\n\nValores possíveis:\nS - Sim\nN - Não."},"cNaoGerarTitulo":{"type":"string","maxLength":1,"description":"Indica que a parcela não deve gerar um título no financeiro.\n\nValores possíveis:\nS - Sim\nN - Não."},"cIncluirProduto":{"type":"string","maxLength":1,"description":"Indica se na inclusão do cupom os produtos não existentes devem ser incluídos automaticamente.\n\nPossíveis valores:\nS - Sim\nN - Não (padrão)."}},"required":["chNFe","emiId","emiNome","emiVersao","nfceMd5","nfceXml"]}}},"example":{"call":"ImportarNFCe","param":[{"emiNome":"SeuPDV","emiVersao":"1.01.02","emiId":"PDV01","chNFe":"","nfceXml":"","nfceMd5":"","cAcaoCliente":"INCLUIR","idCliente":0,"idVendedor":0,"idProjeto":0,"idLocalEstoque":0,"cNaoMovEstoque":"N","cNaoGerarTitulo":"N","cIncluirProduto":"N"}]}},"produtos_nfce_ImportarNFCe_retorno":{"type":"object","properties":{"idImportacao":{"type":"integer","description":"ID da Importação da NFC-e."},"idCupom":{"type":"integer","description":"Identificação do cupom fiscal."},"idLote":{"type":"integer","description":"Identificação do lote do cupom fiscal."},"cCodStatus":{"type":"string","description":"Código do status de processamento do cupom fiscal. Se retornar 0 indica que o cupom foi processado com sucesso. Se retornar um valor maior que zero indica o código do erro gerado."},"cDesStatus":{"type":"string","description":"Descrição do status de processamento. Caso ocorra erro, retorna a descrição do erro gerado."}},"title":"ImportarNFCe (retorno)"},"produtos_nfconsultar_ConsultarNF":{"type":"object","title":"ConsultarNF","description":"Consulta uma Nota Fiscal.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarNF"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cCodNFInt":{"type":"string","maxLength":20,"description":"Código de Integração da NF (DEPRECATED)."},"nCodNF":{"type":"integer","maxLength":15,"description":"Código de Identificação da NF.\nÉ o nIdNF devolvido no grupo compl por ListarNF e ConsultarNF."},"nNF":{"type":"string","maxLength":10,"description":"Número do Documento Fiscal."},"serie":{"type":"string","maxLength":5,"description":"Série do Documento Fiscal."},"dEmi":{"type":"string","maxLength":10,"description":"Data de emissão."},"tpNF":{"type":"string","maxLength":1,"description":"Tipo de Operação: 0-entrada / 1-saída."},"cChaveNFe":{"type":"string","maxLength":44,"description":"Chave da NF-e."},"nIdPedido":{"type":"integer","maxLength":15,"description":"Código de identificação do pedido.\nInterno, utilizando apenas nas APIs."},"nIdCliente":{"type":"integer","maxLength":15,"description":"ID do Cliente."},"cnpj_cpf":{"type":"string","maxLength":100,"description":"CNPJ / CPF."},"cDetalhesPedido":{"type":"string","maxLength":1,"description":"Exibe os detalhes do pedido que originou a Nota Fiscal.\n\nPreecher com \"S\" ou \"N\"."},"tpAmb":{"type":"string","maxLength":1,"description":"Tipo de Ambiente.\nPode Ser:\n1 - Produção\n2 - Homologação."}}}}},"example":{"call":"ConsultarNF","param":[{"nCodNF":0,"nNF":"1"}]}},"produtos_nfconsultar_ConsultarNF_retorno":{"type":"object","properties":{"ide":{"type":"object","properties":{"indPag":{"type":"string","description":"Indicador da forma de pagamento: 0 - pagamento à vista; 1 - pagamento à prazo; 2 - outros."},"mod":{"type":"string","description":"Código do Modelo do Documento Fiscal: Utilizar o código 55 para identificação da NF-e, emitida em substituição ao modelo 1 ou 1A."},"serie":{"type":"string","description":"Série do Documento Fiscal."},"nNF":{"type":"string","description":"Número do Documento Fiscal."},"dEmi":{"type":"string","description":"Data de emissão."},"hEmi":{"type":"string","description":"Hora de Emissão."},"dSaiEnt":{"type":"string","description":"Data de saida."},"hSaiEnt":{"type":"string","description":"Hora de Saída ou da Entrada da Mercadoria/Produto."},"tpNF":{"type":"string","description":"Tipo de Operação: 0-entrada / 1-saída."},"tpAmb":{"type":"string","description":"Tipo de Ambiente = 1-Produção / 2-Homologação."},"finNFe":{"type":"string","description":"Finalidade de emissão da NFe: 1 - NF-e normal 2 - NF-e complementar 3 - NF-e de ajuste 4 - NF-e de devolução."},"dReg":{"type":"string","description":"Data de Registro."},"dCan":{"type":"string","description":"Data de cancelamento."},"dInut":{"type":"string","description":"Data de Inutilização."},"cDeneg":{"type":"string"}}},"nfEmitInt":{"type":"object","properties":{"nCodEmp":{"type":"integer","description":"Código da Empresa."},"cCodEmpInt":{"type":"string","description":"Código de integração da empresa."}}},"nfDestInt":{"type":"object","properties":{"nCodCli":{"type":"integer","description":"Código do cliente."},"cCodCliInt":{"type":"string","description":"Código de integração do cliente Fornecedor."},"cRazao":{"type":"string"},"cnpj_cpf":{"type":"string"}}},"det":{"type":"array","items":{"type":"object","properties":{"prod":{"type":"object","properties":{"cProd":{"type":"string","description":"Código do produto ou serviço."},"cEAN":{"type":"string","description":"GTIN (Global Trade Item Number) do produto, antigo código EAN ou código de barras."},"xProd":{"type":"string","description":"Descrição do produto ou serviço."},"NCM":{"type":"string"},"EXTIPI":{"type":"string","description":"DEPRECATED."},"CFOP":{"type":"string","description":"Código Fiscal de Operações e Prestações."},"uCom":{"type":"string","description":"Unidade Comercial."},"qCom":{"type":"decimal","description":"Quantidade Comercial."},"vUnCom":{"type":"decimal","description":"Valor Unitário de Comercialização."},"vProd":{"type":"decimal","description":"Valor Total Bruto dos Produtos."},"cEANTrib":{"type":"string","description":"GTIN (Global Trade Item Number) da unidade tributável, antigo código EAN ou código de barras."},"uTrib":{"type":"string","description":"Unidade Tributável."},"qTrib":{"type":"decimal","description":"Quantidade Tributável."},"vUnTrib":{"type":"decimal","description":"Valor Unitário de tributação."},"vFrete":{"type":"decimal","description":"Valor Total do Frete."},"vSeg":{"type":"decimal","description":"Valor Total do Seguro."},"vDesc":{"type":"decimal","description":"Valor do Desconto."},"vOutro":{"type":"decimal","description":"Outras despesas acessórias."},"vII":{"type":"decimal","description":"Valor de Impostos de Importação."},"indTot":{"type":"decimal","description":"Indica se valor do Item (vProd) entra no valor total da NF-e (vProd)."},"cProdOrig":{"type":"string","description":"Código do produto conforme informado na Nota Fiscal."},"xProdOrig":{"type":"string","description":"Descrição original do produto conforme informado na Nota Fiscal."},"nCMCUnitario":{"type":"decimal","description":"CMC Unitário."},"nCMCTotal":{"type":"decimal","description":"CMC Total."},"vTotItem":{"type":"decimal","description":"Valor total do item."},"vFCP":{"type":"decimal","description":"Valor do ICMS relativo ao Fundo de Combate à Pobreza (FCP) da UF de Destino."},"pCOFINS":{"type":"decimal","description":"Alíquota de COFINS."},"vCOFINS":{"type":"decimal","description":"Valor de COFINS."},"pPIS":{"type":"decimal","description":"Alíquota de PIS."},"vPIS":{"type":"decimal","description":"Valor do PIS."},"pISS":{"type":"decimal","description":"Alíquota de ISS."},"vISS":{"type":"decimal","description":"Valor de ISS."},"pIPI":{"type":"decimal","description":"Alíquota de IPI."},"vIPI":{"type":"decimal","description":"Valor de IPI."},"pIR":{"type":"decimal","description":"Alíquota de IR."},"vIR":{"type":"decimal","description":"Valor de IR."},"pINSS":{"type":"decimal","description":"Alíquota de INSS."},"vINSS":{"type":"decimal","description":"Valor de INSS."},"pCSLL":{"type":"decimal","description":"Alíquota de Contribuição Social sobre Lucro Líquido."},"vCSLL":{"type":"decimal","description":"Valor da Contribuição Social sobre Lucro Líquido."},"pICMS":{"type":"decimal","description":"Alíquota de ICMS."},"vICMS":{"type":"decimal","description":"Valor de ICMS."},"pICMSST":{"type":"decimal","description":"Alíquota de ICMSST."},"vICMSST":{"type":"decimal","description":"Valor de ICMSST."},"codigo_local_estoque":{"type":"integer","description":"Código do local do estoque."},"cCOFINSRetido":{"type":"string","description":"Indica se houve retenção de COFINS Possíveis valores: S = Sim N = Não."},"cPISRetido":{"type":"string","description":"Indica se houve retenção de PIS Possíveis valores: S = Sim N = Não."},"cINSSRetido":{"type":"string","description":"Indica se houve retenção de INSS Possíveis valores: S = Sim N = Não."},"cIRRetido":{"type":"string","description":"Indica se houve retenção de IR Possíveis valores: S = Sim N = Não."},"cISSRetido":{"type":"string","description":"Indica se houve retenção de ISS Possíveis valores: S = Sim N = Não."},"cICMSRetido":{"type":"string","description":"Indica se houve retenção de ICMS Possíveis valores: S = Sim N = Não."},"cCSLLRetido":{"type":"string","description":"Indica se houve retenção de CSLL Possíveis valores: S = Sim N = Não."},"pFCPST":{"type":"decimal","description":"Alíquota de FCPST."},"vFCPST":{"type":"decimal","description":"Valor do FCPST."},"pFCP":{"type":"decimal","description":"Alíquota de FCP."},"pMVAST":{"type":"decimal","description":"Percentual da margem do valor adicionado da base de cálculo do ICMS ST."},"pRedBC":{"type":"decimal","description":"Percentual de Redução da Base de Cálculo do ICMS."},"vBCCOFINS":{"type":"decimal","description":"Base de Cálculo do COFINS."},"vBCST":{"type":"decimal","description":"Base de Cálculo do ICMS ST."},"vBCIPI":{"type":"decimal","description":"Base de Cálculo do IPI."},"vBCISS":{"type":"decimal","description":"Base de Cálculo do ISS."},"vBCPIS":{"type":"decimal","description":"Base de Cálculo do PIS."},"vBCUFDest":{"type":"decimal","description":"Base de Cálculo do ICMS na UF de Destino."},"vBC":{"type":"decimal","description":"Base de Cálculo do ICMS."},"cOrigem":{"type":"string"},"pIcmsUfDest":{"type":"decimal","description":"Alíquota interna da UF de Destino."},"pIcmsInterest":{"type":"decimal","description":"Alíquota Interestadual das UF envolvidas."},"pRedBcICMDest":{"type":"decimal","description":"Percentual de Redução da Base de Cálculo do ICMS Destino."},"vICMDest":{"type":"decimal","description":"Valor do ICMS Interestadual para a UF de Destino."},"vICMRemet":{"type":"decimal","description":"Valor do ICMS Interestadual para a UF do Remetente."},"vIbs":{"type":"decimal","description":"Valor do IBS."},"pAliqIBSMun":{"type":"decimal","description":"Alíquota do IBS de competência do Município."},"pAliqIBSUF":{"type":"decimal","description":"Alíquota do IBS de competência das UF."},"vAliqIbsUf":{"type":"decimal","description":"Valor da alíquota do IBS da UF."},"vAliqIbsMun":{"type":"decimal","description":"Valor da alíquota do IBS do Município."},"vIbsUf":{"type":"decimal","description":"Valor do IBS de competência da UF."},"vIbsMun":{"type":"decimal","description":"Valor do IBS de competência do Município."},"vCbs":{"type":"decimal","description":"Valor da CBS."},"pAliqCbs":{"type":"decimal","description":"Alíquota da CBS."},"pReducaoCbs":{"type":"decimal","description":"Percentual da redução de alíquota do cClassTrib."},"pReducaoIbsMun":{"type":"decimal","description":"Percentual da redução de alíquota do cClassTrib - IBS UF."},"pReducaoIbsUf":{"type":"decimal","description":"Percentual da redução de alíquota do cClassTrib - IBS UF."},"vBCIbsCbs":{"type":"decimal","description":"Base de cálculo do IBS e CBS."},"vAliqCbs":{"type":"decimal","description":"Valor da alíquota da CBS."}}},"nfProdInt":{"type":"object","properties":{"nCodProd":{"type":"integer","description":"Código do Produto."},"cCodProdInt":{"type":"string","description":"Código de Integração do produto."},"nCodItem":{"type":"integer","description":"Código do item."},"cCodItemInt":{"type":"string","description":"Código de Integração do Item."}}},"itemPedido":{"type":"object","properties":{"nIdItemPedido":{"type":"integer","description":"Id do item do Pedido de Venda."},"cItemDevolvido":{"type":"string","description":"Indica se o Item do Pedido de Vendas foi devolvido (S/N)."},"nItemQtdDevolvida":{"type":"decimal","description":"Quantidade devolvida do Item do Pedido de Vendas."}},"description":"Dados do Item do Pedido de Venda."},"rastreabilidade":{"type":"object","properties":{"numeroLote":{"type":"string","description":"Número do Lote."},"qtdeProdutoLote":{"type":"decimal","description":"Quantidade de Produto."},"dataFabricacaoLote":{"type":"string","description":"Data de Fabricação/Produção."},"dataValidadeLote":{"type":"string","description":"Data de Validade."},"codigoAgregacaoLote":{"type":"string","description":"Código de Agregação."}},"description":"Dados específicos para rastreabilidade do produto."}}}},"total":{"type":"object","properties":{"ICMSTot":{"type":"object","properties":{"vBC":{"type":"decimal","description":"Base de Cálculo do ICMS."},"vICMS":{"type":"decimal","description":"Valor Total do ICMS."},"vBCST":{"type":"decimal","description":"Base de Cálculo do ICMS ST."},"vST":{"type":"decimal","description":"Valor Total do ICMS ST."},"vProd":{"type":"decimal","description":"Valor Total dos produtos e serviços."},"vFrete":{"type":"decimal","description":"Valor Total do Frete."},"vSeg":{"type":"decimal","description":"Valor Total do Seguro."},"vDesc":{"type":"decimal","description":"Valor Total do Desconto."},"vII":{"type":"decimal","description":"Valor Total do II."},"vIPI":{"type":"decimal","description":"Valor Total do IPI."},"vPIS":{"type":"decimal","description":"Valor do PIS."},"vCOFINS":{"type":"decimal","description":"Valor do COFINS."},"vOutro":{"type":"decimal","description":"Outras Despesas acessórias."},"vNF":{"type":"decimal","description":"Valor Total da NF-e."},"vTotTrib":{"type":"decimal","description":"Valor aproximado total de tributos federais, estaduais e municipais."},"vICMSDesonerado":{"type":"decimal","description":"Valor do ICMS Desonerado."},"vBCFCP":{"type":"decimal","description":"Base de Cálculo do Fundo de Combate a Pobreza."},"vFCP":{"type":"decimal","description":"Valor do Fundo de Combate a Pobreza."},"vBCFCPST":{"type":"decimal","description":"Base de Cálculo do Fundo de Combate a Pobreza ST."},"vFCPST":{"type":"decimal","description":"Valor do Fundo de Combate a Pobreza ST."}},"description":"Grupo de Valores Totais referentes ao ICMS."},"ISSQNtot":{"type":"object","properties":{"vServ":{"type":"decimal","description":"Valor Total dos Serviços sob não-incidência ou não tributados pelo ICMS."},"vBC":{"type":"decimal","description":"Base de Cálculo do ISS."},"vISS":{"type":"decimal","description":"Valor Total do ISS."},"vPIS":{"type":"decimal","description":"Valor do PIS sobre serviços."},"vCOFINS":{"type":"decimal","description":"Valor do COFINS sobre serviços."}},"description":"Grupo de Valores Totais referentes ao ISSQN."},"retTrib":{"type":"object","properties":{"vRetPIS":{"type":"decimal","description":"Valor Retido de PIS."},"vRetCOFINS":{"type":"decimal","description":"Valor Retido de COFINS."},"vRetCSLL":{"type":"decimal","description":"Valor Retido de CSLL."},"vBCIRRF":{"type":"decimal","description":"Base de Cálculo do IRRF."},"vIRRF":{"type":"decimal","description":"Valor Retido do IRRF."},"vBCRetPrev":{"type":"decimal","description":"Base de Cálculo da Retenção da Previdência Social."},"vRetPrev":{"type":"decimal","description":"Valor da Retenção da Previdência Social."}},"description":"Grupo de Retenções de Tributos."},"CBSTot":{"type":"object","properties":{"vCbs":{"type":"decimal","description":"Valor total da CBS."},"vCbsDif":{"type":"decimal","description":"Valor total do diferimento da CBS."},"vCbsCred":{"type":"decimal","description":"Valor total do crédito presumido."},"vCBCbs":{"type":"decimal","description":"Valor total da base de cálculo da CBS."}},"description":"Grupo de Valores Totais referentes ao CBS."},"IBSTot":{"type":"object","properties":{"vIbsUf":{"type":"decimal","description":"Valor total do IBS da UF."},"vIbsMunDif":{"type":"decimal","description":"Valor total do diferimento do IBS do município."},"vIbsMun":{"type":"decimal","description":"Valor total do IBS do município."},"vIbsCred":{"type":"decimal","description":"Valor total do crédito presumido."},"vBCIbs":{"type":"decimal","description":"Valor total da base de cálculo do IBS."},"vIbsUfDif":{"type":"decimal","description":"Valor total do diferimento do IBS UF."},"vIbs":{"type":"decimal","description":"Valor total do IBS."}},"description":"Grupo de Valores Totais referentes ao IBS."}}},"info":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão."},"hInc":{"type":"string","description":"Hora da Inclusão."},"uInc":{"type":"string","description":"Usuário da Inclusão."},"dAlt":{"type":"string","description":"Data da Alteração."},"hAlt":{"type":"string","description":"Hora da Alteração."},"uAlt":{"type":"string","description":"Usuário da Alteração."},"cImpAPI":{"type":"string","description":"Importado pela API."}},"description":"Informações complementares."},"compl":{"type":"object","properties":{"nIdNF":{"type":"integer","description":"Código da Nota Fiscal. Interno, utilizando apenas nas APIs."},"nIdPedido":{"type":"integer","description":"Código de identificação do pedido. Interno, utilizando apenas nas APIs."},"cCodCateg":{"type":"string","description":"Código da categoria."},"cChaveNFe":{"type":"string","description":"Chave da NF-e."},"nIdReceb":{"type":"integer","description":"Identificação do Recebimento. Interno, utilizando apenas nas APIs."},"nIdTransp":{"type":"integer","description":"Identificação da Transportadora. Interno, utilizando apenas nas APIs."},"cModFrete":{"type":"string","description":"Código da modalidade do frete."}},"description":"Dados complementares da NF."},"titulos":{"type":"array","items":{"type":"object","properties":{"nCodTitulo":{"type":"integer","description":"Código do titulo. (Gerado internamente, não é visualizado na tela)."},"cCodIntTitulo":{"type":"string","description":"Código de integração do título. (Utilizado em títulos criados via API, não é visualizado na tela)."},"cNumTitulo":{"type":"string","description":"Número do título. (Informado pelo usuário / visualizado na tela)."},"dDtEmissao":{"type":"string","description":"Data de emissão do título."},"dDtVenc":{"type":"string","description":"Data de vencimento do título."},"dDtPrevisao":{"type":"string","description":"Data de previsão de Pagamento/Recebimento."},"nValorTitulo":{"type":"decimal","description":"Valor do título."},"cCodCateg":{"type":"string","description":"Código da Categoria."},"dReg":{"type":"string","description":"Data de Registro."},"nParcela":{"type":"integer","description":"Número da parcela."},"nTotParc":{"type":"integer","description":"Número total de parcelas."},"nCodProjeto":{"type":"integer","description":"Código do Projeto."},"nCodVendedor":{"type":"integer","description":"Código do Vendedor."},"nCodComprador":{"type":"integer","description":"Número do Comprador."},"nCodTitRepet":{"type":"integer","description":"Código do título da repetição."},"cDoc":{"type":"string"},"cPagForma":{"type":"string"}}},"description":"Titulos gerados para a nota fiscal."},"pedido":{"type":"object","properties":{"cNumPedido":{"type":"string","description":"Número do Pedido do Venda."},"dIncPedido":{"type":"string","description":"Data da Inclusão do Pedido de Venda."},"hIncPedido":{"type":"string","description":"Hora da Inclusão do Pedido de Venda."},"uIncPedido":{"type":"string","description":"Usuário da Inclusão do Pedido de Venda."},"dAltPedido":{"type":"string","description":"Data da Alteração do Pedido de Venda."},"hAltPedido":{"type":"string","description":"Hora da Alteração do Pedido de Venda."},"uAltPedido":{"type":"string","description":"Usuário da Alteração do Pedido de Venda."},"cCancelado":{"type":"string","description":"Indica que o Pedido de Venda foi cancelado."},"dCanPedido":{"type":"string","description":"Data de Cancelamento do Pedido de Venda."},"hCanPedido":{"type":"string","description":"Hora de Cancelamento do Pedido de Venda."},"uCanPedido":{"type":"string","description":"Usuário de Cancelamento do Pedido de Venda."},"cDevolvido":{"type":"string","description":"Indica que o Pedido de Venda foi devolvido."},"cDevParcial":{"type":"string","description":"Indica que o Pedido de Venda se foi uma devolução parcial."},"dDevPedido":{"type":"string","description":"Data de Cancelamento do Pedido de Venda."},"hDevPedido":{"type":"string","description":"Hora de Cancelamento do Pedido de Venda."},"uDevPedido":{"type":"string","description":"Usuário de Cancelamento do Pedido de Venda."},"nIdVendedor":{"type":"integer","description":"Código do Vendedor no Pedido."},"nIdProjeto":{"type":"integer","description":"Código do Projeto no Pedido."},"opPedido":{"type":"string","description":"Operação do Pedido de venda que originou a NF. Pode ser: Vendas 01 Venda de Serviço 11 Venda de Produto 12 Venda de Produto pelo PDV 13 Devolução de Venda 14 Remessa de Produto 16 Nota Complementar de Saída Compras 21 Compra de Produto 23 Devolução ao Fornecedor 24 Retorno de Remessa 26 Nota Complementar de Entrada 22 Compra de Produto (Importação) 28 Ordem de Produção."},"nIdPedDev":{"type":"integer","description":"Id do Pedido de venda devolvido."},"Departamentos":{"type":"array","items":{"type":"object","properties":{"cCodigoDepartamento":{"type":"string","description":"Código do Departamento."},"nPercentualDistribuicao":{"type":"decimal","description":"Percentual da distribuição."},"nValorDistribuicao":{"type":"decimal","description":"Valor da distribuição."},"nValorFixo":{"type":"string","description":"Indica que o valor foi fixado na distribuição (S/N)."}}},"description":"Distribuição por Departamentos."},"Categorias":{"type":"array","items":{"type":"object","properties":{"cCodigoCategoria":{"type":"string","description":"Código do Categoria."},"nPercentualDistribuicao":{"type":"decimal","description":"Percentual da distribuição."},"nValorDistribuicao":{"type":"decimal","description":"Valor da distribuição."},"nValorFixo":{"type":"string","description":"Indica que o valor foi fixado na distribuição (S/N)."}}},"description":"Distribuição por Categorias."}},"description":"Dados do pedido."}},"title":"ConsultarNF (retorno)"},"produtos_nfconsultar_ListarNF":{"type":"object","title":"ListarNF","description":"Listar as Notas Fiscais cadastradas.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarNF"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15},"registros_por_pagina":{"type":"integer","maxLength":15},"apenas_importado_api":{"type":"string","maxLength":1},"ordenar_por":{"type":"string","maxLength":100},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Ordem decrescente."},"filtrar_por_data_de":{"type":"string","maxLength":10},"filtrar_por_data_ate":{"type":"string","maxLength":10},"filtrar_apenas_inclusao":{"type":"string","maxLength":1},"filtrar_apenas_alteracao":{"type":"string","maxLength":1},"filtrar_por_status":{"type":"string","maxLength":1,"description":"Status da NF:\n\nN-Não cancelada\nC-Cancelada."},"dEmiInicial":{"type":"string","maxLength":10,"description":"Data de Emissão inicial."},"hEmiInicial":{"type":"string","maxLength":8,"description":"Hora de Emissão inicial."},"dEmiFinal":{"type":"string","maxLength":10,"description":"Data de Emissão final."},"hEmiFinal":{"type":"string","maxLength":8,"description":"Hora de Emissão final."},"dSaiEntInicial":{"type":"string","maxLength":10,"description":"Data de Saida inicial."},"dSaiEntFinal":{"type":"string","maxLength":10,"description":"Data de Saida final."},"dRegInicial":{"type":"string","maxLength":10,"description":"Data de Registro inicial."},"dRegFinal":{"type":"string","maxLength":10,"description":"Data de Registro final."},"dCanInicial":{"type":"string","maxLength":10,"description":"Data de Cancelamento inicial."},"dCanFinal":{"type":"string","maxLength":10,"description":"Data de Cancelamento final."},"dInutInicial":{"type":"string","maxLength":10,"description":"Data de Inutilização inicial."},"dInutFinal":{"type":"string","maxLength":10,"description":"Data de Inutilização final."},"tpNF":{"type":"string","maxLength":1,"description":"Tipo de Operação.\nPode ser:\n0 - Entrada\n1 - Saída."},"tpAmb":{"type":"string","maxLength":1,"description":"Tipo de Ambiente.\nPode Ser:\n1 - Produção\n2 - Homologação."},"cSerie":{"type":"string","maxLength":5,"description":"Série da NF-e."},"nNFInicial":{"type":"integer","maxLength":15,"description":"Número da Nota Fiscal inicial."},"nNFFinal":{"type":"integer","maxLength":15,"description":"Número da Nota Fiscal final."},"cDetalhesPedido":{"type":"string","maxLength":1,"description":"Exibe os detalhes do pedido que originou a Nota Fiscal.\n\nPreecher com \"S\" ou \"N\"."},"cApenasResumo":{"type":"string","maxLength":1,"description":"Exibe apenas a resumo da Nota Fiscal.\n\nPreencher com \"S\" ou \"N\"."},"opPedido":{"type":"string","maxLength":2,"description":"Operação do Pedido de venda que originou a NF.\n\nPode ser:\n\nVendas\n01 Venda de Serviço\n11 Venda de Produto\n12 Venda de Produto pelo PDV\n13 Devolução de Venda\n14 Remessa de Produto\n16 Nota Complementar de Saída\n\nCompras\n21 Compra de Produto\n23 Devolução ao Fornecedor\n24 Retorno de Remessa\n26 Nota Complementar de Entrada\n22 Compra de Produto (Importação)\n28 Ordem de Produção."},"cNumeroPedidoCliente":{"type":"string","maxLength":30,"description":"Pesquisa pelo numero do Pedido do Cliente."},"nIdCliente":{"type":"integer","maxLength":15,"description":"ID do Cliente."},"cnpj_cpf":{"type":"string","maxLength":100,"description":"CNPJ / CPF."},"ordem_descrescente":{"deprecated":true,"type":"string","maxLength":1,"description":"DEPRECATED."}}}}},"example":{"call":"ListarNF","param":[{"pagina":1,"registros_por_pagina":20,"ordenar_por":"CODIGO"}]}},"produtos_nfconsultar_ListarNF_retorno":{"type":"object","properties":{"pagina":{"type":"integer"},"total_de_paginas":{"type":"integer"},"registros":{"type":"integer"},"total_de_registros":{"type":"integer"},"nfCadastro":{"type":"array","items":{"type":"object","properties":{"ide":{"type":"object","properties":{"indPag":{"type":"string","description":"Indicador da forma de pagamento: 0 - pagamento à vista; 1 - pagamento à prazo; 2 - outros."},"mod":{"type":"string","description":"Código do Modelo do Documento Fiscal: Utilizar o código 55 para identificação da NF-e, emitida em substituição ao modelo 1 ou 1A."},"serie":{"type":"string","description":"Série do Documento Fiscal."},"nNF":{"type":"string","description":"Número do Documento Fiscal."},"dEmi":{"type":"string","description":"Data de emissão."},"hEmi":{"type":"string","description":"Hora de Emissão."},"dSaiEnt":{"type":"string","description":"Data de saida."},"hSaiEnt":{"type":"string","description":"Hora de Saída ou da Entrada da Mercadoria/Produto."},"tpNF":{"type":"string","description":"Tipo de Operação: 0-entrada / 1-saída."},"tpAmb":{"type":"string","description":"Tipo de Ambiente = 1-Produção / 2-Homologação."},"finNFe":{"type":"string","description":"Finalidade de emissão da NFe: 1 - NF-e normal 2 - NF-e complementar 3 - NF-e de ajuste 4 - NF-e de devolução."},"dReg":{"type":"string","description":"Data de Registro."},"dCan":{"type":"string","description":"Data de cancelamento."},"dInut":{"type":"string","description":"Data de Inutilização."},"cDeneg":{"type":"string"}}},"nfEmitInt":{"type":"object","properties":{"nCodEmp":{"type":"integer","description":"Código da Empresa."},"cCodEmpInt":{"type":"string","description":"Código de integração da empresa."}}},"nfDestInt":{"type":"object","properties":{"nCodCli":{"type":"integer","description":"Código do cliente."},"cCodCliInt":{"type":"string","description":"Código de integração do cliente Fornecedor."},"cRazao":{"type":"string"},"cnpj_cpf":{"type":"string"}}},"det":{"type":"array","items":{"type":"object","properties":{"prod":{"type":"object","properties":{"cProd":{"type":"string","description":"Código do produto ou serviço."},"cEAN":{"type":"string","description":"GTIN (Global Trade Item Number) do produto, antigo código EAN ou código de barras."},"xProd":{"type":"string","description":"Descrição do produto ou serviço."},"NCM":{"type":"string"},"EXTIPI":{"type":"string","description":"DEPRECATED."},"CFOP":{"type":"string","description":"Código Fiscal de Operações e Prestações."},"uCom":{"type":"string","description":"Unidade Comercial."},"qCom":{"type":"decimal","description":"Quantidade Comercial."},"vUnCom":{"type":"decimal","description":"Valor Unitário de Comercialização."},"vProd":{"type":"decimal","description":"Valor Total Bruto dos Produtos."},"cEANTrib":{"type":"string","description":"GTIN (Global Trade Item Number) da unidade tributável, antigo código EAN ou código de barras."},"uTrib":{"type":"string","description":"Unidade Tributável."},"qTrib":{"type":"decimal","description":"Quantidade Tributável."},"vUnTrib":{"type":"decimal","description":"Valor Unitário de tributação."},"vFrete":{"type":"decimal","description":"Valor Total do Frete."},"vSeg":{"type":"decimal","description":"Valor Total do Seguro."},"vDesc":{"type":"decimal","description":"Valor do Desconto."},"vOutro":{"type":"decimal","description":"Outras despesas acessórias."},"vII":{"type":"decimal","description":"Valor de Impostos de Importação."},"indTot":{"type":"decimal","description":"Indica se valor do Item (vProd) entra no valor total da NF-e (vProd)."},"cProdOrig":{"type":"string","description":"Código do produto conforme informado na Nota Fiscal."},"xProdOrig":{"type":"string","description":"Descrição original do produto conforme informado na Nota Fiscal."},"nCMCUnitario":{"type":"decimal","description":"CMC Unitário."},"nCMCTotal":{"type":"decimal","description":"CMC Total."},"vTotItem":{"type":"decimal","description":"Valor total do item."},"vFCP":{"type":"decimal","description":"Valor do ICMS relativo ao Fundo de Combate à Pobreza (FCP) da UF de Destino."},"pCOFINS":{"type":"decimal","description":"Alíquota de COFINS."},"vCOFINS":{"type":"decimal","description":"Valor de COFINS."},"pPIS":{"type":"decimal","description":"Alíquota de PIS."},"vPIS":{"type":"decimal","description":"Valor do PIS."},"pISS":{"type":"decimal","description":"Alíquota de ISS."},"vISS":{"type":"decimal","description":"Valor de ISS."},"pIPI":{"type":"decimal","description":"Alíquota de IPI."},"vIPI":{"type":"decimal","description":"Valor de IPI."},"pIR":{"type":"decimal","description":"Alíquota de IR."},"vIR":{"type":"decimal","description":"Valor de IR."},"pINSS":{"type":"decimal","description":"Alíquota de INSS."},"vINSS":{"type":"decimal","description":"Valor de INSS."},"pCSLL":{"type":"decimal","description":"Alíquota de Contribuição Social sobre Lucro Líquido."},"vCSLL":{"type":"decimal","description":"Valor da Contribuição Social sobre Lucro Líquido."},"pICMS":{"type":"decimal","description":"Alíquota de ICMS."},"vICMS":{"type":"decimal","description":"Valor de ICMS."},"pICMSST":{"type":"decimal","description":"Alíquota de ICMSST."},"vICMSST":{"type":"decimal","description":"Valor de ICMSST."},"codigo_local_estoque":{"type":"integer","description":"Código do local do estoque."},"cCOFINSRetido":{"type":"string","description":"Indica se houve retenção de COFINS Possíveis valores: S = Sim N = Não."},"cPISRetido":{"type":"string","description":"Indica se houve retenção de PIS Possíveis valores: S = Sim N = Não."},"cINSSRetido":{"type":"string","description":"Indica se houve retenção de INSS Possíveis valores: S = Sim N = Não."},"cIRRetido":{"type":"string","description":"Indica se houve retenção de IR Possíveis valores: S = Sim N = Não."},"cISSRetido":{"type":"string","description":"Indica se houve retenção de ISS Possíveis valores: S = Sim N = Não."},"cICMSRetido":{"type":"string","description":"Indica se houve retenção de ICMS Possíveis valores: S = Sim N = Não."},"cCSLLRetido":{"type":"string","description":"Indica se houve retenção de CSLL Possíveis valores: S = Sim N = Não."},"pFCPST":{"type":"decimal","description":"Alíquota de FCPST."},"vFCPST":{"type":"decimal","description":"Valor do FCPST."},"pFCP":{"type":"decimal","description":"Alíquota de FCP."},"pMVAST":{"type":"decimal","description":"Percentual da margem do valor adicionado da base de cálculo do ICMS ST."},"pRedBC":{"type":"decimal","description":"Percentual de Redução da Base de Cálculo do ICMS."},"vBCCOFINS":{"type":"decimal","description":"Base de Cálculo do COFINS."},"vBCST":{"type":"decimal","description":"Base de Cálculo do ICMS ST."},"vBCIPI":{"type":"decimal","description":"Base de Cálculo do IPI."},"vBCISS":{"type":"decimal","description":"Base de Cálculo do ISS."},"vBCPIS":{"type":"decimal","description":"Base de Cálculo do PIS."},"vBCUFDest":{"type":"decimal","description":"Base de Cálculo do ICMS na UF de Destino."},"vBC":{"type":"decimal","description":"Base de Cálculo do ICMS."},"cOrigem":{"type":"string"},"pIcmsUfDest":{"type":"decimal","description":"Alíquota interna da UF de Destino."},"pIcmsInterest":{"type":"decimal","description":"Alíquota Interestadual das UF envolvidas."},"pRedBcICMDest":{"type":"decimal","description":"Percentual de Redução da Base de Cálculo do ICMS Destino."},"vICMDest":{"type":"decimal","description":"Valor do ICMS Interestadual para a UF de Destino."},"vICMRemet":{"type":"decimal","description":"Valor do ICMS Interestadual para a UF do Remetente."},"vIbs":{"type":"decimal","description":"Valor do IBS."},"pAliqIBSMun":{"type":"decimal","description":"Alíquota do IBS de competência do Município."},"pAliqIBSUF":{"type":"decimal","description":"Alíquota do IBS de competência das UF."},"vAliqIbsUf":{"type":"decimal","description":"Valor da alíquota do IBS da UF."},"vAliqIbsMun":{"type":"decimal","description":"Valor da alíquota do IBS do Município."},"vIbsUf":{"type":"decimal","description":"Valor do IBS de competência da UF."},"vIbsMun":{"type":"decimal","description":"Valor do IBS de competência do Município."},"vCbs":{"type":"decimal","description":"Valor da CBS."},"pAliqCbs":{"type":"decimal","description":"Alíquota da CBS."},"pReducaoCbs":{"type":"decimal","description":"Percentual da redução de alíquota do cClassTrib."},"pReducaoIbsMun":{"type":"decimal","description":"Percentual da redução de alíquota do cClassTrib - IBS UF."},"pReducaoIbsUf":{"type":"decimal","description":"Percentual da redução de alíquota do cClassTrib - IBS UF."},"vBCIbsCbs":{"type":"decimal","description":"Base de cálculo do IBS e CBS."},"vAliqCbs":{"type":"decimal","description":"Valor da alíquota da CBS."}}},"nfProdInt":{"type":"object","properties":{"nCodProd":{"type":"integer","description":"Código do Produto."},"cCodProdInt":{"type":"string","description":"Código de Integração do produto."},"nCodItem":{"type":"integer","description":"Código do item."},"cCodItemInt":{"type":"string","description":"Código de Integração do Item."}}},"itemPedido":{"type":"object","properties":{"nIdItemPedido":{"type":"integer","description":"Id do item do Pedido de Venda."},"cItemDevolvido":{"type":"string","description":"Indica se o Item do Pedido de Vendas foi devolvido (S/N)."},"nItemQtdDevolvida":{"type":"decimal","description":"Quantidade devolvida do Item do Pedido de Vendas."}},"description":"Dados do Item do Pedido de Venda."},"rastreabilidade":{"type":"object","properties":{"numeroLote":{"type":"string","description":"Número do Lote."},"qtdeProdutoLote":{"type":"decimal","description":"Quantidade de Produto."},"dataFabricacaoLote":{"type":"string","description":"Data de Fabricação/Produção."},"dataValidadeLote":{"type":"string","description":"Data de Validade."},"codigoAgregacaoLote":{"type":"string","description":"Código de Agregação."}},"description":"Dados específicos para rastreabilidade do produto."}}}},"total":{"type":"object","properties":{"ICMSTot":{"type":"object","properties":{"vBC":{"type":"decimal","description":"Base de Cálculo do ICMS."},"vICMS":{"type":"decimal","description":"Valor Total do ICMS."},"vBCST":{"type":"decimal","description":"Base de Cálculo do ICMS ST."},"vST":{"type":"decimal","description":"Valor Total do ICMS ST."},"vProd":{"type":"decimal","description":"Valor Total dos produtos e serviços."},"vFrete":{"type":"decimal","description":"Valor Total do Frete."},"vSeg":{"type":"decimal","description":"Valor Total do Seguro."},"vDesc":{"type":"decimal","description":"Valor Total do Desconto."},"vII":{"type":"decimal","description":"Valor Total do II."},"vIPI":{"type":"decimal","description":"Valor Total do IPI."},"vPIS":{"type":"decimal","description":"Valor do PIS."},"vCOFINS":{"type":"decimal","description":"Valor do COFINS."},"vOutro":{"type":"decimal","description":"Outras Despesas acessórias."},"vNF":{"type":"decimal","description":"Valor Total da NF-e."},"vTotTrib":{"type":"decimal","description":"Valor aproximado total de tributos federais, estaduais e municipais."},"vICMSDesonerado":{"type":"decimal","description":"Valor do ICMS Desonerado."},"vBCFCP":{"type":"decimal","description":"Base de Cálculo do Fundo de Combate a Pobreza."},"vFCP":{"type":"decimal","description":"Valor do Fundo de Combate a Pobreza."},"vBCFCPST":{"type":"decimal","description":"Base de Cálculo do Fundo de Combate a Pobreza ST."},"vFCPST":{"type":"decimal","description":"Valor do Fundo de Combate a Pobreza ST."}},"description":"Grupo de Valores Totais referentes ao ICMS."},"ISSQNtot":{"type":"object","properties":{"vServ":{"type":"decimal","description":"Valor Total dos Serviços sob não-incidência ou não tributados pelo ICMS."},"vBC":{"type":"decimal","description":"Base de Cálculo do ISS."},"vISS":{"type":"decimal","description":"Valor Total do ISS."},"vPIS":{"type":"decimal","description":"Valor do PIS sobre serviços."},"vCOFINS":{"type":"decimal","description":"Valor do COFINS sobre serviços."}},"description":"Grupo de Valores Totais referentes ao ISSQN."},"retTrib":{"type":"object","properties":{"vRetPIS":{"type":"decimal","description":"Valor Retido de PIS."},"vRetCOFINS":{"type":"decimal","description":"Valor Retido de COFINS."},"vRetCSLL":{"type":"decimal","description":"Valor Retido de CSLL."},"vBCIRRF":{"type":"decimal","description":"Base de Cálculo do IRRF."},"vIRRF":{"type":"decimal","description":"Valor Retido do IRRF."},"vBCRetPrev":{"type":"decimal","description":"Base de Cálculo da Retenção da Previdência Social."},"vRetPrev":{"type":"decimal","description":"Valor da Retenção da Previdência Social."}},"description":"Grupo de Retenções de Tributos."},"CBSTot":{"type":"object","properties":{"vCbs":{"type":"decimal","description":"Valor total da CBS."},"vCbsDif":{"type":"decimal","description":"Valor total do diferimento da CBS."},"vCbsCred":{"type":"decimal","description":"Valor total do crédito presumido."},"vCBCbs":{"type":"decimal","description":"Valor total da base de cálculo da CBS."}},"description":"Grupo de Valores Totais referentes ao CBS."},"IBSTot":{"type":"object","properties":{"vIbsUf":{"type":"decimal","description":"Valor total do IBS da UF."},"vIbsMunDif":{"type":"decimal","description":"Valor total do diferimento do IBS do município."},"vIbsMun":{"type":"decimal","description":"Valor total do IBS do município."},"vIbsCred":{"type":"decimal","description":"Valor total do crédito presumido."},"vBCIbs":{"type":"decimal","description":"Valor total da base de cálculo do IBS."},"vIbsUfDif":{"type":"decimal","description":"Valor total do diferimento do IBS UF."},"vIbs":{"type":"decimal","description":"Valor total do IBS."}},"description":"Grupo de Valores Totais referentes ao IBS."}}},"info":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão."},"hInc":{"type":"string","description":"Hora da Inclusão."},"uInc":{"type":"string","description":"Usuário da Inclusão."},"dAlt":{"type":"string","description":"Data da Alteração."},"hAlt":{"type":"string","description":"Hora da Alteração."},"uAlt":{"type":"string","description":"Usuário da Alteração."},"cImpAPI":{"type":"string","description":"Importado pela API."}},"description":"Informações complementares."},"compl":{"type":"object","properties":{"nIdNF":{"type":"integer","description":"Código da Nota Fiscal. Interno, utilizando apenas nas APIs."},"nIdPedido":{"type":"integer","description":"Código de identificação do pedido. Interno, utilizando apenas nas APIs."},"cCodCateg":{"type":"string","description":"Código da categoria."},"cChaveNFe":{"type":"string","description":"Chave da NF-e."},"nIdReceb":{"type":"integer","description":"Identificação do Recebimento. Interno, utilizando apenas nas APIs."},"nIdTransp":{"type":"integer","description":"Identificação da Transportadora. Interno, utilizando apenas nas APIs."},"cModFrete":{"type":"string","description":"Código da modalidade do frete."}},"description":"Dados complementares da NF."},"titulos":{"type":"array","items":{"type":"object","properties":{"nCodTitulo":{"type":"integer","description":"Código do titulo. (Gerado internamente, não é visualizado na tela)."},"cCodIntTitulo":{"type":"string","description":"Código de integração do título. (Utilizado em títulos criados via API, não é visualizado na tela)."},"cNumTitulo":{"type":"string","description":"Número do título. (Informado pelo usuário / visualizado na tela)."},"dDtEmissao":{"type":"string","description":"Data de emissão do título."},"dDtVenc":{"type":"string","description":"Data de vencimento do título."},"dDtPrevisao":{"type":"string","description":"Data de previsão de Pagamento/Recebimento."},"nValorTitulo":{"type":"decimal","description":"Valor do título."},"cCodCateg":{"type":"string","description":"Código da Categoria."},"dReg":{"type":"string","description":"Data de Registro."},"nParcela":{"type":"integer","description":"Número da parcela."},"nTotParc":{"type":"integer","description":"Número total de parcelas."},"nCodProjeto":{"type":"integer","description":"Código do Projeto."},"nCodVendedor":{"type":"integer","description":"Código do Vendedor."},"nCodComprador":{"type":"integer","description":"Número do Comprador."},"nCodTitRepet":{"type":"integer","description":"Código do título da repetição."},"cDoc":{"type":"string"},"cPagForma":{"type":"string"}}},"description":"Titulos gerados para a nota fiscal."},"pedido":{"type":"object","properties":{"cNumPedido":{"type":"string","description":"Número do Pedido do Venda."},"dIncPedido":{"type":"string","description":"Data da Inclusão do Pedido de Venda."},"hIncPedido":{"type":"string","description":"Hora da Inclusão do Pedido de Venda."},"uIncPedido":{"type":"string","description":"Usuário da Inclusão do Pedido de Venda."},"dAltPedido":{"type":"string","description":"Data da Alteração do Pedido de Venda."},"hAltPedido":{"type":"string","description":"Hora da Alteração do Pedido de Venda."},"uAltPedido":{"type":"string","description":"Usuário da Alteração do Pedido de Venda."},"cCancelado":{"type":"string","description":"Indica que o Pedido de Venda foi cancelado."},"dCanPedido":{"type":"string","description":"Data de Cancelamento do Pedido de Venda."},"hCanPedido":{"type":"string","description":"Hora de Cancelamento do Pedido de Venda."},"uCanPedido":{"type":"string","description":"Usuário de Cancelamento do Pedido de Venda."},"cDevolvido":{"type":"string","description":"Indica que o Pedido de Venda foi devolvido."},"cDevParcial":{"type":"string","description":"Indica que o Pedido de Venda se foi uma devolução parcial."},"dDevPedido":{"type":"string","description":"Data de Cancelamento do Pedido de Venda."},"hDevPedido":{"type":"string","description":"Hora de Cancelamento do Pedido de Venda."},"uDevPedido":{"type":"string","description":"Usuário de Cancelamento do Pedido de Venda."},"nIdVendedor":{"type":"integer","description":"Código do Vendedor no Pedido."},"nIdProjeto":{"type":"integer","description":"Código do Projeto no Pedido."},"opPedido":{"type":"string","description":"Operação do Pedido de venda que originou a NF. Pode ser: Vendas 01 Venda de Serviço 11 Venda de Produto 12 Venda de Produto pelo PDV 13 Devolução de Venda 14 Remessa de Produto 16 Nota Complementar de Saída Compras 21 Compra de Produto 23 Devolução ao Fornecedor 24 Retorno de Remessa 26 Nota Complementar de Entrada 22 Compra de Produto (Importação) 28 Ordem de Produção."},"nIdPedDev":{"type":"integer","description":"Id do Pedido de venda devolvido."},"Departamentos":{"type":"array","items":{"type":"object","properties":{"cCodigoDepartamento":{"type":"string","description":"Código do Departamento."},"nPercentualDistribuicao":{"type":"decimal","description":"Percentual da distribuição."},"nValorDistribuicao":{"type":"decimal","description":"Valor da distribuição."},"nValorFixo":{"type":"string","description":"Indica que o valor foi fixado na distribuição (S/N)."}}},"description":"Distribuição por Departamentos."},"Categorias":{"type":"array","items":{"type":"object","properties":{"cCodigoCategoria":{"type":"string","description":"Código do Categoria."},"nPercentualDistribuicao":{"type":"decimal","description":"Percentual da distribuição."},"nValorDistribuicao":{"type":"decimal","description":"Valor da distribuição."},"nValorFixo":{"type":"string","description":"Indica que o valor foi fixado na distribuição (S/N)."}}},"description":"Distribuição por Categorias."}},"description":"Dados do pedido."}}}}},"title":"ListarNF (retorno)"},"produtos_nfe_ExcluirNFe":{"type":"object","title":"ExcluirNFe","description":"Exclui uma NF-e importada via integração.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirNFe"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdImportacao":{"type":"integer","maxLength":15,"description":"ID da Importação da NF-e."},"nIdNFe":{"type":"integer","maxLength":15,"description":"ID do NF-e."},"cChaveNFe":{"type":"string","maxLength":44,"description":"Chave da NF-e."}}}}},"example":{"call":"ExcluirNFe","param":[{"cChaveNFe":"","nIdImportacao":0,"nIdNFe":0}]}},"produtos_nfe_ExcluirNFe_retorno":{"type":"object","properties":{"nIdImportacao":{"type":"integer","description":"ID da Importação da NF-e."},"nIdNFe":{"type":"integer","description":"ID do NF-e."},"cChaveNFe":{"type":"string","description":"Chave da NF-e."},"cCodStatus":{"type":"string","description":"Código do Status do processamento."},"cDesStatus":{"type":"string","description":"Descrição do status de processamento."}},"title":"ExcluirNFe (retorno)"},"produtos_nfe_ImportarCancNFe":{"type":"object","title":"ImportarCancNFe","description":"Importa o XML de cancelamento de uma Nota Fiscal Eletrônica.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ImportarCancNFe"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cAppNome":{"type":"string","maxLength":20,"description":"Nome do Aplicativo que emitiu a NF-e.\n\n\nExemplo:\nGeradorNF-e."},"cAppVersao":{"type":"string","maxLength":20,"description":"Versão do Aplicativo que emitiu a NF-e.\n\n\nExemplo:\n1.02.01."},"cAppId":{"type":"string","maxLength":100,"description":"Identificação do aplicativo que emitiu a NF-e.\n\n\nExemplo:\nID001\n\nPS: Informe o código que identifica a instalação do aplicativo.\nCaso o cliente tenha 2 Emissores de NF-e, indique: \"01\" e \"02\" ou \"10\" e \"20\" e assim por diante."},"cChaveNfe":{"type":"string","maxLength":44,"description":"Chave da NF-e a ser importada.\n\n\nApenas números com 44 digitos."},"nIdImportacao":{"type":"integer","maxLength":15,"description":"ID da Importação da NF-e."},"nIdNFe":{"type":"integer","maxLength":15,"description":"ID do NF-e."},"cXmlNFeCanc":{"type":"string","description":"Xml de Cancelamento do CT-e.\n\nPreechimento obrigatório.\n\nAntes de enviar, converta os seus seguintes caracteres:\n\n&amp; para &amp;amp;\n> para &amp;gt;\n< para &amp;lt;\n\" para &amp;quot;\n\" para &amp;apos;\n| para &amp;#124;\n\nApós essa conversão aplique o MD5 para enviar no campo \"cMd5CteCanc\".\n\nObservação: Para requisições SOAP usar CDATA como demonstra o exemplo abaixo:\n&lt;![CDATA[Conteúdo do campo convertido]]&gt;."},"cMd5NFeCanc":{"type":"string","maxLength":32,"description":"MD5 do arquivo XML importado.\n\n\nAplique o MD5 sobre o XML antes de realizar o consumo."}},"required":["cAppId","cAppNome","cAppVersao","cChaveNfe","cMd5NFeCanc","cXmlNFeCanc"]}}},"example":{"call":"ImportarCancNFe","param":[{"cAppNome":"GeradorNFe","cAppVersao":"1.01.02","cAppId":"NFe01","cChaveNFe":"","cXmlNFeCanc":"","cMd5NFeCanc":""}]}},"produtos_nfe_ImportarCancNFe_retorno":{"type":"object","properties":{"nIdImportacao":{"type":"integer","description":"ID da Importação da NF-e."},"nIdNFe":{"type":"integer","description":"ID do NF-e."},"cChaveNFe":{"type":"string","description":"Chave da NF-e."},"cCodStatus":{"type":"string","description":"Código do Status do processamento."},"cDesStatus":{"type":"string","description":"Descrição do status de processamento."}},"title":"ImportarCancNFe (retorno)"},"produtos_nfe_ImportarNFe":{"type":"object","title":"ImportarNFe","description":"Importa o XML de uma Nota Fiscal Eletrônica.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ImportarNFe"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cAppNome":{"type":"string","maxLength":20,"description":"Nome do Aplicativo que emitiu a NF-e.\n\n\nExemplo:\nGeradorNF-e."},"cAppVersao":{"type":"string","maxLength":20,"description":"Versão do Aplicativo que emitiu a NF-e.\n\n\nExemplo:\n1.02.01."},"cAppId":{"type":"string","maxLength":100,"description":"Identificação do aplicativo que emitiu a NF-e.\n\n\nExemplo:\nID001\n\nPS: Informe o código que identifica a instalação do aplicativo.\nCaso o cliente tenha 2 Emissores de NF-e, indique: \"01\" e \"02\" ou \"10\" e \"20\" e assim por diante."},"cChaveNFe":{"type":"string","maxLength":44,"description":"Chave da NF-e a ser importada.\n\n\nApenas números com 44 digitos."},"cXmlNFe":{"type":"string","description":"Xml da NF-e a ser importada.\n\n\nAntes de enviar, converta os seus seguintes caracteres:\n\n&amp; para &amp;amp;\n> para &amp;gt;\n< para &amp;lt;\n\" para &amp;quot;\n\" para &amp;apos;\n| para &amp;#124;\n\nApós essa conversão aplique o MD5 para enviar no campo \"cMd5NFe\"."},"cMd5NFe":{"type":"string","maxLength":32,"description":"MD5 do arquivo XML importado.\n\n\nAplique o MD5 sobre o XML antes de realizar o consumo."},"cOperacao":{"type":"string","maxLength":2,"description":"Tipo de Operação da Nota Fiscal.\n\n\nCódigos Disponíveis:\n\n11 - Venda de produtos\n21 - Compra de produtos."},"cOrigem":{"type":"string","maxLength":3,"description":"Origem da Nota Fiscal.\n\n\nCódigos Disponíveis:\n\nAPI - Importado via API."},"dDataPrevisao":{"type":"string","maxLength":10,"description":"Data de Previsão do título de contas a pagar/receber.\n\n\nFormato: dd/mm/aaaa."},"nCliente":{"type":"integer","maxLength":15,"description":"Id do cliente."},"nVendedor":{"type":"integer","maxLength":15,"description":"Id do Vendedor."},"nProjeto":{"type":"integer","maxLength":15,"description":"Id do projeto."},"cCategoria":{"type":"string","maxLength":20,"description":"Código da Categoria."},"nContaCorrente":{"type":"integer","maxLength":15,"description":"Id da Conta Corrente."},"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do local do estoque.\n\n\nAssumirá o local padrão de estoque caso não informado."},"lNaoMovEstoque":{"type":"boolean","description":"Não movimentar o estoque.\n\n\nPode ser:\ntrue - inibe a movimentação do estoque.\nfalse - Gera o movimentação do estoque.\n\nO padrão é true."},"lNaoGerarTitulo":{"type":"boolean","description":"Não gerar título de contas a pagar ou receber para a NF-e.\n\n\nPode ser:\ntrue - inibe a geração do título de Contas a Pagar ou Receber no financeiro.\nfalse - Gera o ítulo de Contas a Pagar ou Receber no financeiro.\n\nO padrão é true."},"lNaoIncluirCliente":{"type":"boolean","description":"Não adicionar o cliente caso não encontre no Omie.\n\n\nPode ser:\ntrue - inibe a inclusão do cliente.\nfalse - Inclui o cliente caso não encontre.\n\nO padrão é true."},"lNaoIncluirProduto":{"type":"boolean","description":"Não adicionar o produto caso não encontre no Omie.\n\n\nPode ser:\ntrue - inibe a inclusão do produto.\nfalse - Inclui o produto caso não encontre.\n\nO padrão é true."},"cNumeroPedidoCliente":{"type":"string","maxLength":30},"itens":{"type":"array","items":{"type":"object","properties":{"nSequencia":{"type":"integer","maxLength":5,"description":"Número da Sequencia.\n\n\nPara os itens da NF identifica qual o item do XML se refere.\n\nPara as parcelas da NF identifica o número da parcela.\n\nPara os lançamentos no Conta Corrente indentifica o lançamento que será gerado.\n\nPermite sequencial de 1 a 999."},"nIdProduto":{"type":"integer","maxLength":15,"description":"ID do produto.\n\n\nCaso não informado, fará a pesquisa do produto de acordo com os dados do XML da NF-e."},"cCategoria":{"type":"string","maxLength":20,"description":"Código da Categoria."},"lNaoGerarTitulo":{"type":"boolean","description":"Não gerar título de contas a pagar ou receber para a NF-e.\n\n\nPode ser:\ntrue - inibe a geração do título de Contas a Pagar ou Receber no financeiro.\nfalse - Gera o ítulo de Contas a Pagar ou Receber no financeiro.\n\nO padrão é true."},"lote_validade":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","maxLength":15,"description":"Id do lote do produto. (Opcional)\n\nSe não informado iremos cadastrar um novo lote."},"nQtdLote":{"type":"number","maxLength":18,"description":"Informe aqui a quantidade do lote para o produto."},"cNumLote":{"type":"string","maxLength":60,"description":"Número do lote do produto.\n\nDeve ser informado apenas quando a tag [nIdLote] não for informada, com isso, será criado um novo lote a partir do número informado."},"cCodAgreg":{"type":"string","maxLength":20,"description":"Código de agregação do lote do produto. (Opcional)."},"dDataFab":{"type":"string","description":"Data de fabricação do lote.\n\nDeve ser informado apenas quando a tag [nIdLote] não for informada.\n\nComo default é utilizado a data atual."},"dDataVal":{"type":"string","description":"Data de validade do lote.\n\nDeve ser informado apenas quando a tag [nIdLote] não for informada."}},"required":["nQtdLote"]},"description":"Informações referentes ao lote e validade do produto.\n\nA tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes \"manualmente\" por API."},"lNaoMovEstoque":{"type":"boolean","description":"Não movimenta o estoque para o  item.\n\n\nPode ser:\ntrue - inibe a movimentação do estoque.\nfalse - Gera o movimentação do estoque.\n\nO padrão é false."},"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do local do estoque.\n\n\nAssumirá o local padrão de estoque caso não informado."}},"required":["nSequencia"]},"description":"Itens da Nota Fiscal."},"parcelas":{"type":"array","items":{"type":"object","properties":{"nSequencia":{"type":"integer","maxLength":3,"description":"Número da Sequencia.\n\n\nPara os itens da NF identifica qual o item do XML se refere.\n\nPara as parcelas da NF identifica o número da parcela.\n\nPara os lançamentos no Conta Corrente indentifica o lançamento que será gerado.\n\nPermite sequencial de 1 a 999."},"nValorParcela":{"type":"number","maxLength":18,"description":"Valor da Parcela."},"dDataVencimento":{"type":"string","maxLength":10,"description":"Data de Vencimento da Parcela.\n\n\nFormato: dd/mm/aaaa."},"cTipoDocumento":{"type":"string","maxLength":5,"description":"Tipo de Documento."},"cCategoria":{"type":"string","maxLength":20,"description":"Código da Categoria."},"nContaCorrente":{"type":"integer","maxLength":15,"description":"Id da Conta Corrente."},"nsu":{"type":"string","maxLength":100,"description":"Número Sequencial Único - NSU\n\nPara identificar vendas por cartões ou TransactionID TID - Para identificar vendas de comercio eletrônico."},"cObs":{"type":"string","description":"Observações."},"nProjeto":{"type":"integer","maxLength":15,"description":"Id do projeto."},"nVendedor":{"type":"integer","maxLength":15,"description":"Id do Vendedor."},"dDataEntrada":{"type":"string","maxLength":10,"description":"Data de Entrada da Nota Fiscal.\n\n\nFormato: dd/mm/aaaa."},"dDataPrevisao":{"type":"string","maxLength":10,"description":"Data de Previsão do título de contas a pagar/receber.\n\n\nFormato: dd/mm/aaaa."}},"required":["dDataVencimento","nSequencia","nValorParcela"]},"description":"Informações complementares das Parcelas da NF-e.\n\nNessa tag é recebido informações para complemento das parcelas já existentes no XML da NF-e enviada."},"lancamentos":{"type":"array","items":{"type":"object","properties":{"nSequencia":{"type":"integer","maxLength":5,"description":"Número da Sequencia.\n\n\nPara os itens da NF identifica qual o item do XML se refere.\n\nPara as parcelas da NF identifica o número da parcela.\n\nPara os lançamentos no Conta Corrente indentifica o lançamento que será gerado.\n\nPermite sequencial de 1 a 999."},"cNaturezaDocumento":{"type":"string","maxLength":1,"description":"Natureza do Documento.\n\n\nPode ser:\nP - Pagar\nR - Receber."},"nValorDocumento":{"type":"number","maxLength":18,"description":"Valor do Documento."},"dDataDocumento":{"type":"string","maxLength":10,"description":"Data do documento."},"cTipoDocumento":{"type":"string","maxLength":5,"description":"Tipo de Documento.\n\n\nLista de tipos de documentos em:\n/api/v1/geral/tiposdoc."},"cCategoria":{"type":"string","maxLength":20,"description":"Código da Categoria."},"nContaCorrente":{"type":"integer","maxLength":15,"description":"Id da Conta Corrente."},"cOrigem":{"type":"string","maxLength":3,"description":"Origem da Nota Fiscal.\n\n\nCódigos Disponíveis:\n\nAPI - Importado via API."},"cObs":{"type":"string","description":"Observações."},"nProjeto":{"type":"integer","maxLength":15,"description":"Id do projeto."},"nVendedor":{"type":"integer","maxLength":15,"description":"Id do Vendedor."}},"required":["cNaturezaDocumento","dDataDocumento","nValorDocumento"]},"description":"Lançamentos no Conta Corrente relacionados a Nota Fiscal.\n(Tarifas,taxas,entre outros)."},"itensXml":{"type":"array","items":{"type":"object","properties":{"cProdXml":{"type":"string","maxLength":60,"description":"Código do produto no XML da NF-e.\nEssa informação está localizada na tag \"cProd\" do XML da NF-e, ela é utilizada para identificar o produto no XML."},"nIdProdutoXml":{"type":"integer","maxLength":15,"description":"ID do produto no Omie que será vinculado ao produto informado na tag \"cProdXml\"."},"lote_validade":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","maxLength":15,"description":"Id do lote do produto. (Opcional)\n\nSe não informado iremos cadastrar um novo lote."},"nQtdLote":{"type":"number","maxLength":18,"description":"Informe aqui a quantidade do lote para o produto."},"cNumLote":{"type":"string","maxLength":60,"description":"Número do lote do produto.\n\nDeve ser informado apenas quando a tag [nIdLote] não for informada, com isso, será criado um novo lote a partir do número informado."},"cCodAgreg":{"type":"string","maxLength":20,"description":"Código de agregação do lote do produto. (Opcional)."},"dDataFab":{"type":"string","description":"Data de fabricação do lote.\n\nDeve ser informado apenas quando a tag [nIdLote] não for informada.\n\nComo default é utilizado a data atual."},"dDataVal":{"type":"string","description":"Data de validade do lote.\n\nDeve ser informado apenas quando a tag [nIdLote] não for informada."}},"required":["nQtdLote"]},"description":"Informações referentes ao lote e validade do produto.\n\nA tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes \"manualmente\" por API."},"nSequencia":{"type":"integer","maxLength":5,"description":"Número da Sequencia.\n\n\nPara os itens da NF identifica qual o item do XML se refere.\n\nPara as parcelas da NF identifica o número da parcela.\n\nPara os lançamentos no Conta Corrente indentifica o lançamento que será gerado.\n\nPermite sequencial de 1 a 999."}},"required":["cProdXml","nIdProdutoXml"]},"description":"Dados dos Itens da NF-e.\n\nInforme aqui a relação dos produtos contidos no XML com o respectivo produto no Omie ERP.\n\nCaso a tag \"itens\" seja preenchida esta tag não deve ser utilizada."}},"required":["cAppId","cAppNome","cAppVersao","cChaveNFe","cMd5NFe","cOperacao","cXmlNFe","dDataPrevisao"]}}},"example":{"call":"ImportarNFe","param":[{"cAppNome":"GeradorNFe","cAppVersao":"1.01.02","cAppId":"NFe01","cChaveNFe":"","cXmlNFe":"","cMd5NFe":"","cOperacao":"11","cOrigem":"API","nCliente":0,"cCategoria":"1.01.02","nContaCorrente":0,"codigo_local_estoque":0,"lNaoMovEstoque":true,"lNaoGerarTitulo":false,"lNaoIncluirCliente":false,"lNaoIncluirProduto":true}]}},"produtos_nfe_ImportarNFe_retorno":{"type":"object","properties":{"nIdImportacao":{"type":"integer","description":"ID da Importação da NF-e."},"nIdNFe":{"type":"integer","description":"ID do NF-e."},"cChaveNFe":{"type":"string","description":"Chave da NF-e."},"cCodStatus":{"type":"string","description":"Código do Status do processamento."},"cDesStatus":{"type":"string","description":"Descrição do status de processamento."}},"title":"ImportarNFe (retorno)"},"produtos_nfe_ListarNFe":{"type":"object","title":"ListarNFe","description":"Lista as NFes importadas.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarNFe"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página que se deseja resgatar.\nO padrão é \"1\"."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Número de registros retornados por página.\nO padrão é 20.\nO limite máximo é 500  por página."},"dDataEmissaoInicial":{"type":"string","maxLength":10,"description":"Data de emissão inicial.\nNo formato dd/mm/aaaa."},"dDataEmissaoFinal":{"type":"string","maxLength":10,"description":"Data de emissão final.\nNo formato dd/mm/aaaa."},"dDataInclusaoInicial":{"type":"string","maxLength":10,"description":"Data de Inclusão Inicial.\nNo formato dd/mm/aaaa."},"dDataInclusaoFinal":{"type":"string","maxLength":10,"description":"Data de Inclusão Final.\nNo formato dd/mm/aaaa."},"nIdImportacao":{"type":"integer","maxLength":15,"description":"ID da Importação da NF-e."},"nIdNFe":{"type":"integer","maxLength":15,"description":"ID do NF-e."},"cChaveNFe":{"type":"string","maxLength":44,"description":"Chave da NF-e."}}}}},"example":{"call":"ListarNFe","param":[{"nPagina":1,"nRegPorPagina":50,"dDataEmissaoInicial":"30/09/2026","dDataEmissaoFinal":"30/09/2026"}]}},"produtos_nfe_ListarNFe_retorno":{"type":"object","properties":{"nPagina":{"type":"integer","description":"Número da página resgatada."},"nTotPaginas":{"type":"integer","description":"Número total de páginas encontradas."},"nRegistros":{"type":"integer","description":"Número de registros retornados na página."},"nTotRegistros":{"type":"integer","description":"Número total de registros encontrados."},"listagemNfe":{"type":"array","items":{"type":"object","properties":{"cAppNome":{"type":"string","description":"Nome do Aplicativo que emitiu a NF-e. Exemplo: GeradorNF-e."},"cAppVersao":{"type":"string","description":"Versão do Aplicativo que emitiu a NF-e. Exemplo: 1.02.01."},"cAppId":{"type":"string","description":"Identificação do aplicativo que emitiu a NF-e. Exemplo: ID001 PS: Informe o código que identifica a instalação do aplicativo. Caso o cliente tenha 2 Emissores de NF-e, indique: \"01\" e \"02\" ou \"10\" e \"20\" e assim por diante."},"cOperacao":{"type":"string","description":"Tipo de Operação da Nota Fiscal. Códigos Disponíveis: 11 - Venda de produtos 21 - Compra de produtos."},"cOrigem":{"type":"string","description":"Origem da Nota Fiscal. Códigos Disponíveis: API - Importado via API."},"nCliente":{"type":"integer","description":"Id do cliente."},"nIdImportacao":{"type":"integer","description":"ID da Importação da NF-e."},"nIdNFe":{"type":"integer","description":"ID do NF-e."},"cChaveNFe":{"type":"string","description":"Chave da NF-e a ser importada. Apenas números com 44 digitos."},"dDataEmissao":{"type":"string","description":"Data de emissão da NF-e."},"cNumeroNFe":{"type":"string","description":"Número da NF-e."},"nValorNFe":{"type":"decimal","description":"Valor da NF-e."},"cStatus":{"type":"string","description":"Status da importação. Pode ser: 1 - Em processamento. 4 - Importada com sucesso. 9 - Erro na importação."},"dDataImportacao":{"type":"string","description":"Data da importação."},"cHoraImportacao":{"type":"string","description":"Hora da importação."},"cExcluido":{"type":"string","description":"Indica se o registro foi excluído (S ou N)."},"dDataExclusao":{"type":"string","description":"Data de exclusão."},"cHoraExclusao":{"type":"string","description":"Hora de exclusão."},"nIdExcusao":{"type":"integer","description":"ID da exclusão."}}},"description":"Lista de NFes importadas."}},"title":"ListarNFe (retorno)"},"produtos_notaentrada_AlterarNotaEnt":{"type":"object","title":"AlterarNotaEnt","description":"Alterar nota de entrada.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarNotaEnt"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cabec":{"type":"object","properties":{"nCodNotaEnt":{"type":"integer","maxLength":15,"description":"Código da Nota de Entrada no Omie\n\n\nEsse campo não é exibido na tela é uma informação interna, utilizada apenas nas APIs."},"cCodIntNotaEnt":{"type":"string","maxLength":20,"description":"Código de Integração da Nota de Entrada\n\n\n\nPreencha esse campo com o código da nota de entrada no aplicativo que você está integrando com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de notas de entrada você conseguirá ver a relação entre o id da nota de entrada gerado no Omie e o código de pedido existente em sua aplicação."},"nCodCli":{"type":"integer","maxLength":15,"description":"Código do cliente.\n\nPreencher quando não for informado cCodIntCli.\nNão preencher quando informado cCodIntCli.\n\nUtilize a tag \"codigo_cliente_omie\" do método \"ListarClientes\" da API\nhttp://app.omie.com.br/api/v1/geral/clientes/\npara obter essa informação."},"cCodIntCli":{"type":"string","maxLength":60,"description":"Código de Integração do Cliente\n\nPreencher quando não for informado nCodCli.\nNão preencher quando informado nCodCli.\n\nEsse campo deve ser informado apenas se você incluiu o cliente via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag nCodCli."},"dPrevisao":{"type":"string","maxLength":10,"description":"Data de previsão de faturamento.\n\n\nUtilize o formato \"dd/mm/aaaa\".\n\nEsse campo indica a data da previsão do faturamento do pedido e deve ser informado com uma data igual ou superior a data corrente.\n\nObrigatório na operação \"IncluirNotaEnt\"; opcional nas demais operações que\nreutilizam esta estrutura, como \"AlterarNotaEnt\"."},"nCodVend":{"type":"integer","maxLength":15,"description":"Código do vendedor\n\n\nUtilize a tag \"codigo\" do método \"ListarVendedores\" da API\nhttp://app.omie.com.br/api/v1/geral/vendedores para obter essa informação."},"cNumeroNotaEnt":{"type":"string","maxLength":15,"description":"Número da noata de entrada exibido na tela.\n\n\nDisponível apenas na consulta/listagem como retorno de informação."},"cGeraFinanceiro":{"type":"string","maxLength":1,"description":"Gerar movimentação financeira para a nota de entrada.\n\n\nInformar \"S\" ou \"N\"."},"cCodParc":{"type":"string","maxLength":3,"description":"Código da Condição de Pagamento/Parcelamento."},"nQtdeParc":{"type":"integer","maxLength":3,"description":"Quantidade de parcelas a serem geradas quando a condição de pagamento informada for \"999\"."}}},"frete":{"type":"object","properties":{"nCodTransp":{"type":"integer","maxLength":15,"description":"Código da transportadora\n\n\nEsse campo não é exibido na tela do pedido.\nÉ uma informação interna, utilizada apenas nas APIs.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido.\n\nUtilize a tag \"codigo_cliente_omie\" do método \"ListarClientes\" da API\nhttp://app.omie.com.br/api/v1/geral/clientes/\npara obter essa informação.\n\nOBS: O Omie uitliza o cadastro de clientes para registrar também fornecedores e transportadoras."},"cTpFrete":{"type":"string","maxLength":1,"description":"Tipo de frete.\n\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do pedido.\n\nValores disponíveis:\n\n\"0\" - Frete por conta do emitente.\n\"1\" - Frete por conta do destinatário.\n\"2\" - Frete por conta de terceiros.\n\"9\" - Sem frete."},"cPlaca":{"type":"string","maxLength":7,"description":"Placa do veículo.\n\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do pedido."},"cUF":{"type":"string","maxLength":2,"description":"Estado da placa do veículo.\n\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido."},"nQtdVol":{"type":"integer","maxLength":15,"description":"Quantidade de volumes\n\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido."},"cEspVol":{"type":"string","maxLength":60,"description":"Espécie de volume.\n\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido."},"cMarVol":{"type":"string","maxLength":60,"description":"Marca dos volumes.\n\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido."},"cNumVol":{"type":"string","maxLength":60,"description":"Numeração dos volumes.\n\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do pedido."},"nPesoLiq":{"type":"number","maxLength":18,"description":"Peso líquído (Kg)\n\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do pedido."},"nPesoBruto":{"type":"number","maxLength":18,"description":"Peso bruto (Kg)\n\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do pedido."},"nValFrete":{"type":"number","maxLength":18,"description":"Valor do frete\n\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do pedido."},"nValSeguro":{"type":"number","maxLength":18,"description":"Valor do seguro\n\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do pedido."},"nValOutras":{"type":"number","maxLength":18,"description":"Valor de outras despesas acessórias.\n\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do pedido."},"cNumeroLacre":{"type":"string","maxLength":60,"description":"Número dos Lacres."},"cRegistroTransp":{"type":"string","maxLength":20,"description":"RNTRC (ANTT) - Registro de transporte."},"cVeiculoProprio":{"type":"string","maxLength":1,"description":"O transporte será realizado com veículo próprio.\n\nInformar \"S\" ou \"N\".\n\nInformação localizada na Aba \"Frete e Outras Despesas\"."}}},"infAdic":{"type":"object","properties":{"cCodCateg":{"type":"string","maxLength":20,"description":"Código da categoria.\n\n\nInformação localizada na Aba \"Informações Adicionais\" do pedido.\n\nUtilize a tag \"codigo\" do método \"ListarCategorias\" da API\nhttp://app.omie.com.br/api/v1/geral/categorias/\npara obter essa informação.\n\nObrigatório na operação \"IncluirNotaEnt\"; opcional nas demais operações que\nreutilizam esta estrutura, como \"AlterarNotaEnt\"."},"cContato":{"type":"string","maxLength":100,"description":"Contato.\n\n\nInformação localizada na Aba \"Informações Adicionais\" do pedido."},"nCodProj":{"type":"integer","maxLength":15,"description":"Código do projeto.\n\n\nInformação localizada na Aba \"Informações Adicionais\" do pedido.\n\nUtilize a tag \"codigo\" do método \"ListarProjetos\" da API\nhttp://app.omie.com.br/api/v1/geral/projetos/\npara obter essa informação."},"cPedido":{"type":"string","maxLength":30,"description":"Número do pedido do cliente.\n\n\nInformação localizada na Aba \"Informações Adicionais\" do pedido."},"outrosDet":{"type":"object","properties":{"dDataSaida":{"type":"string","maxLength":10,"description":"Data de entrada/saída."},"cHoraSaida":{"type":"string","maxLength":8,"description":"Hora de entrada/saída."},"cNatOperacao":{"type":"string","maxLength":60,"description":"Natureza de operação."},"indIntermediario":{"type":"string","maxLength":1,"description":"Indicador de Intermediador.\n\n\nEsta informação deverá ser enviada quando se tratar de uma operação não presencial.\n\nOpções disponíveis:\n0=Operação sem intermediador(em site ou plataforma própria)\n1=Operação em site ou plataforma de terceiros(intermediadores/marketplace)\n\nSe não informado, utilizaremos automaticamente a opção \"0-Operação sem intermediador(em site ou plataforma própria)\".\n\nInformação localizada na Aba \"Informações Adicionais\"."},"indPresenca":{"type":"string","maxLength":1,"description":"Indicador de Presença da Operação."},"identIntermediario":{"type":"string","maxLength":60,"description":"Identificação no Intermediador.\n\n\nEste identificador pode ser o nome do usuário ou identificação do perfil do vendedor no site do intermediador.\n\nInformação localizada na Aba \"Informações Adicionais\"."},"cnpjIntermediario":{"type":"string","maxLength":20,"description":"CNPJ do Intermediador.\n\nPreencimento obrigatório caso o Indicador de Intermediador seja igual a opção \"1-Operação em site ou plataforma de terceiros(intermediadores/marketplace)\".\n\nEste campo representa o CNPJ do Intermediador da Transação.\n\nInformação localizada na Aba \"Informações Adicionais\"."},"infCanaAcucar":{"type":"object","properties":{"cSafra":{"type":"string","maxLength":9,"description":"Safra."},"cPerRef":{"type":"string","maxLength":7,"description":"Mês e Ano de referência da Safra de Cana-de-acúçar."},"nQuantMes":{"type":"number","description":"Quantidade total de fornecimento de cana-de-açúcar no período."},"nQuantAnt":{"type":"number","description":"Quantidade do fornecimento de cana-de-açúcar no período anterior."},"nQuantTot":{"type":"number","description":"Quantidade total atualizada do fornecimento de cana-de-açúcar."},"nValForn":{"type":"number","description":"Valor do fornecimento de cana-de-açúcar."},"nValDed":{"type":"number","description":"Valor total das deduções do período."},"nValLiq":{"type":"number","description":"Valor líquido do fornecimento de cana-de-açúcar."},"QtdDiariaCanaAc":{"type":"array","items":{"type":"object","properties":{"nDia":{"type":"integer","description":"Dia do mês do fornecimento de cana-de-açúcar."},"nQuantDia":{"type":"number","description":"Quantidade diária de fornecimento de cana-de-açúcar."}}},"description":"Registro do fornecimento diário de cana-de-açúcar."},"DeducaoCanaAc":{"type":"array","items":{"type":"object","properties":{"cDescrDed":{"type":"string","maxLength":350,"description":"Descrição da dedução na aquisição de cana-de-açúcar."},"nValorDed":{"type":"number","description":"Valor da dedução."}}},"description":"Deduções na aquisição de cana-de-açúcar."}},"description":"Informações da aquisição de Cana-de-açúcar."}},"description":"Informações adicionais outros detalhes da nota de entrada."},"cDadosAdic":{"type":"string","description":"Dados adicionais para a nota fiscal.\n\n\nUtilize o caracter pipe ( | ) como separador de linha.\n\nInformação localizada na Aba \"Informações Adicionais\" do pedido."},"cConsFinal":{"type":"string","maxLength":1,"description":"Nota fiscal para consumo final.\n\n\nInformar \"S\" ou \"N\".\n\nInformação localizada na Aba \"Informações Adicionais\" do pedido."},"nCodCC":{"type":"integer","maxLength":15,"description":"Código interno da conta corrente da nota fiscal (este é o código da conta corrente no Omie)."},"nfRelacionada":{"type":"object","properties":{"cChaveRef":{"type":"string","maxLength":44,"description":"Chave da NF-e (ou NFC-e ou SAT) Relacionada."},"nNFRef":{"type":"string","maxLength":9,"description":"Número da Nota Fiscal\n\nNota Fiscal Relacionada Modelo 1/1A."},"cSerieRef":{"type":"string","maxLength":3,"description":"Série da NF Referenciada.\n\nNota Fiscal Relacionada Modelo 1/1A."},"dtEmissaoRef":{"type":"string","maxLength":10,"description":"Data de emissão da NF Referenciada.\n\nNota Fiscal Relacionada Modelo 1/1A."},"cnpjEmitRef":{"type":"string","maxLength":20,"description":"CNPJ da Emitente da NF Referenciada.\n\nNota Fiscal Relacionada Modelo 1/1A."},"cUfRef":{"type":"string","maxLength":2,"description":"Estado do Emitente da NF Referenciada.\n\nNota Fiscal Relacionada Modelo 1/1A."},"nNfPR":{"type":"string","maxLength":9,"description":"Número da Nota Fiscal relacionada do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural."},"cSeriePR":{"type":"string","maxLength":3,"description":"Série da NF do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural."},"dtEmissaoPR":{"type":"string","maxLength":10,"description":"Data de emissão da NF do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural."},"cnpjPR":{"type":"string","maxLength":20,"description":"CNPJ/CPF do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural."},"InscrEstPR":{"type":"string","maxLength":20,"description":"Inscrição Estadual do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural."},"cUfPR":{"type":"string","maxLength":2,"description":"Estado do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural."},"nCOORef":{"type":"string","maxLength":6,"description":"Número do COO - Contador de Ordem de Operação.\n\nCupom Fiscal Relacionado."},"nECFRef":{"type":"string","maxLength":3,"description":"Número de Ordem Sequencial do ECF."},"nrProdutorRural":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","maxLength":1,"description":"Ação a ser realizada no item na alteração.\n\nPode ser:\n\n\"I\" - Incluir o item.\n\"E\" - Excluir o item."},"nrNumero":{"type":"string","maxLength":9,"description":"Número da NF relacionada."},"nrSerie":{"type":"string","maxLength":3,"description":"Série da NF relacionada."},"nrDtEmissao":{"type":"string","maxLength":10,"description":"Data de emissão da NF relacionada."},"nrCnpjCpf":{"type":"string","maxLength":20,"description":"CNPJ/CPF do emitente da NF relacionada."},"nrIE":{"type":"string","maxLength":20,"description":"Inscrição Estadual do emitente da NF relacionada."},"nrUF":{"type":"string","maxLength":2,"description":"Unidade federativa do emitente da NF relacionada."}}},"description":"Outras notas de produtor rural relacionadas."},"nrNF":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","maxLength":1,"description":"Ação a ser realizada no item na alteração.\n\nPode ser:\n\n\"I\" - Incluir o item.\n\"E\" - Excluir o item."},"nrChave":{"type":"string","maxLength":44,"description":"Chave da NF-e, NFC-e ou SAT relacionada."}}},"description":"Outras NF-e, NFC-e ou SAT relacionadas."},"nrCupomFiscal":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","maxLength":1,"description":"Ação a ser realizada no item na alteração.\n\nPode ser:\n\n\"I\" - Incluir o item.\n\"E\" - Excluir o item."},"nrCOO":{"type":"string","maxLength":6,"description":"Contador de Ordem de Operação (COO)."},"nrNumeroECF":{"type":"string","maxLength":3,"description":"Número do ECF."}}},"description":"Outros cupons fiscais relacionados."},"nrModelo1_1A":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","maxLength":1,"description":"Ação a ser realizada no item na alteração.\n\nPode ser:\n\n\"I\" - Incluir o item.\n\"E\" - Excluir o item."},"nrNumero":{"type":"string","maxLength":9,"description":"Número da NF relacionada."},"nrSerie":{"type":"string","maxLength":3,"description":"Série da NF relacionada."},"nrDtEmissao":{"type":"string","maxLength":10,"description":"Data de emissão da NF relacionada."},"nrCnpjCpf":{"type":"string","maxLength":20,"description":"CNPJ/CPF do emitente da NF relacionada."},"nrUF":{"type":"string","maxLength":2,"description":"Unidade federativa do emitente da NF relacionada."}}},"description":"Outras notas modelo 1/1A relacionadas."},"cSigNFRef":{"type":"string","maxLength":1,"description":"Manter o sigilo da NF-e referenciada.\n\nPreencher com \"S\" ou \"N\".\n\nDefault \"N\"."}},"description":"Detalhes da NF referenciada."},"infAdicFisco":{"type":"object","properties":{"cRegimeEsp":{"type":"string","maxLength":1,"description":"Possui regime especial S/N."},"cObsSped":{"type":"string","maxLength":10,"description":"Observação para uso exclusivo do SPED (Registro C110).\n\n(Necessário preencher campo cRegimeEsp \"S\" para alterar esta informação)."},"cInfAdic":{"type":"string","maxLength":10,"description":"Informações Adicionais de interesse do Fisco para a Nota Fiscal."}},"description":"Informações adicionais de interesse do fisco."}}},"email":{"type":"object","properties":{"cEmail":{"type":"string","description":"E-mail do cliente."}}},"obs":{"type":"object","properties":{"cObs":{"type":"string","description":"Observações da Remessa."}}},"produtos":{"type":"array","items":{"type":"object","properties":{"nCodIt":{"type":"integer","maxLength":15,"description":"Código do item da nota de entrada\n\nNão informar na inclusão preenchimento automático.\nInforme esse campo na alteração somente quando cCodItInt não for informado.\n\nEsse campo não é exibido na tela é uma informação interna, utilizada apenas nas APIs."},"cCodItInt":{"type":"string","maxLength":20,"description":"Código de integração do item da nota de entrada\n\n\n\nPreencha esse campo com o código do item do pedido no aplicativo que você está integrando com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de itens de pedidos você conseguirá ver a relação entre o id do item do pedido gerado no Omie e o código de item de pedido existente em sua aplicação."},"nCodProd":{"type":"integer","maxLength":15,"description":"ID do Produto.\n\nInforme esse campo somente quando cCodProdInt não for informado.\n\nEsse campo não é exibido na tela do pedido.\nÉ uma informação interna, utilizada apenas nas APIs.\n\nUtilize a tag \"codigo_produto\" do método \"ListarProdutos\" da API\nhttp://app.omie.com.br/api/v1/geral/produtos/\npara obter essa informação."},"cCodProdInt":{"type":"string","maxLength":60,"description":"Código de integração do produto.\n\nInforme esse campo somente quando nCodProd não for informado.\n\nEsse campo deve ser informado apenas se você incluiu o produto via API e informou um código de integração para o produto. Do contrário, informe sempre a tag \"nCodProd\"."},"cCFOP":{"type":"string","maxLength":10,"description":"CFOP - Código Fiscal de Operações e Prestações.\n\n\nUtilize a tag \"nCodigo\" do método \"ListarCFOP\" da API\nhttp://app.omie.com.br/api/v1/produtos/cfop/\npara obter essa informação.\n\nObrigatório na operação \"IncluirNotaEnt\"; obrigatório também em \"AlterarNotaEnt\"\napenas quando o item for novo (`cAcaoItem = \"I\"`) — opcional ao alterar ou excluir\num item já existente."},"nQtde":{"type":"number","maxLength":18,"description":"Quantidade."},"nValUnit":{"type":"number","maxLength":18,"description":"Valor unitário."},"cNCM":{"type":"string","maxLength":13,"description":"NCM - Nomenclatura Comum do Mercosul\n\n\nUtilize a tag \"cCodigo\" do método \"ListarNCM\" da API\nhttp://app.omie.com.br/api/v1/produtos/ncm/\npara obter essa informação."},"cEAN":{"type":"string","maxLength":14,"description":"EAN - European Article Number."},"nDesconto":{"type":"number","maxLength":18,"description":"Valor do desconto."},"ICMS":{"type":"object","properties":{"cSitTrib":{"type":"string","maxLength":2,"description":"Situação Tributária do ICMS."},"cOrigem":{"type":"string","maxLength":1,"description":"Origem."},"cModBC":{"type":"string","maxLength":1,"description":"Modalidade da BC do ICMS."},"nRedBC":{"type":"number","maxLength":10,"description":"Redução da BC do ICMS (%)."},"nBC":{"type":"number","maxLength":18,"description":"Base de Calculo do ICMS."},"nAliq":{"type":"number","maxLength":10,"description":"Alíquota de ICMS."},"nValor":{"type":"number","maxLength":18,"description":"Valor do ICMS."},"nBCRet":{"type":"number","maxLength":18,"description":"Base de Cálculo do ICMS Retido."},"nAliqCN":{"type":"number","maxLength":10,"description":"Alíquota Suportada pelo Cons. Final."},"nValorRetST":{"type":"number","maxLength":18,"description":"Valor do ICMS Retido por ST."},"nValorDif":{"type":"number","maxLength":18,"description":"Valor do ICMS Diferido."},"nValorICMD":{"type":"number","maxLength":18,"description":"Valor do ICMS Desonerado."},"nValorICMOP":{"type":"number","maxLength":18,"description":"Valor do ICMS Oper. Própria."},"cMotDeson":{"type":"string","maxLength":2,"description":"Motivo da Desoneração do ICMS\n\nPode ser:\n\n01 - Táxi\n03 - Produtor Agropecuário\n04 - Frotista/Locadora\n05 - Diplomático/Consular\n06 - Utilitários e Motocicletas da Amazônia Ocidental e Áreas de Livre Comércio (Resolução 714/88 e 790/94 – CONTRAN e suas alterações)\n07 - SUFRAMA\n08 - Venda a Órgão Público\n09 - Outros. (NT 2011/004)\n10 - Deficiente Condutor (Convênio ICMS 38/12)\n11 - Deficiente Não Condutor (Convênio ICMS 38/12)\n16 - Olimpíadas Rio 2016\n90 - Solicitado pelo Fisco."},"nPercDif":{"type":"number","maxLength":10,"description":"Percentual do Diferimento (%)."}}},"ICMS_ST":{"type":"object","properties":{"cModBCST":{"type":"string","maxLength":1,"description":"Modalidade da Base de Cálculo do ICMS Substituição Tributária."},"nMargVrAd":{"type":"number","maxLength":10,"description":"Margem de Valor Adicionado (%)."},"nRedBCST":{"type":"number","maxLength":10,"description":"Redução da BC do ICMS ST (%)."},"nBCST":{"type":"number","maxLength":18,"description":"Base de Cálculo do ICMS ST."},"nAliqST":{"type":"number","maxLength":10,"description":"Alíquota do ICMS ST (%)."},"nAliqOP":{"type":"number","maxLength":10,"description":"Alíq. do ICMS Oper. Própria (%)."},"nValorST":{"type":"number","maxLength":18,"description":"Valor do ICMS ST."}}},"ICMS_SN":{"type":"object","properties":{"cSitTribSN":{"type":"string","maxLength":3,"description":"Situação Tributária do ICMS."},"cOrigem":{"type":"string","maxLength":1,"description":"Origem."},"nAliqCredSN":{"type":"number","maxLength":10,"description":"Alíq. de Cálculo de Crédito (%)."},"nCredSN":{"type":"number","maxLength":18,"description":"Crédito do ICMS Aproveitado."},"nBCSNST":{"type":"number","maxLength":18,"description":"Base de Cálculo do ICMS Retido."},"nValorSNST":{"type":"number","maxLength":18,"description":"Valor do ICMS Retido por ST."},"cModBCSN":{"type":"string","maxLength":1,"description":"Modalidade da BC do ICMS."},"nAliqRedBCSN":{"type":"number","maxLength":10,"description":"Redução da BC do ICMS (%)."},"nBCSN":{"type":"number","maxLength":18,"description":"Base de Cálculo do ICMS."},"nAliqSN":{"type":"number","maxLength":10,"description":"Alíquota do ICMS (%)."},"nValorSN":{"type":"number","maxLength":18,"description":"Valor do ICMS."}}},"ICMS_INTER":{"type":"object","properties":{"nBCUFDest":{"type":"number","maxLength":18,"description":"Base de Cálculo ICMS na UF de Destino."},"nValorFCPUFDest":{"type":"number","maxLength":10,"description":"Valor do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de Destino."},"nAliqICMSUFDest":{"type":"number","maxLength":10,"description":"Alíquota Interna da UF de Destino."},"nICMSInter":{"type":"number","maxLength":10,"description":"Alíquota Interestadual das UFs Envolvidas."},"nRedICMSUFDest":{"type":"number","maxLength":10,"description":"Alíquota Redução Base ICMS da UF Destino."},"nPercFCPUFDest":{"type":"number","maxLength":18,"description":"Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de Destino."},"nValorICMSUFDest":{"type":"number","maxLength":18,"description":"Valor do ICMS - UF Destino."},"nICMSUFRemet":{"type":"number","maxLength":18,"description":"Valor do ICMS - UF Remetente."}},"description":"Informações do ICMS Interestadual."},"IPI":{"type":"object","properties":{"cSitTribIPI":{"type":"string","maxLength":2,"description":"Situação Tributária do IPI."},"cTpCalcIPI":{"type":"string","maxLength":1,"description":"Tipo de Cálculo para obter o IPI."},"nBCIPI":{"type":"number","maxLength":18,"description":"Base de Cálculo do IPI."},"cEnqIPI":{"type":"string","description":"Enquadramento do IPI."},"nAliqIPI":{"type":"number","maxLength":10,"description":"Alíquota do IPI (%)."},"nQtdUTIPI":{"type":"number","maxLength":18,"description":"Qtd Unidades Tributáveis."},"nValIPIUT":{"type":"number","maxLength":18,"description":"Valor do IPI por Unid. Tributável."},"nValIPI":{"type":"number","maxLength":18,"description":"Valor do IPI."}}},"PIS":{"type":"object","properties":{"cSitTribPIS":{"type":"string","maxLength":2,"description":"Situação Tributária doPIS."},"cTpCalcPIS":{"type":"string","maxLength":1,"description":"Tipo de Cálculo para obter o PIS."},"nBCPIS":{"type":"number","maxLength":18,"description":"Base de Cálculo do PIS."},"nAliqPIS":{"type":"number","maxLength":10,"description":"Alíquota do PIS (%)."},"nQtdUTPIS":{"type":"number","maxLength":18,"description":"Qtd Unidades Tributáveis."},"nValPISUT":{"type":"number","maxLength":18,"description":"Valor do PIS por Unid. Tributável."},"nValPIS":{"type":"number","maxLength":18,"description":"Valor do PIS."},"nPercRedBCPIS":{"type":"number","maxLength":10,"description":"Percentual de Redução da Base de Cálculo do PIS."}}},"COFINS":{"type":"object","properties":{"cSitTribCOFINS":{"type":"string","maxLength":2,"description":"Situação Tributária do COFINS."},"cTpCalcCOFINS":{"type":"string","maxLength":1,"description":"Tipo de Cálculo para obter o COFINS."},"nBCCOFINS":{"type":"number","maxLength":18,"description":"Base de Cálculo do COFINS."},"nAliqCOFINS":{"type":"number","maxLength":10,"description":"Alíquota do COFINS (%)."},"nQtdUTCOFINS":{"type":"number","maxLength":18,"description":"Qtd Unidades Tributáveis."},"nVaCOFINSSUT":{"type":"number","maxLength":18,"description":"Valor do COFINS Unid. Tributável."},"nValCOFINS":{"type":"number","maxLength":18,"description":"Valor do COFINS."},"nPercRedBCCOFINS":{"type":"number","maxLength":10,"description":"Percentual de Redução da Base de Cálculo do COFINS."}}},"infAdicItem":{"type":"object","properties":{"nPesoLiq":{"type":"number","maxLength":18,"description":"Peso líquido (Kg)."},"nPesoBruto":{"type":"number","maxLength":18,"description":"Peso bruto (Kg)."},"cPedCompra":{"type":"string","maxLength":15,"description":"Número do pedido de compra."},"nItemPedCompra":{"type":"integer","maxLength":6,"description":"Item do pedido de compra."},"cInfItemNF":{"type":"string","description":"Informações para a nota fiscal."},"cNaoMovEstoque":{"type":"string","maxLength":1,"description":"Não gerar a saída de estoque deste item ao emitir NF-e.\n\nInformar \"S\" ou \"N\".\n(informe \"S\" para ativar essa opção)."},"cCodBenef":{"type":"string","maxLength":10,"description":"Código de Beneficiário Fiscal na UF aplicado ao item."},"numero_recopi":{"type":"string","maxLength":20,"description":"Número do registro gerado pelo sistema RECOPI Nacional (Reconhecimento e Controle das Operações com Papel Imune)."}}},"cCest":{"type":"string","description":"CEST."},"rastreabilidade":{"type":"object","properties":{"numeroLote":{"type":"string","maxLength":20,"description":"Número do Lote."},"qtdeProdutoLote":{"type":"number","maxLength":12,"description":"Quantidade de Produto."},"dataFabricacaoLote":{"type":"string","maxLength":10,"description":"Data de Fabricação/Produção."},"dataValidadeLote":{"type":"string","maxLength":10,"description":"Data de Validade."},"codigoAgregacaoLote":{"type":"string","maxLength":20,"description":"Código de Agregação."}},"description":"Rastreabilidade do produto."},"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do local do estoque.\n\n\nCaso não preenchido assumirá o local de estoque padrão."},"codigo_local_estoque_saida":{"type":"integer","maxLength":15,"description":"Código do local do estoque saída.\n\n\nEste é o local de estoque de saída do cliente ou fornecedor (terceiro). Ao concluir a nota de entrada, o sistema poderá criar automaticamente a saída de estoque neste local."},"medicamentos":{"type":"object","properties":{"cCodigoAnvisa":{"type":"string","maxLength":13,"description":"Código ANVISA.\n\nO \"Código de Produto da ANVISA\" deve possuir 13 caractéres."},"nValMaxCons":{"type":"number","maxLength":15,"description":"Preço máximo consumidor.\n\nPreço máximo deve ser maior ou igual a zero."}},"description":"Detalhamento específico para medicamentos."},"veiculos":{"type":"object","properties":{"cTipoOpVeiculo":{"type":"string","maxLength":1,"description":"Veículos - Tipo da Operação\n\nPode ser:\n\n1 - Venda concessionária\n2 - Faturamento direto para consumidor final\n3 - Venda direta para grandes consumidores (frotista, governo, ...)\n0 - Outros."},"cChassiVeiculo":{"type":"string","maxLength":17,"description":"Veículos - Chassi do Veículo."},"cCondVinVeiculo":{"type":"string","maxLength":1,"description":"Veículos - Condição do VIN\n\nPode ser:\n\nR - Remarcado\nN - Normal."},"cModAnoFabrVeiculo":{"type":"string","maxLength":4,"description":"Veículos - Ano Modelo de Fabricação."},"cAnoFabrVeiculo":{"type":"string","maxLength":4,"description":"Veículos - Ano de Fabricação."},"cEspecieVeiculo":{"type":"string","maxLength":1,"description":"Veículos - Espécie de Veículo\n\nPode ser:\n\n1 - PASSAGEIRO\n2 - CARGA\n3 - MISTO\n4 - CORRIDA\n5 - TRAÇÃO\n6 - ESPECIAL."},"cTipoVeiculo":{"type":"string","maxLength":2,"description":"Veículos - Tipo de Veículo\n\nPode ser:\n\n02 - CICLOMOTO\n03 - MOTONETA\n04 - MOTOCICLO\n05 - TRICICLO\n06 - AUTOMÓVEL\n07 - MICROÔNIBUS\n08 - ÔNIBUS\n10 - REBOQUE\n11 - SEMIRREBOQUE\n13 - CAMINHONETA\n14 - CAMINHÃO\n17 - C. TRATOR\n22 - ESP/ÔNIBUS\n23 - MISTO/CAM\n24 - CARGA/CAM."},"potenciaMotor":{"type":"object","properties":{"cPotenciaVeiculo":{"type":"string","maxLength":4,"description":"Veículos - Potência Motor (CV)."},"cCilindradasVeiculo":{"type":"string","maxLength":4,"description":"Veículos - Cilindradas."},"cTipoCombVeiculo":{"type":"string","maxLength":2,"description":"Veículos - Tipo de Combustível\n\nPode ser:\n\n01 - Álcool\n02 - Gasolina\n03 - Diesel\n16 - Álcool/Gasolina\n17 - Gasolina/Álcool/GNV\n18 - Gasolina/Elétrico\n04 - Gasogênio\n05 - Gás Metano\n06 - Elétrico/Fonte Interna\n07 - Elétrico/Fonte Externa\n08 - Gasolina/Gás Natural Combustív\n09 - Álcool/Gás Natural Combustível\n10 - Diesel/Gas Natural Combustível\n11 - Vide/Campo/Observação\n12 - Álcool/Gás Natural Veicular\n13 - Gasolina/Gás Natural Veicular\n14 - Diesel/Gás Natural Veicular\n15 - Gás Natural Veicular\n19 - Gasolina/Álcool/Elétrico\n20 - Gás Natural Liquefeito\n21 - Diesel/Elétrico\n22 - Híbrido\n23 - Híbrido Plug-in\n24 - Elétrico\n25 - Célula Combustível\n26 - Híbrido/Gás Natural Veicular\n27 - Etanol/Elétrico."},"cNumMotorVeiculo":{"type":"string","maxLength":21,"description":"Veículos - Número de Motor."}},"description":"Dados específico para veículos novos - Potência, Combustível e Motor."},"pinturaCor":{"type":"object","properties":{"cTipoPinVeiculo":{"type":"string","maxLength":1,"description":"Veículos - Tipo de Pintura."},"cCodCorDENATRANVeiculo":{"type":"string","maxLength":2,"description":"Veículos - Código da Cor (DENATRAN)\n\nPode ser:\n\n01 - AMARELO\n02 - AZUL\n03 - BEGE\n04 - BRANCA\n05 - CINZA\n06 - DOURADA\n07 - GRENÁ\n08 - LARANJA\n09 - MARROM\n10 - PRATA\n11 - PRETA\n12 - ROSA\n13 - ROXA\n14 - VERDE\n15 - VERMELHA\n16 - FANTASIA."},"cCodCorMontVeiculo":{"type":"string","maxLength":4,"description":"Veículos - Código da Cor da Montadora."},"cDescMontVeiculo":{"type":"string","maxLength":40,"description":"Veículos - Descrição da Cor da Montadora."}},"description":"Dados específico para veículos novos - Pintura e Cor."},"outrasInfVeiculo":{"type":"object","properties":{"cCodMarcaModVeiculo":{"type":"string","maxLength":6,"description":"Veículos - Código Marca Modelo."},"cSerialVeiculo":{"type":"string","maxLength":9,"description":"Veículos - Serial (série)."},"cMaxTracaoVeiculo":{"type":"string","maxLength":9,"description":"Veículos - Capacidade Máxima de Tração."},"cDisEixosVeiculo":{"type":"string","maxLength":4,"description":"Veículos - Distância entre Eixos."},"cCondVeiVeiculo":{"type":"string","maxLength":1,"description":"Veículos - Condição do Veículo\n\nPode ser:\n\n1 - Acabado\n2 - Inacabado\n3 - Semiacabado."},"cMaxLotVeiculo":{"type":"string","maxLength":3,"description":"Veículos - Capacidade máxima de lotação."},"cRestVeiculo":{"type":"string","maxLength":1,"description":"Veículos - Restrição\n\nPode ser:\n\n0 - Não há\n1 - Alienação Fiduciária\n2 - Arrendamento Mercantil\n3 - Reserva de Domínio\n4 - Penhor de Veículos\n9 - Outras."},"cPesoBrutoVeiculo":{"type":"string","maxLength":9,"description":"Veículos - Peso Bruto (toneladas)."},"cPesoLiqVeiculo":{"type":"string","maxLength":9,"description":"Veículos - Peso Líquido (toneladas)."}},"description":"Dados específico para veículos novos - Outras informações."}},"description":"Dados específico para veículos novos."},"combustivel":{"type":"object","properties":{"cCodigoANP":{"type":"string","maxLength":9,"description":"Combustíveis - Código de produto da ANP."},"cDescrANP":{"type":"string","maxLength":95,"description":"Combustíveis - Descrição do Produto conforme ANP."},"cCODIF":{"type":"string","maxLength":21,"description":"Combustíveis - Código de autorização / registro do CODIF."},"nPercGLP":{"type":"number","maxLength":6,"description":"Combustíveis - Percentual de Gás Natural para o produto GLP."},"nPercGasNacional":{"type":"number","maxLength":8,"description":"Combustíveis - Percentual de Gás Natural Nacional."},"nPercGasImportado":{"type":"number","maxLength":8,"description":"Combustíveis - Percentual de Gás Natural Importado."},"nValorPartida":{"type":"number","maxLength":16,"description":"Combustíveis - Valor de Partida."},"nQtdeFatTempAmb":{"type":"number","maxLength":16,"description":"Combustíveis - Quantidade de combustível faturada à temperatura ambiente."},"cUFConsumoComb":{"type":"string","maxLength":2,"description":"Combustíveis - Sigla da UF de consumo."},"nBC_CIDE":{"type":"number","maxLength":18,"description":"Combustíveis - Base de Cálculo (em quantidade)  da CIDE."},"nAliquota_CIDE":{"type":"number","maxLength":10,"description":"Combustíveis - Valor da Alíquota em Reais da CIDE."},"nValor_CIDE":{"type":"number","maxLength":18,"description":"Combustíveis - Valor da CIDE."}},"description":"Detalhamento específico de combustíveis."},"custos":{"type":"object","properties":{"cICMSCusto":{"type":"string","maxLength":1,"description":"ICMS é custo de estoque.\n\nInformar \"S\" ou \"N\"."},"cPISCusto":{"type":"string","maxLength":1,"description":"PIS é custo de estoque.\n\nInformar \"S\" ou \"N\"."},"cICMSSTCusto":{"type":"string","maxLength":1,"description":"ICMS ST é custo de estoque.\n\nInformar \"S\" ou \"N\"."},"cCOFINSCusto":{"type":"string","maxLength":1,"description":"COFINS é custo de estoque.\n\nInformar \"S\" ou \"N\"."},"cIPICusto":{"type":"string","maxLength":1,"description":"IPI é custo de estoque.\n\nInformar \"S\" ou \"N\"."},"cFreteCusto":{"type":"string","maxLength":1,"description":"Frete é custo de estoque.\n\nInformar \"S\" ou \"N\"."},"cSeguroCusto":{"type":"string","maxLength":1,"description":"Seguro é custo de estoque.\n\nInformar \"S\" ou \"N\"."},"cOutrosDespCusto":{"type":"string","maxLength":1,"description":"Outras Desp. é custo de estoque.\n\nInformar \"S\" ou \"N\"."},"nValorICMSSTCusto":{"type":"number","maxLength":18,"description":"Valor do ICMS ST."},"nAliqCredPISCusto":{"type":"number","maxLength":10,"description":"% Alíq. de Crédito do PIS"},"nAliqCredCOFINSCusto":{"type":"number","maxLength":10,"description":"% Alíq. de Crédito do COFINS"}},"description":"Custos de estoque do item da nota de entrada."},"cAcaoItem":{"type":"string","maxLength":1,"description":"Ação a ser realizada no item.\n\nPode ser:\n\n\"A\" - Alterar o item.\n\"E\" - Excluir o item.\n\"I\" - Incluir o item.\n\nObrigatório na operação \"AlterarNotaEnt\"; opcional em \"IncluirNotaEnt\" (assume \"I\"\ncomo padrão, já que toda inclusão de nota implica itens novos)."},"lote_validade":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","maxLength":15,"description":"Id do Lote do produto.\n\nObrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.."},"nQtdLote":{"type":"number","maxLength":18,"description":"Informe aqui a quantidade do lote para o produto.\n\nÉ obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações."},"cNumLote":{"type":"string","maxLength":20,"description":"Número do lote do produto.\n\nDeve ser informado apenas quando a tag [nIdLote] não for informada, com isso, será criado um novo lote a partir do número informado."},"cCodAgreg":{"type":"string","maxLength":20,"description":"Código de agregação do lote do produto.\n\nDeve ser informado apenas quando a tag [nIdLote] não for informada."},"dDataFab":{"type":"string","maxLength":10,"description":"Data de fabricação do lote.\n\nDeve ser informado apenas quando a tag [nIdLote] não for informada.\n\nComo default é utilizado a data atual."},"dDataVal":{"type":"string","maxLength":10,"description":"Data de validade do lote.\n\nDeve ser informado apenas quando a tag [nIdLote] não for informada."}},"required":["nQtdLote"]},"description":"Informações referentes ao lote e validade do produto.\n\nA tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes \"manualmente\" por API."},"IBS_CBS":{"type":"object","properties":{"cCstIbsCbs":{"type":"string","maxLength":3,"description":"Código de Situação Tributária do IBS e CBS."},"cClassTrib":{"type":"string","maxLength":6,"description":"Código de Classificação Tributária do IBS e CBS."},"nBaseIbsCbs":{"type":"number","maxLength":15,"description":"Base de cálculo do IBS e CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será calculado automaticamente."}}},"IBS":{"type":"object","properties":{"nAliqIbsUf":{"type":"number","maxLength":7,"description":"Alíquota do IBS de competência das UF."},"nPercDiferimentoIbsUf":{"type":"number","maxLength":7,"description":"Percentual do Diferimento - IBS UF."},"nPercReducaoIbsUf":{"type":"number","maxLength":7,"description":"Percentual da redução de alíquota - IBS UF."},"nValDiferimentoIbsUf":{"type":"number","maxLength":15,"description":"Valor do Diferimento - IBS UF.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será calculado automaticamente."},"nValIbsUf":{"type":"number","maxLength":15,"description":"Valor do IBS de competência da UF.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será calculado automaticamente."},"nAliqIbsMun":{"type":"number","maxLength":7,"description":"Alíquota do IBS de competência do Município."},"nPercDiferimentoIbsMun":{"type":"number","maxLength":7,"description":"Percentual do diferimento - UBS Município."},"nPercReducaoIbsMun":{"type":"number","maxLength":7,"description":"Percentual da redução de alíquota - IBS Município."},"nValDiferimentoIbsMun":{"type":"number","maxLength":15,"description":"Valor do Diferimento - IBS Município.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será calculado automaticamente."},"nValIbsMun":{"type":"number","maxLength":15,"description":"Valor do IBS de competência do Município.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será calculado automaticamente."},"nValIbs":{"type":"number","maxLength":15,"description":"Valor total do IBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será calculado automaticamente."}}},"CBS":{"type":"object","properties":{"nAliqCbs":{"type":"number","maxLength":7,"description":"Alíquota da CBS."},"nPercDiferimentoCbs":{"type":"number","maxLength":7,"description":"Percentual do diferimento - CBS."},"nPercReducaoCbs":{"type":"number","maxLength":7,"description":"Percentual da redução de alíquota - CBS."},"nValDiferimentoCbs":{"type":"number","maxLength":15,"description":"Valor do diferimento - CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será calculado automaticamente."},"nValCbs":{"type":"number","maxLength":15,"description":"Valor da CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será calculado automaticamente."}}},"TRIB_REG":{"type":"object","properties":{"cCstIbsCbsReg":{"type":"string","maxLength":3,"description":"Código da Situação Tributária do IBS e CBS (Tributação Regular)."},"cClassTribReg":{"type":"string","maxLength":6,"description":"Código de Classificação Tributária do IBS e CBS (Tributação Regular)."},"nAliqIbsUfReg":{"type":"number","maxLength":7,"description":"Valor da alíquota do IBS da UF na tributação regular."},"nAliqIbsMunReg":{"type":"number","maxLength":7,"description":"Valor da alíquota do IBS do Município na tributação regular."},"nAliqCbsReg":{"type":"number","maxLength":7,"description":"Valor da alíquota da CBS na tributação regular."},"nValIbsUfReg":{"type":"number","maxLength":15,"description":"Valor do Tributo do IBS da UF na tributação regular.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será calculado automaticamente."},"nValIbsMunReg":{"type":"number","maxLength":15,"description":"Valor do Tributo do IBS do Município na tributação regular.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será calculado automaticamente."},"nValCbsReg":{"type":"number","maxLength":15,"description":"Valor do Tributo da CBS na tributação regular.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será calculado automaticamente."}}}}}},"departamentos":{"type":"array","items":{"type":"object","properties":{"cCodDepto":{"type":"string","maxLength":40,"description":"Código do Departamento - Preenchimento obrigatório.\n\nInformação localizada na Aba \"Departamentos\" da Nota de Entrada.\n\nUtilize a tag \"codigo\" do método \"ListarDepatartamentos\" da API\n/api/v1/geral/departamentos/ para obter essa informação."},"nValor":{"type":"number","maxLength":18,"description":"Valor do rateio - Preenchimento obrigatório.\n\nInformação localizada na Aba \"Departamentos\" da Nota de Entrada."},"nPerc":{"type":"number","maxLength":10,"description":"Percentual do rateio - Preenchimento obrigatório.\n\nInformação localizada na Aba \"Departamentos\" da Nota de Entrada."}},"required":["cCodDepto","nPerc","nValor"]}}}}}},"example":{"call":"AlterarNotaEnt","param":[{"cabec":{"nCodNotaEnt":112233,"dPrevisao":"22/10/2026"}}]}},"produtos_notaentrada_AlterarNotaEnt_retorno":{"type":"object","properties":{"nCodNotaEnt":{"type":"integer","description":"Código da nota de entrada."},"cCodIntNotaEnt":{"type":"string","description":"Código de integração da nota de entrada."},"cCodStatus":{"type":"string","description":"Código do status da nota de entrada."},"cDesStatus":{"type":"string","description":"Descrição do status da nota de entrada."},"cNumeroNotaEnt":{"type":"string","description":"Número da nota de entrada exibido na tela."}},"title":"AlterarNotaEnt (retorno)"},"produtos_notaentrada_ConsultarNotaEnt":{"type":"object","title":"ConsultarNotaEnt","description":"Consultar nota de entrada.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarNotaEnt"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodNotaEnt":{"type":"integer","maxLength":15,"description":"ID da nota de entrada."},"cCodIntNotaEnt":{"type":"string","maxLength":20,"description":"Código de integração da nota de entrada."}}}}},"example":{"call":"ConsultarNotaEnt","param":[{"nCodNotaEnt":112233}]}},"produtos_notaentrada_ConsultarNotaEnt_retorno":{"type":"object","properties":{"cabec":{"type":"object","properties":{"nCodNotaEnt":{"type":"integer","description":"Código da Nota de Entrada no Omie Esse campo não é exibido na tela é uma informação interna, utilizada apenas nas APIs."},"cCodIntNotaEnt":{"type":"string","description":"Código de Integração da Nota de Entrada Preencha esse campo com o código da nota de entrada no aplicativo que você está integrando com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de notas de entrada você conseguirá ver a relação entre o id da nota de entrada gerado no Omie e o código de pedido existente em sua aplicação."},"nCodCli":{"type":"integer","description":"Código do cliente. Preencher quando não for informado cCodIntCli. Não preencher quando informado cCodIntCli. Utilize a tag \"codigo_cliente_omie\" do método \"ListarClientes\" da API http://app.omie.com.br/api/v1/geral/clientes/ para obter essa informação."},"cCodIntCli":{"type":"string","description":"Código de Integração do Cliente Preencher quando não for informado nCodCli. Não preencher quando informado nCodCli. Esse campo deve ser informado apenas se você incluiu o cliente via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag nCodCli."},"dPrevisao":{"type":"string","description":"Data de previsão de faturamento. Utilize o formato \"dd/mm/aaaa\". Esse campo indica a data da previsão do faturamento do pedido e deve ser informado com uma data igual ou superior a data corrente. Obrigatório na operação \"IncluirNotaEnt\"; opcional nas demais operações que reutilizam esta estrutura, como \"AlterarNotaEnt\"."},"nCodVend":{"type":"integer","description":"Código do vendedor Utilize a tag \"codigo\" do método \"ListarVendedores\" da API http://app.omie.com.br/api/v1/geral/vendedores para obter essa informação."},"cNumeroNotaEnt":{"type":"string","description":"Número da noata de entrada exibido na tela. Disponível apenas na consulta/listagem como retorno de informação."},"cGeraFinanceiro":{"type":"string","description":"Gerar movimentação financeira para a nota de entrada. Informar \"S\" ou \"N\"."},"cCodParc":{"type":"string","description":"Código da Condição de Pagamento/Parcelamento."},"nQtdeParc":{"type":"integer","description":"Quantidade de parcelas a serem geradas quando a condição de pagamento informada for \"999\"."}}},"frete":{"type":"object","properties":{"nCodTransp":{"type":"integer","description":"Código da transportadora Esse campo não é exibido na tela do pedido. É uma informação interna, utilizada apenas nas APIs. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido. Utilize a tag \"codigo_cliente_omie\" do método \"ListarClientes\" da API http://app.omie.com.br/api/v1/geral/clientes/ para obter essa informação. OBS: O Omie uitliza o cadastro de clientes para registrar também fornecedores e transportadoras."},"cTpFrete":{"type":"string","description":"Tipo de frete. Informação localizada na Aba \"Frete e Outras Despesas\" do pedido. Valores disponíveis: \"0\" - Frete por conta do emitente. \"1\" - Frete por conta do destinatário. \"2\" - Frete por conta de terceiros. \"9\" - Sem frete."},"cPlaca":{"type":"string","description":"Placa do veículo. Informação localizada na Aba \"Frete e Outras Despesas\" do pedido."},"cUF":{"type":"string","description":"Estado da placa do veículo. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido."},"nQtdVol":{"type":"integer","description":"Quantidade de volumes Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido."},"cEspVol":{"type":"string","description":"Espécie de volume. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido."},"cMarVol":{"type":"string","description":"Marca dos volumes. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido."},"cNumVol":{"type":"string","description":"Numeração dos volumes. Informação localizada na Aba \"Frete e Outras Despesas\" do pedido."},"nPesoLiq":{"type":"decimal","description":"Peso líquído (Kg) Informação localizada na Aba \"Frete e Outras Despesas\" do pedido."},"nPesoBruto":{"type":"decimal","description":"Peso bruto (Kg) Informação localizada na Aba \"Frete e Outras Despesas\" do pedido."},"nValFrete":{"type":"decimal","description":"Valor do frete Informação localizada na Aba \"Frete e Outras Despesas\" do pedido."},"nValSeguro":{"type":"decimal","description":"Valor do seguro Informação localizada na Aba \"Frete e Outras Despesas\" do pedido."},"nValOutras":{"type":"decimal","description":"Valor de outras despesas acessórias. Informação localizada na Aba \"Frete e Outras Despesas\" do pedido."},"cNumeroLacre":{"type":"string","description":"Número dos Lacres."},"cRegistroTransp":{"type":"string","description":"RNTRC (ANTT) - Registro de transporte."},"cVeiculoProprio":{"type":"string","description":"O transporte será realizado com veículo próprio. Informar \"S\" ou \"N\". Informação localizada na Aba \"Frete e Outras Despesas\"."}}},"infAdic":{"type":"object","properties":{"cCodCateg":{"type":"string","description":"Código da categoria. Informação localizada na Aba \"Informações Adicionais\" do pedido. Utilize a tag \"codigo\" do método \"ListarCategorias\" da API http://app.omie.com.br/api/v1/geral/categorias/ para obter essa informação. Obrigatório na operação \"IncluirNotaEnt\"; opcional nas demais operações que reutilizam esta estrutura, como \"AlterarNotaEnt\"."},"cContato":{"type":"string","description":"Contato. Informação localizada na Aba \"Informações Adicionais\" do pedido."},"nCodProj":{"type":"integer","description":"Código do projeto. Informação localizada na Aba \"Informações Adicionais\" do pedido. Utilize a tag \"codigo\" do método \"ListarProjetos\" da API http://app.omie.com.br/api/v1/geral/projetos/ para obter essa informação."},"cPedido":{"type":"string","description":"Número do pedido do cliente. Informação localizada na Aba \"Informações Adicionais\" do pedido."},"outrosDet":{"type":"object","properties":{"dDataSaida":{"type":"string","description":"Data de entrada/saída."},"cHoraSaida":{"type":"string","description":"Hora de entrada/saída."},"cNatOperacao":{"type":"string","description":"Natureza de operação."},"indIntermediario":{"type":"string","description":"Indicador de Intermediador. Esta informação deverá ser enviada quando se tratar de uma operação não presencial. Opções disponíveis: 0=Operação sem intermediador(em site ou plataforma própria) 1=Operação em site ou plataforma de terceiros(intermediadores/marketplace) Se não informado, utilizaremos automaticamente a opção \"0-Operação sem intermediador(em site ou plataforma própria)\". Informação localizada na Aba \"Informações Adicionais\"."},"indPresenca":{"type":"string","description":"Indicador de Presença da Operação."},"identIntermediario":{"type":"string","description":"Identificação no Intermediador. Este identificador pode ser o nome do usuário ou identificação do perfil do vendedor no site do intermediador. Informação localizada na Aba \"Informações Adicionais\"."},"cnpjIntermediario":{"type":"string","description":"CNPJ do Intermediador. Preencimento obrigatório caso o Indicador de Intermediador seja igual a opção \"1-Operação em site ou plataforma de terceiros(intermediadores/marketplace)\". Este campo representa o CNPJ do Intermediador da Transação. Informação localizada na Aba \"Informações Adicionais\"."},"infCanaAcucar":{"type":"object","properties":{"cSafra":{"type":"string","description":"Safra."},"cPerRef":{"type":"string","description":"Mês e Ano de referência da Safra de Cana-de-acúçar."},"nQuantMes":{"type":"decimal","description":"Quantidade total de fornecimento de cana-de-açúcar no período."},"nQuantAnt":{"type":"decimal","description":"Quantidade do fornecimento de cana-de-açúcar no período anterior."},"nQuantTot":{"type":"decimal","description":"Quantidade total atualizada do fornecimento de cana-de-açúcar."},"nValForn":{"type":"decimal","description":"Valor do fornecimento de cana-de-açúcar."},"nValDed":{"type":"decimal","description":"Valor total das deduções do período."},"nValLiq":{"type":"decimal","description":"Valor líquido do fornecimento de cana-de-açúcar."},"QtdDiariaCanaAc":{"type":"array","items":{"type":"object","properties":{"nDia":{"type":"integer","description":"Dia do mês do fornecimento de cana-de-açúcar."},"nQuantDia":{"type":"decimal","description":"Quantidade diária de fornecimento de cana-de-açúcar."}}},"description":"Registro do fornecimento diário de cana-de-açúcar."},"DeducaoCanaAc":{"type":"array","items":{"type":"object","properties":{"cDescrDed":{"type":"string","description":"Descrição da dedução na aquisição de cana-de-açúcar."},"nValorDed":{"type":"decimal","description":"Valor da dedução."}}},"description":"Deduções na aquisição de cana-de-açúcar."}},"description":"Informações da aquisição de Cana-de-açúcar."}},"description":"Informações adicionais outros detalhes da nota de entrada."},"cDadosAdic":{"type":"string","description":"Dados adicionais para a nota fiscal. Utilize o caracter pipe ( | ) como separador de linha. Informação localizada na Aba \"Informações Adicionais\" do pedido."},"cConsFinal":{"type":"string","description":"Nota fiscal para consumo final. Informar \"S\" ou \"N\". Informação localizada na Aba \"Informações Adicionais\" do pedido."},"nCodCC":{"type":"integer","description":"Código interno da conta corrente da nota fiscal (este é o código da conta corrente no Omie)."},"nfRelacionada":{"type":"object","properties":{"cChaveRef":{"type":"string","description":"Chave da NF-e (ou NFC-e ou SAT) Relacionada."},"nNFRef":{"type":"string","description":"Número da Nota Fiscal Nota Fiscal Relacionada Modelo 1/1A."},"cSerieRef":{"type":"string","description":"Série da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A."},"dtEmissaoRef":{"type":"string","description":"Data de emissão da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A."},"cnpjEmitRef":{"type":"string","description":"CNPJ da Emitente da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A."},"cUfRef":{"type":"string","description":"Estado do Emitente da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A."},"nNfPR":{"type":"string","description":"Número da Nota Fiscal relacionada do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural."},"cSeriePR":{"type":"string","description":"Série da NF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural."},"dtEmissaoPR":{"type":"string","description":"Data de emissão da NF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural."},"cnpjPR":{"type":"string","description":"CNPJ/CPF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural."},"InscrEstPR":{"type":"string","description":"Inscrição Estadual do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural."},"cUfPR":{"type":"string","description":"Estado do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural."},"nCOORef":{"type":"string","description":"Número do COO - Contador de Ordem de Operação. Cupom Fiscal Relacionado."},"nECFRef":{"type":"string","description":"Número de Ordem Sequencial do ECF."},"nrProdutorRural":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","description":"Ação a ser realizada no item na alteração. Pode ser: \"I\" - Incluir o item. \"E\" - Excluir o item."},"nrNumero":{"type":"string","description":"Número da NF relacionada."},"nrSerie":{"type":"string","description":"Série da NF relacionada."},"nrDtEmissao":{"type":"string","description":"Data de emissão da NF relacionada."},"nrCnpjCpf":{"type":"string","description":"CNPJ/CPF do emitente da NF relacionada."},"nrIE":{"type":"string","description":"Inscrição Estadual do emitente da NF relacionada."},"nrUF":{"type":"string","description":"Unidade federativa do emitente da NF relacionada."}}},"description":"Outras notas de produtor rural relacionadas."},"nrNF":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","description":"Ação a ser realizada no item na alteração. Pode ser: \"I\" - Incluir o item. \"E\" - Excluir o item."},"nrChave":{"type":"string","description":"Chave da NF-e, NFC-e ou SAT relacionada."}}},"description":"Outras NF-e, NFC-e ou SAT relacionadas."},"nrCupomFiscal":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","description":"Ação a ser realizada no item na alteração. Pode ser: \"I\" - Incluir o item. \"E\" - Excluir o item."},"nrCOO":{"type":"string","description":"Contador de Ordem de Operação (COO)."},"nrNumeroECF":{"type":"string","description":"Número do ECF."}}},"description":"Outros cupons fiscais relacionados."},"nrModelo1_1A":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","description":"Ação a ser realizada no item na alteração. Pode ser: \"I\" - Incluir o item. \"E\" - Excluir o item."},"nrNumero":{"type":"string","description":"Número da NF relacionada."},"nrSerie":{"type":"string","description":"Série da NF relacionada."},"nrDtEmissao":{"type":"string","description":"Data de emissão da NF relacionada."},"nrCnpjCpf":{"type":"string","description":"CNPJ/CPF do emitente da NF relacionada."},"nrUF":{"type":"string","description":"Unidade federativa do emitente da NF relacionada."}}},"description":"Outras notas modelo 1/1A relacionadas."},"cSigNFRef":{"type":"string","description":"Manter o sigilo da NF-e referenciada. Preencher com \"S\" ou \"N\". Default \"N\"."}},"description":"Detalhes da NF referenciada."},"infAdicFisco":{"type":"object","properties":{"cRegimeEsp":{"type":"string","description":"Possui regime especial S/N."},"cObsSped":{"type":"string","description":"Observação para uso exclusivo do SPED (Registro C110). (Necessário preencher campo cRegimeEsp \"S\" para alterar esta informação)."},"cInfAdic":{"type":"string","description":"Informações Adicionais de interesse do Fisco para a Nota Fiscal."}},"description":"Informações adicionais de interesse do fisco."}}},"email":{"type":"object","properties":{"cEmail":{"type":"string","description":"E-mail do cliente."}}},"obs":{"type":"object","properties":{"cObs":{"type":"string","description":"Observações da Remessa."}}},"totais":{"type":"object","properties":{"nMercadorias":{"type":"decimal","description":"Total de mercadorias."},"nDescontos":{"type":"decimal","description":"Total de descontos."},"nIPI":{"type":"decimal","description":"Total de IPI."},"nICMSST":{"type":"decimal","description":"Total de ICMS ST."},"nTotalNotaEnt":{"type":"decimal","description":"Valor total da nota de entrada."},"nTotIbsUf":{"type":"decimal"},"nTotIbsMun":{"type":"decimal"},"nTotIbs":{"type":"decimal"},"nTotCbs":{"type":"decimal"},"nTotIbsCbsIs":{"type":"decimal"}},"description":"Totais da nota de entrada."},"produtos":{"type":"array","items":{"type":"object","properties":{"nCodIt":{"type":"integer","description":"Código do item da nota de entrada Não informar na inclusão preenchimento automático. Informe esse campo na alteração somente quando cCodItInt não for informado. Esse campo não é exibido na tela é uma informação interna, utilizada apenas nas APIs."},"cCodItInt":{"type":"string","description":"Código de integração do item da nota de entrada Preencha esse campo com o código do item do pedido no aplicativo que você está integrando com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de itens de pedidos você conseguirá ver a relação entre o id do item do pedido gerado no Omie e o código de item de pedido existente em sua aplicação."},"nCodProd":{"type":"integer","description":"ID do Produto. Informe esse campo somente quando cCodProdInt não for informado. Esse campo não é exibido na tela do pedido. É uma informação interna, utilizada apenas nas APIs. Utilize a tag \"codigo_produto\" do método \"ListarProdutos\" da API http://app.omie.com.br/api/v1/geral/produtos/ para obter essa informação."},"cCodProdInt":{"type":"string","description":"Código de integração do produto. Informe esse campo somente quando nCodProd não for informado. Esse campo deve ser informado apenas se você incluiu o produto via API e informou um código de integração para o produto. Do contrário, informe sempre a tag \"nCodProd\"."},"cCFOP":{"type":"string","description":"CFOP - Código Fiscal de Operações e Prestações. Utilize a tag \"nCodigo\" do método \"ListarCFOP\" da API http://app.omie.com.br/api/v1/produtos/cfop/ para obter essa informação. Obrigatório na operação \"IncluirNotaEnt\"; obrigatório também em \"AlterarNotaEnt\" apenas quando o item for novo (`cAcaoItem = \"I\"`) — opcional ao alterar ou excluir um item já existente."},"nQtde":{"type":"decimal","description":"Quantidade."},"nValUnit":{"type":"decimal","description":"Valor unitário."},"cNCM":{"type":"string","description":"NCM - Nomenclatura Comum do Mercosul Utilize a tag \"cCodigo\" do método \"ListarNCM\" da API http://app.omie.com.br/api/v1/produtos/ncm/ para obter essa informação."},"cEAN":{"type":"string","description":"EAN - European Article Number."},"nDesconto":{"type":"decimal","description":"Valor do desconto."},"ICMS":{"type":"object","properties":{"cSitTrib":{"type":"string","description":"Situação Tributária do ICMS."},"cOrigem":{"type":"string","description":"Origem."},"cModBC":{"type":"string","description":"Modalidade da BC do ICMS."},"nRedBC":{"type":"decimal","description":"Redução da BC do ICMS (%)."},"nBC":{"type":"decimal","description":"Base de Calculo do ICMS."},"nAliq":{"type":"decimal","description":"Alíquota de ICMS."},"nValor":{"type":"decimal","description":"Valor do ICMS."},"nBCRet":{"type":"decimal","description":"Base de Cálculo do ICMS Retido."},"nAliqCN":{"type":"decimal","description":"Alíquota Suportada pelo Cons. Final."},"nValorRetST":{"type":"decimal","description":"Valor do ICMS Retido por ST."},"nValorDif":{"type":"decimal","description":"Valor do ICMS Diferido."},"nValorICMD":{"type":"decimal","description":"Valor do ICMS Desonerado."},"nValorICMOP":{"type":"decimal","description":"Valor do ICMS Oper. Própria."},"cMotDeson":{"type":"string","description":"Motivo da Desoneração do ICMS Pode ser: 01 - Táxi 03 - Produtor Agropecuário 04 - Frotista/Locadora 05 - Diplomático/Consular 06 - Utilitários e Motocicletas da Amazônia Ocidental e Áreas de Livre Comércio (Resolução 714/88 e 790/94 – CONTRAN e suas alterações) 07 - SUFRAMA 08 - Venda a Órgão Público 09 - Outros. (NT 2011/004) 10 - Deficiente Condutor (Convênio ICMS 38/12) 11 - Deficiente Não Condutor (Convênio ICMS 38/12) 16 - Olimpíadas Rio 2016 90 - Solicitado pelo Fisco."},"nPercDif":{"type":"decimal","description":"Percentual do Diferimento (%)."}}},"ICMS_ST":{"type":"object","properties":{"cModBCST":{"type":"string","description":"Modalidade da Base de Cálculo do ICMS Substituição Tributária."},"nMargVrAd":{"type":"decimal","description":"Margem de Valor Adicionado (%)."},"nRedBCST":{"type":"decimal","description":"Redução da BC do ICMS ST (%)."},"nBCST":{"type":"decimal","description":"Base de Cálculo do ICMS ST."},"nAliqST":{"type":"decimal","description":"Alíquota do ICMS ST (%)."},"nAliqOP":{"type":"decimal","description":"Alíq. do ICMS Oper. Própria (%)."},"nValorST":{"type":"decimal","description":"Valor do ICMS ST."}}},"ICMS_SN":{"type":"object","properties":{"cSitTribSN":{"type":"string","description":"Situação Tributária do ICMS."},"cOrigem":{"type":"string","description":"Origem."},"nAliqCredSN":{"type":"decimal","description":"Alíq. de Cálculo de Crédito (%)."},"nCredSN":{"type":"decimal","description":"Crédito do ICMS Aproveitado."},"nBCSNST":{"type":"decimal","description":"Base de Cálculo do ICMS Retido."},"nValorSNST":{"type":"decimal","description":"Valor do ICMS Retido por ST."},"cModBCSN":{"type":"string","description":"Modalidade da BC do ICMS."},"nAliqRedBCSN":{"type":"decimal","description":"Redução da BC do ICMS (%)."},"nBCSN":{"type":"decimal","description":"Base de Cálculo do ICMS."},"nAliqSN":{"type":"decimal","description":"Alíquota do ICMS (%)."},"nValorSN":{"type":"decimal","description":"Valor do ICMS."}}},"ICMS_INTER":{"type":"object","properties":{"nBCUFDest":{"type":"decimal","description":"Base de Cálculo ICMS na UF de Destino."},"nValorFCPUFDest":{"type":"decimal","description":"Valor do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de Destino."},"nAliqICMSUFDest":{"type":"decimal","description":"Alíquota Interna da UF de Destino."},"nICMSInter":{"type":"decimal","description":"Alíquota Interestadual das UFs Envolvidas."},"nRedICMSUFDest":{"type":"decimal","description":"Alíquota Redução Base ICMS da UF Destino."},"nPercFCPUFDest":{"type":"decimal","description":"Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de Destino."},"nValorICMSUFDest":{"type":"decimal","description":"Valor do ICMS - UF Destino."},"nICMSUFRemet":{"type":"decimal","description":"Valor do ICMS - UF Remetente."}},"description":"Informações do ICMS Interestadual."},"IPI":{"type":"object","properties":{"cSitTribIPI":{"type":"string","description":"Situação Tributária do IPI."},"cTpCalcIPI":{"type":"string","description":"Tipo de Cálculo para obter o IPI."},"nBCIPI":{"type":"decimal","description":"Base de Cálculo do IPI."},"cEnqIPI":{"type":"string","description":"Enquadramento do IPI."},"nAliqIPI":{"type":"decimal","description":"Alíquota do IPI (%)."},"nQtdUTIPI":{"type":"decimal","description":"Qtd Unidades Tributáveis."},"nValIPIUT":{"type":"decimal","description":"Valor do IPI por Unid. Tributável."},"nValIPI":{"type":"decimal","description":"Valor do IPI."}}},"PIS":{"type":"object","properties":{"cSitTribPIS":{"type":"string","description":"Situação Tributária doPIS."},"cTpCalcPIS":{"type":"string","description":"Tipo de Cálculo para obter o PIS."},"nBCPIS":{"type":"decimal","description":"Base de Cálculo do PIS."},"nAliqPIS":{"type":"decimal","description":"Alíquota do PIS (%)."},"nQtdUTPIS":{"type":"decimal","description":"Qtd Unidades Tributáveis."},"nValPISUT":{"type":"decimal","description":"Valor do PIS por Unid. Tributável."},"nValPIS":{"type":"decimal","description":"Valor do PIS."},"nPercRedBCPIS":{"type":"decimal","description":"Percentual de Redução da Base de Cálculo do PIS."}}},"COFINS":{"type":"object","properties":{"cSitTribCOFINS":{"type":"string","description":"Situação Tributária do COFINS."},"cTpCalcCOFINS":{"type":"string","description":"Tipo de Cálculo para obter o COFINS."},"nBCCOFINS":{"type":"decimal","description":"Base de Cálculo do COFINS."},"nAliqCOFINS":{"type":"decimal","description":"Alíquota do COFINS (%)."},"nQtdUTCOFINS":{"type":"decimal","description":"Qtd Unidades Tributáveis."},"nVaCOFINSSUT":{"type":"decimal","description":"Valor do COFINS Unid. Tributável."},"nValCOFINS":{"type":"decimal","description":"Valor do COFINS."},"nPercRedBCCOFINS":{"type":"decimal","description":"Percentual de Redução da Base de Cálculo do COFINS."}}},"infAdicItem":{"type":"object","properties":{"nPesoLiq":{"type":"decimal","description":"Peso líquido (Kg)."},"nPesoBruto":{"type":"decimal","description":"Peso bruto (Kg)."},"cPedCompra":{"type":"string","description":"Número do pedido de compra."},"nItemPedCompra":{"type":"integer","description":"Item do pedido de compra."},"cInfItemNF":{"type":"string","description":"Informações para a nota fiscal."},"cNaoMovEstoque":{"type":"string","description":"Não gerar a saída de estoque deste item ao emitir NF-e. Informar \"S\" ou \"N\". (informe \"S\" para ativar essa opção)."},"cCodBenef":{"type":"string","description":"Código de Beneficiário Fiscal na UF aplicado ao item."},"numero_recopi":{"type":"string","description":"Número do registro gerado pelo sistema RECOPI Nacional (Reconhecimento e Controle das Operações com Papel Imune)."}}},"cCest":{"type":"string","description":"CEST."},"rastreabilidade":{"type":"object","properties":{"numeroLote":{"type":"string","description":"Número do Lote."},"qtdeProdutoLote":{"type":"decimal","description":"Quantidade de Produto."},"dataFabricacaoLote":{"type":"string","description":"Data de Fabricação/Produção."},"dataValidadeLote":{"type":"string","description":"Data de Validade."},"codigoAgregacaoLote":{"type":"string","description":"Código de Agregação."}},"description":"Rastreabilidade do produto."},"codigo_local_estoque":{"type":"integer","description":"Código do local do estoque. Caso não preenchido assumirá o local de estoque padrão."},"codigo_local_estoque_saida":{"type":"integer","description":"Código do local do estoque saída. Este é o local de estoque de saída do cliente ou fornecedor (terceiro). Ao concluir a nota de entrada, o sistema poderá criar automaticamente a saída de estoque neste local."},"medicamentos":{"type":"object","properties":{"cCodigoAnvisa":{"type":"string","description":"Código ANVISA. O \"Código de Produto da ANVISA\" deve possuir 13 caractéres."},"nValMaxCons":{"type":"decimal","description":"Preço máximo consumidor. Preço máximo deve ser maior ou igual a zero."}},"description":"Detalhamento específico para medicamentos."},"veiculos":{"type":"object","properties":{"cTipoOpVeiculo":{"type":"string","description":"Veículos - Tipo da Operação Pode ser: 1 - Venda concessionária 2 - Faturamento direto para consumidor final 3 - Venda direta para grandes consumidores (frotista, governo, ...) 0 - Outros."},"cChassiVeiculo":{"type":"string","description":"Veículos - Chassi do Veículo."},"cCondVinVeiculo":{"type":"string","description":"Veículos - Condição do VIN Pode ser: R - Remarcado N - Normal."},"cModAnoFabrVeiculo":{"type":"string","description":"Veículos - Ano Modelo de Fabricação."},"cAnoFabrVeiculo":{"type":"string","description":"Veículos - Ano de Fabricação."},"cEspecieVeiculo":{"type":"string","description":"Veículos - Espécie de Veículo Pode ser: 1 - PASSAGEIRO 2 - CARGA 3 - MISTO 4 - CORRIDA 5 - TRAÇÃO 6 - ESPECIAL."},"cTipoVeiculo":{"type":"string","description":"Veículos - Tipo de Veículo Pode ser: 02 - CICLOMOTO 03 - MOTONETA 04 - MOTOCICLO 05 - TRICICLO 06 - AUTOMÓVEL 07 - MICROÔNIBUS 08 - ÔNIBUS 10 - REBOQUE 11 - SEMIRREBOQUE 13 - CAMINHONETA 14 - CAMINHÃO 17 - C. TRATOR 22 - ESP/ÔNIBUS 23 - MISTO/CAM 24 - CARGA/CAM."},"potenciaMotor":{"type":"object","properties":{"cPotenciaVeiculo":{"type":"string","description":"Veículos - Potência Motor (CV)."},"cCilindradasVeiculo":{"type":"string","description":"Veículos - Cilindradas."},"cTipoCombVeiculo":{"type":"string","description":"Veículos - Tipo de Combustível Pode ser: 01 - Álcool 02 - Gasolina 03 - Diesel 16 - Álcool/Gasolina 17 - Gasolina/Álcool/GNV 18 - Gasolina/Elétrico 04 - Gasogênio 05 - Gás Metano 06 - Elétrico/Fonte Interna 07 - Elétrico/Fonte Externa 08 - Gasolina/Gás Natural Combustív 09 - Álcool/Gás Natural Combustível 10 - Diesel/Gas Natural Combustível 11 - Vide/Campo/Observação 12 - Álcool/Gás Natural Veicular 13 - Gasolina/Gás Natural Veicular 14 - Diesel/Gás Natural Veicular 15 - Gás Natural Veicular 19 - Gasolina/Álcool/Elétrico 20 - Gás Natural Liquefeito 21 - Diesel/Elétrico 22 - Híbrido 23 - Híbrido Plug-in 24 - Elétrico 25 - Célula Combustível 26 - Híbrido/Gás Natural Veicular 27 - Etanol/Elétrico."},"cNumMotorVeiculo":{"type":"string","description":"Veículos - Número de Motor."}},"description":"Dados específico para veículos novos - Potência, Combustível e Motor."},"pinturaCor":{"type":"object","properties":{"cTipoPinVeiculo":{"type":"string","description":"Veículos - Tipo de Pintura."},"cCodCorDENATRANVeiculo":{"type":"string","description":"Veículos - Código da Cor (DENATRAN) Pode ser: 01 - AMARELO 02 - AZUL 03 - BEGE 04 - BRANCA 05 - CINZA 06 - DOURADA 07 - GRENÁ 08 - LARANJA 09 - MARROM 10 - PRATA 11 - PRETA 12 - ROSA 13 - ROXA 14 - VERDE 15 - VERMELHA 16 - FANTASIA."},"cCodCorMontVeiculo":{"type":"string","description":"Veículos - Código da Cor da Montadora."},"cDescMontVeiculo":{"type":"string","description":"Veículos - Descrição da Cor da Montadora."}},"description":"Dados específico para veículos novos - Pintura e Cor."},"outrasInfVeiculo":{"type":"object","properties":{"cCodMarcaModVeiculo":{"type":"string","description":"Veículos - Código Marca Modelo."},"cSerialVeiculo":{"type":"string","description":"Veículos - Serial (série)."},"cMaxTracaoVeiculo":{"type":"string","description":"Veículos - Capacidade Máxima de Tração."},"cDisEixosVeiculo":{"type":"string","description":"Veículos - Distância entre Eixos."},"cCondVeiVeiculo":{"type":"string","description":"Veículos - Condição do Veículo Pode ser: 1 - Acabado 2 - Inacabado 3 - Semiacabado."},"cMaxLotVeiculo":{"type":"string","description":"Veículos - Capacidade máxima de lotação."},"cRestVeiculo":{"type":"string","description":"Veículos - Restrição Pode ser: 0 - Não há 1 - Alienação Fiduciária 2 - Arrendamento Mercantil 3 - Reserva de Domínio 4 - Penhor de Veículos 9 - Outras."},"cPesoBrutoVeiculo":{"type":"string","description":"Veículos - Peso Bruto (toneladas)."},"cPesoLiqVeiculo":{"type":"string","description":"Veículos - Peso Líquido (toneladas)."}},"description":"Dados específico para veículos novos - Outras informações."}},"description":"Dados específico para veículos novos."},"combustivel":{"type":"object","properties":{"cCodigoANP":{"type":"string","description":"Combustíveis - Código de produto da ANP."},"cDescrANP":{"type":"string","description":"Combustíveis - Descrição do Produto conforme ANP."},"cCODIF":{"type":"string","description":"Combustíveis - Código de autorização / registro do CODIF."},"nPercGLP":{"type":"decimal","description":"Combustíveis - Percentual de Gás Natural para o produto GLP."},"nPercGasNacional":{"type":"decimal","description":"Combustíveis - Percentual de Gás Natural Nacional."},"nPercGasImportado":{"type":"decimal","description":"Combustíveis - Percentual de Gás Natural Importado."},"nValorPartida":{"type":"decimal","description":"Combustíveis - Valor de Partida."},"nQtdeFatTempAmb":{"type":"decimal","description":"Combustíveis - Quantidade de combustível faturada à temperatura ambiente."},"cUFConsumoComb":{"type":"string","description":"Combustíveis - Sigla da UF de consumo."},"nBC_CIDE":{"type":"decimal","description":"Combustíveis - Base de Cálculo (em quantidade) da CIDE."},"nAliquota_CIDE":{"type":"decimal","description":"Combustíveis - Valor da Alíquota em Reais da CIDE."},"nValor_CIDE":{"type":"decimal","description":"Combustíveis - Valor da CIDE."}},"description":"Detalhamento específico de combustíveis."},"custos":{"type":"object","properties":{"cICMSCusto":{"type":"string","description":"ICMS é custo de estoque. Informar \"S\" ou \"N\"."},"cPISCusto":{"type":"string","description":"PIS é custo de estoque. Informar \"S\" ou \"N\"."},"cICMSSTCusto":{"type":"string","description":"ICMS ST é custo de estoque. Informar \"S\" ou \"N\"."},"cCOFINSCusto":{"type":"string","description":"COFINS é custo de estoque. Informar \"S\" ou \"N\"."},"cIPICusto":{"type":"string","description":"IPI é custo de estoque. Informar \"S\" ou \"N\"."},"cFreteCusto":{"type":"string","description":"Frete é custo de estoque. Informar \"S\" ou \"N\"."},"cSeguroCusto":{"type":"string","description":"Seguro é custo de estoque. Informar \"S\" ou \"N\"."},"cOutrosDespCusto":{"type":"string","description":"Outras Desp. é custo de estoque. Informar \"S\" ou \"N\"."},"nValorICMSSTCusto":{"type":"decimal","description":"Valor do ICMS ST."},"nAliqCredPISCusto":{"type":"decimal","description":"% Alíq. de Crédito do PIS"},"nAliqCredCOFINSCusto":{"type":"decimal","description":"% Alíq. de Crédito do COFINS"}},"description":"Custos de estoque do item da nota de entrada."},"cAcaoItem":{"type":"string","description":"Ação a ser realizada no item. Pode ser: \"A\" - Alterar o item. \"E\" - Excluir o item. \"I\" - Incluir o item. Obrigatório na operação \"AlterarNotaEnt\"; opcional em \"IncluirNotaEnt\" (assume \"I\" como padrão, já que toda inclusão de nota implica itens novos)."},"lote_validade":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","description":"Id do Lote do produto. Obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.."},"nQtdLote":{"type":"decimal","description":"Informe aqui a quantidade do lote para o produto. É obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações."},"cNumLote":{"type":"string","description":"Número do lote do produto. Deve ser informado apenas quando a tag [nIdLote] não for informada, com isso, será criado um novo lote a partir do número informado."},"cCodAgreg":{"type":"string","description":"Código de agregação do lote do produto. Deve ser informado apenas quando a tag [nIdLote] não for informada."},"dDataFab":{"type":"string","description":"Data de fabricação do lote. Deve ser informado apenas quando a tag [nIdLote] não for informada. Como default é utilizado a data atual."},"dDataVal":{"type":"string","description":"Data de validade do lote. Deve ser informado apenas quando a tag [nIdLote] não for informada."}}},"description":"Informações referentes ao lote e validade do produto. A tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes \"manualmente\" por API."},"IBS_CBS":{"type":"object","properties":{"cCstIbsCbs":{"type":"string","description":"Código de Situação Tributária do IBS e CBS."},"cClassTrib":{"type":"string","description":"Código de Classificação Tributária do IBS e CBS."},"nBaseIbsCbs":{"type":"decimal","description":"Base de cálculo do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será calculado automaticamente."}}},"IBS":{"type":"object","properties":{"nAliqIbsUf":{"type":"decimal","description":"Alíquota do IBS de competência das UF."},"nPercDiferimentoIbsUf":{"type":"decimal","description":"Percentual do Diferimento - IBS UF."},"nPercReducaoIbsUf":{"type":"decimal","description":"Percentual da redução de alíquota - IBS UF."},"nValDiferimentoIbsUf":{"type":"decimal","description":"Valor do Diferimento - IBS UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será calculado automaticamente."},"nValIbsUf":{"type":"decimal","description":"Valor do IBS de competência da UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será calculado automaticamente."},"nAliqIbsMun":{"type":"decimal","description":"Alíquota do IBS de competência do Município."},"nPercDiferimentoIbsMun":{"type":"decimal","description":"Percentual do diferimento - UBS Município."},"nPercReducaoIbsMun":{"type":"decimal","description":"Percentual da redução de alíquota - IBS Município."},"nValDiferimentoIbsMun":{"type":"decimal","description":"Valor do Diferimento - IBS Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será calculado automaticamente."},"nValIbsMun":{"type":"decimal","description":"Valor do IBS de competência do Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será calculado automaticamente."},"nValIbs":{"type":"decimal","description":"Valor total do IBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será calculado automaticamente."}}},"CBS":{"type":"object","properties":{"nAliqCbs":{"type":"decimal","description":"Alíquota da CBS."},"nPercDiferimentoCbs":{"type":"decimal","description":"Percentual do diferimento - CBS."},"nPercReducaoCbs":{"type":"decimal","description":"Percentual da redução de alíquota - CBS."},"nValDiferimentoCbs":{"type":"decimal","description":"Valor do diferimento - CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será calculado automaticamente."},"nValCbs":{"type":"decimal","description":"Valor da CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será calculado automaticamente."}}},"TRIB_REG":{"type":"object","properties":{"cCstIbsCbsReg":{"type":"string","description":"Código da Situação Tributária do IBS e CBS (Tributação Regular)."},"cClassTribReg":{"type":"string","description":"Código de Classificação Tributária do IBS e CBS (Tributação Regular)."},"nAliqIbsUfReg":{"type":"decimal","description":"Valor da alíquota do IBS da UF na tributação regular."},"nAliqIbsMunReg":{"type":"decimal","description":"Valor da alíquota do IBS do Município na tributação regular."},"nAliqCbsReg":{"type":"decimal","description":"Valor da alíquota da CBS na tributação regular."},"nValIbsUfReg":{"type":"decimal","description":"Valor do Tributo do IBS da UF na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será calculado automaticamente."},"nValIbsMunReg":{"type":"decimal","description":"Valor do Tributo do IBS do Município na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será calculado automaticamente."},"nValCbsReg":{"type":"decimal","description":"Valor do Tributo da CBS na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será calculado automaticamente."}}}}}},"departamentos":{"type":"array","items":{"type":"object","properties":{"cCodDepto":{"type":"string","description":"Código do Departamento - Preenchimento obrigatório. Informação localizada na Aba \"Departamentos\" da Nota de Entrada. Utilize a tag \"codigo\" do método \"ListarDepatartamentos\" da API /api/v1/geral/departamentos/ para obter essa informação."},"nValor":{"type":"decimal","description":"Valor do rateio - Preenchimento obrigatório. Informação localizada na Aba \"Departamentos\" da Nota de Entrada."},"nPerc":{"type":"decimal","description":"Percentual do rateio - Preenchimento obrigatório. Informação localizada na Aba \"Departamentos\" da Nota de Entrada."}}}}},"title":"ConsultarNotaEnt (retorno)"},"produtos_notaentrada_ExcluirNotaEnt":{"type":"object","title":"ExcluirNotaEnt","description":"Excluir nota de entrada.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirNotaEnt"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodNotaEnt":{"type":"integer","maxLength":15,"description":"ID da nota de entrada."},"cCodIntNotaEnt":{"type":"string","maxLength":20,"description":"Código de integração da nota de entrada."}}}}},"example":{"call":"ExcluirNotaEnt","param":[{"nCodNotaEnt":112233}]}},"produtos_notaentrada_ExcluirNotaEnt_retorno":{"type":"object","properties":{"nCodNotaEnt":{"type":"integer","description":"ID da nota de entrada. Esse campo não é exibido na tela. É uma informação interna, utilizada apenas nas APIs."},"cCodIntNotaEnt":{"type":"string","description":"Código de integração da nota de entrada. Preencha esse campo com o código da nota de entrada no aplicativo que você está integrando com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de notas de entrada você conseguirá ver a relação entre o id da nota de entrada gerado no Omie e o código de nota de entrada existente em sua aplicação."},"cCodStatus":{"type":"string","description":"Código do status."},"cDescStatus":{"type":"string","description":"Descrição do status."}},"title":"ExcluirNotaEnt (retorno)"},"produtos_notaentrada_IncluirNotaEnt":{"type":"object","title":"IncluirNotaEnt","description":"Incluir nota de entrada.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirNotaEnt"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cabec":{"type":"object","properties":{"nCodNotaEnt":{"type":"integer","maxLength":15,"description":"Código da Nota de Entrada no Omie\n\n\nEsse campo não é exibido na tela é uma informação interna, utilizada apenas nas APIs."},"cCodIntNotaEnt":{"type":"string","maxLength":20,"description":"Código de Integração da Nota de Entrada\n\n\n\nPreencha esse campo com o código da nota de entrada no aplicativo que você está integrando com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de notas de entrada você conseguirá ver a relação entre o id da nota de entrada gerado no Omie e o código de pedido existente em sua aplicação."},"nCodCli":{"type":"integer","maxLength":15,"description":"Código do cliente.\n\nPreencher quando não for informado cCodIntCli.\nNão preencher quando informado cCodIntCli.\n\nUtilize a tag \"codigo_cliente_omie\" do método \"ListarClientes\" da API\nhttp://app.omie.com.br/api/v1/geral/clientes/\npara obter essa informação."},"cCodIntCli":{"type":"string","maxLength":60,"description":"Código de Integração do Cliente\n\nPreencher quando não for informado nCodCli.\nNão preencher quando informado nCodCli.\n\nEsse campo deve ser informado apenas se você incluiu o cliente via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag nCodCli."},"dPrevisao":{"type":"string","maxLength":10,"description":"Data de previsão de faturamento.\n\n\nUtilize o formato \"dd/mm/aaaa\".\n\nEsse campo indica a data da previsão do faturamento do pedido e deve ser informado com uma data igual ou superior a data corrente.\n\nObrigatório na operação \"IncluirNotaEnt\"; opcional nas demais operações que\nreutilizam esta estrutura, como \"AlterarNotaEnt\"."},"nCodVend":{"type":"integer","maxLength":15,"description":"Código do vendedor\n\n\nUtilize a tag \"codigo\" do método \"ListarVendedores\" da API\nhttp://app.omie.com.br/api/v1/geral/vendedores para obter essa informação."},"cNumeroNotaEnt":{"type":"string","maxLength":15,"description":"Número da noata de entrada exibido na tela.\n\n\nDisponível apenas na consulta/listagem como retorno de informação."},"cGeraFinanceiro":{"type":"string","maxLength":1,"description":"Gerar movimentação financeira para a nota de entrada.\n\n\nInformar \"S\" ou \"N\"."},"cCodParc":{"type":"string","maxLength":3,"description":"Código da Condição de Pagamento/Parcelamento."},"nQtdeParc":{"type":"integer","maxLength":3,"description":"Quantidade de parcelas a serem geradas quando a condição de pagamento informada for \"999\"."}}},"frete":{"type":"object","properties":{"nCodTransp":{"type":"integer","maxLength":15,"description":"Código da transportadora\n\n\nEsse campo não é exibido na tela do pedido.\nÉ uma informação interna, utilizada apenas nas APIs.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido.\n\nUtilize a tag \"codigo_cliente_omie\" do método \"ListarClientes\" da API\nhttp://app.omie.com.br/api/v1/geral/clientes/\npara obter essa informação.\n\nOBS: O Omie uitliza o cadastro de clientes para registrar também fornecedores e transportadoras."},"cTpFrete":{"type":"string","maxLength":1,"description":"Tipo de frete.\n\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do pedido.\n\nValores disponíveis:\n\n\"0\" - Frete por conta do emitente.\n\"1\" - Frete por conta do destinatário.\n\"2\" - Frete por conta de terceiros.\n\"9\" - Sem frete."},"cPlaca":{"type":"string","maxLength":7,"description":"Placa do veículo.\n\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do pedido."},"cUF":{"type":"string","maxLength":2,"description":"Estado da placa do veículo.\n\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido."},"nQtdVol":{"type":"integer","maxLength":15,"description":"Quantidade de volumes\n\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido."},"cEspVol":{"type":"string","maxLength":60,"description":"Espécie de volume.\n\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido."},"cMarVol":{"type":"string","maxLength":60,"description":"Marca dos volumes.\n\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido."},"cNumVol":{"type":"string","maxLength":60,"description":"Numeração dos volumes.\n\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do pedido."},"nPesoLiq":{"type":"number","maxLength":18,"description":"Peso líquído (Kg)\n\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do pedido."},"nPesoBruto":{"type":"number","maxLength":18,"description":"Peso bruto (Kg)\n\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do pedido."},"nValFrete":{"type":"number","maxLength":18,"description":"Valor do frete\n\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do pedido."},"nValSeguro":{"type":"number","maxLength":18,"description":"Valor do seguro\n\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do pedido."},"nValOutras":{"type":"number","maxLength":18,"description":"Valor de outras despesas acessórias.\n\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do pedido."},"cNumeroLacre":{"type":"string","maxLength":60,"description":"Número dos Lacres."},"cRegistroTransp":{"type":"string","maxLength":20,"description":"RNTRC (ANTT) - Registro de transporte."},"cVeiculoProprio":{"type":"string","maxLength":1,"description":"O transporte será realizado com veículo próprio.\n\nInformar \"S\" ou \"N\".\n\nInformação localizada na Aba \"Frete e Outras Despesas\"."}}},"infAdic":{"type":"object","properties":{"cCodCateg":{"type":"string","maxLength":20,"description":"Código da categoria.\n\n\nInformação localizada na Aba \"Informações Adicionais\" do pedido.\n\nUtilize a tag \"codigo\" do método \"ListarCategorias\" da API\nhttp://app.omie.com.br/api/v1/geral/categorias/\npara obter essa informação.\n\nObrigatório na operação \"IncluirNotaEnt\"; opcional nas demais operações que\nreutilizam esta estrutura, como \"AlterarNotaEnt\"."},"cContato":{"type":"string","maxLength":100,"description":"Contato.\n\n\nInformação localizada na Aba \"Informações Adicionais\" do pedido."},"nCodProj":{"type":"integer","maxLength":15,"description":"Código do projeto.\n\n\nInformação localizada na Aba \"Informações Adicionais\" do pedido.\n\nUtilize a tag \"codigo\" do método \"ListarProjetos\" da API\nhttp://app.omie.com.br/api/v1/geral/projetos/\npara obter essa informação."},"cPedido":{"type":"string","maxLength":30,"description":"Número do pedido do cliente.\n\n\nInformação localizada na Aba \"Informações Adicionais\" do pedido."},"outrosDet":{"type":"object","properties":{"dDataSaida":{"type":"string","maxLength":10,"description":"Data de entrada/saída."},"cHoraSaida":{"type":"string","maxLength":8,"description":"Hora de entrada/saída."},"cNatOperacao":{"type":"string","maxLength":60,"description":"Natureza de operação."},"indIntermediario":{"type":"string","maxLength":1,"description":"Indicador de Intermediador.\n\n\nEsta informação deverá ser enviada quando se tratar de uma operação não presencial.\n\nOpções disponíveis:\n0=Operação sem intermediador(em site ou plataforma própria)\n1=Operação em site ou plataforma de terceiros(intermediadores/marketplace)\n\nSe não informado, utilizaremos automaticamente a opção \"0-Operação sem intermediador(em site ou plataforma própria)\".\n\nInformação localizada na Aba \"Informações Adicionais\"."},"indPresenca":{"type":"string","maxLength":1,"description":"Indicador de Presença da Operação."},"identIntermediario":{"type":"string","maxLength":60,"description":"Identificação no Intermediador.\n\n\nEste identificador pode ser o nome do usuário ou identificação do perfil do vendedor no site do intermediador.\n\nInformação localizada na Aba \"Informações Adicionais\"."},"cnpjIntermediario":{"type":"string","maxLength":20,"description":"CNPJ do Intermediador.\n\nPreencimento obrigatório caso o Indicador de Intermediador seja igual a opção \"1-Operação em site ou plataforma de terceiros(intermediadores/marketplace)\".\n\nEste campo representa o CNPJ do Intermediador da Transação.\n\nInformação localizada na Aba \"Informações Adicionais\"."},"infCanaAcucar":{"type":"object","properties":{"cSafra":{"type":"string","maxLength":9,"description":"Safra."},"cPerRef":{"type":"string","maxLength":7,"description":"Mês e Ano de referência da Safra de Cana-de-acúçar."},"nQuantMes":{"type":"number","description":"Quantidade total de fornecimento de cana-de-açúcar no período."},"nQuantAnt":{"type":"number","description":"Quantidade do fornecimento de cana-de-açúcar no período anterior."},"nQuantTot":{"type":"number","description":"Quantidade total atualizada do fornecimento de cana-de-açúcar."},"nValForn":{"type":"number","description":"Valor do fornecimento de cana-de-açúcar."},"nValDed":{"type":"number","description":"Valor total das deduções do período."},"nValLiq":{"type":"number","description":"Valor líquido do fornecimento de cana-de-açúcar."},"QtdDiariaCanaAc":{"type":"array","items":{"type":"object","properties":{"nDia":{"type":"integer","description":"Dia do mês do fornecimento de cana-de-açúcar."},"nQuantDia":{"type":"number","description":"Quantidade diária de fornecimento de cana-de-açúcar."}}},"description":"Registro do fornecimento diário de cana-de-açúcar."},"DeducaoCanaAc":{"type":"array","items":{"type":"object","properties":{"cDescrDed":{"type":"string","maxLength":350,"description":"Descrição da dedução na aquisição de cana-de-açúcar."},"nValorDed":{"type":"number","description":"Valor da dedução."}}},"description":"Deduções na aquisição de cana-de-açúcar."}},"description":"Informações da aquisição de Cana-de-açúcar."}},"description":"Informações adicionais outros detalhes da nota de entrada."},"cDadosAdic":{"type":"string","description":"Dados adicionais para a nota fiscal.\n\n\nUtilize o caracter pipe ( | ) como separador de linha.\n\nInformação localizada na Aba \"Informações Adicionais\" do pedido."},"cConsFinal":{"type":"string","maxLength":1,"description":"Nota fiscal para consumo final.\n\n\nInformar \"S\" ou \"N\".\n\nInformação localizada na Aba \"Informações Adicionais\" do pedido."},"nCodCC":{"type":"integer","maxLength":15,"description":"Código interno da conta corrente da nota fiscal (este é o código da conta corrente no Omie)."},"nfRelacionada":{"type":"object","properties":{"cChaveRef":{"type":"string","maxLength":44,"description":"Chave da NF-e (ou NFC-e ou SAT) Relacionada."},"nNFRef":{"type":"string","maxLength":9,"description":"Número da Nota Fiscal\n\nNota Fiscal Relacionada Modelo 1/1A."},"cSerieRef":{"type":"string","maxLength":3,"description":"Série da NF Referenciada.\n\nNota Fiscal Relacionada Modelo 1/1A."},"dtEmissaoRef":{"type":"string","maxLength":10,"description":"Data de emissão da NF Referenciada.\n\nNota Fiscal Relacionada Modelo 1/1A."},"cnpjEmitRef":{"type":"string","maxLength":20,"description":"CNPJ da Emitente da NF Referenciada.\n\nNota Fiscal Relacionada Modelo 1/1A."},"cUfRef":{"type":"string","maxLength":2,"description":"Estado do Emitente da NF Referenciada.\n\nNota Fiscal Relacionada Modelo 1/1A."},"nNfPR":{"type":"string","maxLength":9,"description":"Número da Nota Fiscal relacionada do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural."},"cSeriePR":{"type":"string","maxLength":3,"description":"Série da NF do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural."},"dtEmissaoPR":{"type":"string","maxLength":10,"description":"Data de emissão da NF do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural."},"cnpjPR":{"type":"string","maxLength":20,"description":"CNPJ/CPF do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural."},"InscrEstPR":{"type":"string","maxLength":20,"description":"Inscrição Estadual do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural."},"cUfPR":{"type":"string","maxLength":2,"description":"Estado do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural."},"nCOORef":{"type":"string","maxLength":6,"description":"Número do COO - Contador de Ordem de Operação.\n\nCupom Fiscal Relacionado."},"nECFRef":{"type":"string","maxLength":3,"description":"Número de Ordem Sequencial do ECF."},"nrProdutorRural":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","maxLength":1,"description":"Ação a ser realizada no item na alteração.\n\nPode ser:\n\n\"I\" - Incluir o item.\n\"E\" - Excluir o item."},"nrNumero":{"type":"string","maxLength":9,"description":"Número da NF relacionada."},"nrSerie":{"type":"string","maxLength":3,"description":"Série da NF relacionada."},"nrDtEmissao":{"type":"string","maxLength":10,"description":"Data de emissão da NF relacionada."},"nrCnpjCpf":{"type":"string","maxLength":20,"description":"CNPJ/CPF do emitente da NF relacionada."},"nrIE":{"type":"string","maxLength":20,"description":"Inscrição Estadual do emitente da NF relacionada."},"nrUF":{"type":"string","maxLength":2,"description":"Unidade federativa do emitente da NF relacionada."}}},"description":"Outras notas de produtor rural relacionadas."},"nrNF":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","maxLength":1,"description":"Ação a ser realizada no item na alteração.\n\nPode ser:\n\n\"I\" - Incluir o item.\n\"E\" - Excluir o item."},"nrChave":{"type":"string","maxLength":44,"description":"Chave da NF-e, NFC-e ou SAT relacionada."}}},"description":"Outras NF-e, NFC-e ou SAT relacionadas."},"nrCupomFiscal":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","maxLength":1,"description":"Ação a ser realizada no item na alteração.\n\nPode ser:\n\n\"I\" - Incluir o item.\n\"E\" - Excluir o item."},"nrCOO":{"type":"string","maxLength":6,"description":"Contador de Ordem de Operação (COO)."},"nrNumeroECF":{"type":"string","maxLength":3,"description":"Número do ECF."}}},"description":"Outros cupons fiscais relacionados."},"nrModelo1_1A":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","maxLength":1,"description":"Ação a ser realizada no item na alteração.\n\nPode ser:\n\n\"I\" - Incluir o item.\n\"E\" - Excluir o item."},"nrNumero":{"type":"string","maxLength":9,"description":"Número da NF relacionada."},"nrSerie":{"type":"string","maxLength":3,"description":"Série da NF relacionada."},"nrDtEmissao":{"type":"string","maxLength":10,"description":"Data de emissão da NF relacionada."},"nrCnpjCpf":{"type":"string","maxLength":20,"description":"CNPJ/CPF do emitente da NF relacionada."},"nrUF":{"type":"string","maxLength":2,"description":"Unidade federativa do emitente da NF relacionada."}}},"description":"Outras notas modelo 1/1A relacionadas."},"cSigNFRef":{"type":"string","maxLength":1,"description":"Manter o sigilo da NF-e referenciada.\n\nPreencher com \"S\" ou \"N\".\n\nDefault \"N\"."}},"description":"Detalhes da NF referenciada."},"infAdicFisco":{"type":"object","properties":{"cRegimeEsp":{"type":"string","maxLength":1,"description":"Possui regime especial S/N."},"cObsSped":{"type":"string","maxLength":10,"description":"Observação para uso exclusivo do SPED (Registro C110).\n\n(Necessário preencher campo cRegimeEsp \"S\" para alterar esta informação)."},"cInfAdic":{"type":"string","maxLength":10,"description":"Informações Adicionais de interesse do Fisco para a Nota Fiscal."}},"description":"Informações adicionais de interesse do fisco."}}},"email":{"type":"object","properties":{"cEmail":{"type":"string","description":"E-mail do cliente."}}},"obs":{"type":"object","properties":{"cObs":{"type":"string","description":"Observações da Remessa."}}},"produtos":{"type":"array","items":{"type":"object","properties":{"nCodIt":{"type":"integer","maxLength":15,"description":"Código do item da nota de entrada\n\nNão informar na inclusão preenchimento automático.\nInforme esse campo na alteração somente quando cCodItInt não for informado.\n\nEsse campo não é exibido na tela é uma informação interna, utilizada apenas nas APIs."},"cCodItInt":{"type":"string","maxLength":20,"description":"Código de integração do item da nota de entrada\n\n\n\nPreencha esse campo com o código do item do pedido no aplicativo que você está integrando com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de itens de pedidos você conseguirá ver a relação entre o id do item do pedido gerado no Omie e o código de item de pedido existente em sua aplicação."},"nCodProd":{"type":"integer","maxLength":15,"description":"ID do Produto.\n\nInforme esse campo somente quando cCodProdInt não for informado.\n\nEsse campo não é exibido na tela do pedido.\nÉ uma informação interna, utilizada apenas nas APIs.\n\nUtilize a tag \"codigo_produto\" do método \"ListarProdutos\" da API\nhttp://app.omie.com.br/api/v1/geral/produtos/\npara obter essa informação."},"cCodProdInt":{"type":"string","maxLength":60,"description":"Código de integração do produto.\n\nInforme esse campo somente quando nCodProd não for informado.\n\nEsse campo deve ser informado apenas se você incluiu o produto via API e informou um código de integração para o produto. Do contrário, informe sempre a tag \"nCodProd\"."},"cCFOP":{"type":"string","maxLength":10,"description":"CFOP - Código Fiscal de Operações e Prestações.\n\n\nUtilize a tag \"nCodigo\" do método \"ListarCFOP\" da API\nhttp://app.omie.com.br/api/v1/produtos/cfop/\npara obter essa informação.\n\nObrigatório na operação \"IncluirNotaEnt\"; obrigatório também em \"AlterarNotaEnt\"\napenas quando o item for novo (`cAcaoItem = \"I\"`) — opcional ao alterar ou excluir\num item já existente."},"nQtde":{"type":"number","maxLength":18,"description":"Quantidade."},"nValUnit":{"type":"number","maxLength":18,"description":"Valor unitário."},"cNCM":{"type":"string","maxLength":13,"description":"NCM - Nomenclatura Comum do Mercosul\n\n\nUtilize a tag \"cCodigo\" do método \"ListarNCM\" da API\nhttp://app.omie.com.br/api/v1/produtos/ncm/\npara obter essa informação."},"cEAN":{"type":"string","maxLength":14,"description":"EAN - European Article Number."},"nDesconto":{"type":"number","maxLength":18,"description":"Valor do desconto."},"ICMS":{"type":"object","properties":{"cSitTrib":{"type":"string","maxLength":2,"description":"Situação Tributária do ICMS."},"cOrigem":{"type":"string","maxLength":1,"description":"Origem."},"cModBC":{"type":"string","maxLength":1,"description":"Modalidade da BC do ICMS."},"nRedBC":{"type":"number","maxLength":10,"description":"Redução da BC do ICMS (%)."},"nBC":{"type":"number","maxLength":18,"description":"Base de Calculo do ICMS."},"nAliq":{"type":"number","maxLength":10,"description":"Alíquota de ICMS."},"nValor":{"type":"number","maxLength":18,"description":"Valor do ICMS."},"nBCRet":{"type":"number","maxLength":18,"description":"Base de Cálculo do ICMS Retido."},"nAliqCN":{"type":"number","maxLength":10,"description":"Alíquota Suportada pelo Cons. Final."},"nValorRetST":{"type":"number","maxLength":18,"description":"Valor do ICMS Retido por ST."},"nValorDif":{"type":"number","maxLength":18,"description":"Valor do ICMS Diferido."},"nValorICMD":{"type":"number","maxLength":18,"description":"Valor do ICMS Desonerado."},"nValorICMOP":{"type":"number","maxLength":18,"description":"Valor do ICMS Oper. Própria."},"cMotDeson":{"type":"string","maxLength":2,"description":"Motivo da Desoneração do ICMS\n\nPode ser:\n\n01 - Táxi\n03 - Produtor Agropecuário\n04 - Frotista/Locadora\n05 - Diplomático/Consular\n06 - Utilitários e Motocicletas da Amazônia Ocidental e Áreas de Livre Comércio (Resolução 714/88 e 790/94 – CONTRAN e suas alterações)\n07 - SUFRAMA\n08 - Venda a Órgão Público\n09 - Outros. (NT 2011/004)\n10 - Deficiente Condutor (Convênio ICMS 38/12)\n11 - Deficiente Não Condutor (Convênio ICMS 38/12)\n16 - Olimpíadas Rio 2016\n90 - Solicitado pelo Fisco."},"nPercDif":{"type":"number","maxLength":10,"description":"Percentual do Diferimento (%)."}}},"ICMS_ST":{"type":"object","properties":{"cModBCST":{"type":"string","maxLength":1,"description":"Modalidade da Base de Cálculo do ICMS Substituição Tributária."},"nMargVrAd":{"type":"number","maxLength":10,"description":"Margem de Valor Adicionado (%)."},"nRedBCST":{"type":"number","maxLength":10,"description":"Redução da BC do ICMS ST (%)."},"nBCST":{"type":"number","maxLength":18,"description":"Base de Cálculo do ICMS ST."},"nAliqST":{"type":"number","maxLength":10,"description":"Alíquota do ICMS ST (%)."},"nAliqOP":{"type":"number","maxLength":10,"description":"Alíq. do ICMS Oper. Própria (%)."},"nValorST":{"type":"number","maxLength":18,"description":"Valor do ICMS ST."}}},"ICMS_SN":{"type":"object","properties":{"cSitTribSN":{"type":"string","maxLength":3,"description":"Situação Tributária do ICMS."},"cOrigem":{"type":"string","maxLength":1,"description":"Origem."},"nAliqCredSN":{"type":"number","maxLength":10,"description":"Alíq. de Cálculo de Crédito (%)."},"nCredSN":{"type":"number","maxLength":18,"description":"Crédito do ICMS Aproveitado."},"nBCSNST":{"type":"number","maxLength":18,"description":"Base de Cálculo do ICMS Retido."},"nValorSNST":{"type":"number","maxLength":18,"description":"Valor do ICMS Retido por ST."},"cModBCSN":{"type":"string","maxLength":1,"description":"Modalidade da BC do ICMS."},"nAliqRedBCSN":{"type":"number","maxLength":10,"description":"Redução da BC do ICMS (%)."},"nBCSN":{"type":"number","maxLength":18,"description":"Base de Cálculo do ICMS."},"nAliqSN":{"type":"number","maxLength":10,"description":"Alíquota do ICMS (%)."},"nValorSN":{"type":"number","maxLength":18,"description":"Valor do ICMS."}}},"ICMS_INTER":{"type":"object","properties":{"nBCUFDest":{"type":"number","maxLength":18,"description":"Base de Cálculo ICMS na UF de Destino."},"nValorFCPUFDest":{"type":"number","maxLength":10,"description":"Valor do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de Destino."},"nAliqICMSUFDest":{"type":"number","maxLength":10,"description":"Alíquota Interna da UF de Destino."},"nICMSInter":{"type":"number","maxLength":10,"description":"Alíquota Interestadual das UFs Envolvidas."},"nRedICMSUFDest":{"type":"number","maxLength":10,"description":"Alíquota Redução Base ICMS da UF Destino."},"nPercFCPUFDest":{"type":"number","maxLength":18,"description":"Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de Destino."},"nValorICMSUFDest":{"type":"number","maxLength":18,"description":"Valor do ICMS - UF Destino."},"nICMSUFRemet":{"type":"number","maxLength":18,"description":"Valor do ICMS - UF Remetente."}},"description":"Informações do ICMS Interestadual."},"IPI":{"type":"object","properties":{"cSitTribIPI":{"type":"string","maxLength":2,"description":"Situação Tributária do IPI."},"cTpCalcIPI":{"type":"string","maxLength":1,"description":"Tipo de Cálculo para obter o IPI."},"nBCIPI":{"type":"number","maxLength":18,"description":"Base de Cálculo do IPI."},"cEnqIPI":{"type":"string","description":"Enquadramento do IPI."},"nAliqIPI":{"type":"number","maxLength":10,"description":"Alíquota do IPI (%)."},"nQtdUTIPI":{"type":"number","maxLength":18,"description":"Qtd Unidades Tributáveis."},"nValIPIUT":{"type":"number","maxLength":18,"description":"Valor do IPI por Unid. Tributável."},"nValIPI":{"type":"number","maxLength":18,"description":"Valor do IPI."}}},"PIS":{"type":"object","properties":{"cSitTribPIS":{"type":"string","maxLength":2,"description":"Situação Tributária doPIS."},"cTpCalcPIS":{"type":"string","maxLength":1,"description":"Tipo de Cálculo para obter o PIS."},"nBCPIS":{"type":"number","maxLength":18,"description":"Base de Cálculo do PIS."},"nAliqPIS":{"type":"number","maxLength":10,"description":"Alíquota do PIS (%)."},"nQtdUTPIS":{"type":"number","maxLength":18,"description":"Qtd Unidades Tributáveis."},"nValPISUT":{"type":"number","maxLength":18,"description":"Valor do PIS por Unid. Tributável."},"nValPIS":{"type":"number","maxLength":18,"description":"Valor do PIS."},"nPercRedBCPIS":{"type":"number","maxLength":10,"description":"Percentual de Redução da Base de Cálculo do PIS."}}},"COFINS":{"type":"object","properties":{"cSitTribCOFINS":{"type":"string","maxLength":2,"description":"Situação Tributária do COFINS."},"cTpCalcCOFINS":{"type":"string","maxLength":1,"description":"Tipo de Cálculo para obter o COFINS."},"nBCCOFINS":{"type":"number","maxLength":18,"description":"Base de Cálculo do COFINS."},"nAliqCOFINS":{"type":"number","maxLength":10,"description":"Alíquota do COFINS (%)."},"nQtdUTCOFINS":{"type":"number","maxLength":18,"description":"Qtd Unidades Tributáveis."},"nVaCOFINSSUT":{"type":"number","maxLength":18,"description":"Valor do COFINS Unid. Tributável."},"nValCOFINS":{"type":"number","maxLength":18,"description":"Valor do COFINS."},"nPercRedBCCOFINS":{"type":"number","maxLength":10,"description":"Percentual de Redução da Base de Cálculo do COFINS."}}},"infAdicItem":{"type":"object","properties":{"nPesoLiq":{"type":"number","maxLength":18,"description":"Peso líquido (Kg)."},"nPesoBruto":{"type":"number","maxLength":18,"description":"Peso bruto (Kg)."},"cPedCompra":{"type":"string","maxLength":15,"description":"Número do pedido de compra."},"nItemPedCompra":{"type":"integer","maxLength":6,"description":"Item do pedido de compra."},"cInfItemNF":{"type":"string","description":"Informações para a nota fiscal."},"cNaoMovEstoque":{"type":"string","maxLength":1,"description":"Não gerar a saída de estoque deste item ao emitir NF-e.\n\nInformar \"S\" ou \"N\".\n(informe \"S\" para ativar essa opção)."},"cCodBenef":{"type":"string","maxLength":10,"description":"Código de Beneficiário Fiscal na UF aplicado ao item."},"numero_recopi":{"type":"string","maxLength":20,"description":"Número do registro gerado pelo sistema RECOPI Nacional (Reconhecimento e Controle das Operações com Papel Imune)."}}},"cCest":{"type":"string","description":"CEST."},"rastreabilidade":{"type":"object","properties":{"numeroLote":{"type":"string","maxLength":20,"description":"Número do Lote."},"qtdeProdutoLote":{"type":"number","maxLength":12,"description":"Quantidade de Produto."},"dataFabricacaoLote":{"type":"string","maxLength":10,"description":"Data de Fabricação/Produção."},"dataValidadeLote":{"type":"string","maxLength":10,"description":"Data de Validade."},"codigoAgregacaoLote":{"type":"string","maxLength":20,"description":"Código de Agregação."}},"description":"Rastreabilidade do produto."},"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do local do estoque.\n\n\nCaso não preenchido assumirá o local de estoque padrão."},"codigo_local_estoque_saida":{"type":"integer","maxLength":15,"description":"Código do local do estoque saída.\n\n\nEste é o local de estoque de saída do cliente ou fornecedor (terceiro). Ao concluir a nota de entrada, o sistema poderá criar automaticamente a saída de estoque neste local."},"medicamentos":{"type":"object","properties":{"cCodigoAnvisa":{"type":"string","maxLength":13,"description":"Código ANVISA.\n\nO \"Código de Produto da ANVISA\" deve possuir 13 caractéres."},"nValMaxCons":{"type":"number","maxLength":15,"description":"Preço máximo consumidor.\n\nPreço máximo deve ser maior ou igual a zero."}},"description":"Detalhamento específico para medicamentos."},"veiculos":{"type":"object","properties":{"cTipoOpVeiculo":{"type":"string","maxLength":1,"description":"Veículos - Tipo da Operação\n\nPode ser:\n\n1 - Venda concessionária\n2 - Faturamento direto para consumidor final\n3 - Venda direta para grandes consumidores (frotista, governo, ...)\n0 - Outros."},"cChassiVeiculo":{"type":"string","maxLength":17,"description":"Veículos - Chassi do Veículo."},"cCondVinVeiculo":{"type":"string","maxLength":1,"description":"Veículos - Condição do VIN\n\nPode ser:\n\nR - Remarcado\nN - Normal."},"cModAnoFabrVeiculo":{"type":"string","maxLength":4,"description":"Veículos - Ano Modelo de Fabricação."},"cAnoFabrVeiculo":{"type":"string","maxLength":4,"description":"Veículos - Ano de Fabricação."},"cEspecieVeiculo":{"type":"string","maxLength":1,"description":"Veículos - Espécie de Veículo\n\nPode ser:\n\n1 - PASSAGEIRO\n2 - CARGA\n3 - MISTO\n4 - CORRIDA\n5 - TRAÇÃO\n6 - ESPECIAL."},"cTipoVeiculo":{"type":"string","maxLength":2,"description":"Veículos - Tipo de Veículo\n\nPode ser:\n\n02 - CICLOMOTO\n03 - MOTONETA\n04 - MOTOCICLO\n05 - TRICICLO\n06 - AUTOMÓVEL\n07 - MICROÔNIBUS\n08 - ÔNIBUS\n10 - REBOQUE\n11 - SEMIRREBOQUE\n13 - CAMINHONETA\n14 - CAMINHÃO\n17 - C. TRATOR\n22 - ESP/ÔNIBUS\n23 - MISTO/CAM\n24 - CARGA/CAM."},"potenciaMotor":{"type":"object","properties":{"cPotenciaVeiculo":{"type":"string","maxLength":4,"description":"Veículos - Potência Motor (CV)."},"cCilindradasVeiculo":{"type":"string","maxLength":4,"description":"Veículos - Cilindradas."},"cTipoCombVeiculo":{"type":"string","maxLength":2,"description":"Veículos - Tipo de Combustível\n\nPode ser:\n\n01 - Álcool\n02 - Gasolina\n03 - Diesel\n16 - Álcool/Gasolina\n17 - Gasolina/Álcool/GNV\n18 - Gasolina/Elétrico\n04 - Gasogênio\n05 - Gás Metano\n06 - Elétrico/Fonte Interna\n07 - Elétrico/Fonte Externa\n08 - Gasolina/Gás Natural Combustív\n09 - Álcool/Gás Natural Combustível\n10 - Diesel/Gas Natural Combustível\n11 - Vide/Campo/Observação\n12 - Álcool/Gás Natural Veicular\n13 - Gasolina/Gás Natural Veicular\n14 - Diesel/Gás Natural Veicular\n15 - Gás Natural Veicular\n19 - Gasolina/Álcool/Elétrico\n20 - Gás Natural Liquefeito\n21 - Diesel/Elétrico\n22 - Híbrido\n23 - Híbrido Plug-in\n24 - Elétrico\n25 - Célula Combustível\n26 - Híbrido/Gás Natural Veicular\n27 - Etanol/Elétrico."},"cNumMotorVeiculo":{"type":"string","maxLength":21,"description":"Veículos - Número de Motor."}},"description":"Dados específico para veículos novos - Potência, Combustível e Motor."},"pinturaCor":{"type":"object","properties":{"cTipoPinVeiculo":{"type":"string","maxLength":1,"description":"Veículos - Tipo de Pintura."},"cCodCorDENATRANVeiculo":{"type":"string","maxLength":2,"description":"Veículos - Código da Cor (DENATRAN)\n\nPode ser:\n\n01 - AMARELO\n02 - AZUL\n03 - BEGE\n04 - BRANCA\n05 - CINZA\n06 - DOURADA\n07 - GRENÁ\n08 - LARANJA\n09 - MARROM\n10 - PRATA\n11 - PRETA\n12 - ROSA\n13 - ROXA\n14 - VERDE\n15 - VERMELHA\n16 - FANTASIA."},"cCodCorMontVeiculo":{"type":"string","maxLength":4,"description":"Veículos - Código da Cor da Montadora."},"cDescMontVeiculo":{"type":"string","maxLength":40,"description":"Veículos - Descrição da Cor da Montadora."}},"description":"Dados específico para veículos novos - Pintura e Cor."},"outrasInfVeiculo":{"type":"object","properties":{"cCodMarcaModVeiculo":{"type":"string","maxLength":6,"description":"Veículos - Código Marca Modelo."},"cSerialVeiculo":{"type":"string","maxLength":9,"description":"Veículos - Serial (série)."},"cMaxTracaoVeiculo":{"type":"string","maxLength":9,"description":"Veículos - Capacidade Máxima de Tração."},"cDisEixosVeiculo":{"type":"string","maxLength":4,"description":"Veículos - Distância entre Eixos."},"cCondVeiVeiculo":{"type":"string","maxLength":1,"description":"Veículos - Condição do Veículo\n\nPode ser:\n\n1 - Acabado\n2 - Inacabado\n3 - Semiacabado."},"cMaxLotVeiculo":{"type":"string","maxLength":3,"description":"Veículos - Capacidade máxima de lotação."},"cRestVeiculo":{"type":"string","maxLength":1,"description":"Veículos - Restrição\n\nPode ser:\n\n0 - Não há\n1 - Alienação Fiduciária\n2 - Arrendamento Mercantil\n3 - Reserva de Domínio\n4 - Penhor de Veículos\n9 - Outras."},"cPesoBrutoVeiculo":{"type":"string","maxLength":9,"description":"Veículos - Peso Bruto (toneladas)."},"cPesoLiqVeiculo":{"type":"string","maxLength":9,"description":"Veículos - Peso Líquido (toneladas)."}},"description":"Dados específico para veículos novos - Outras informações."}},"description":"Dados específico para veículos novos."},"combustivel":{"type":"object","properties":{"cCodigoANP":{"type":"string","maxLength":9,"description":"Combustíveis - Código de produto da ANP."},"cDescrANP":{"type":"string","maxLength":95,"description":"Combustíveis - Descrição do Produto conforme ANP."},"cCODIF":{"type":"string","maxLength":21,"description":"Combustíveis - Código de autorização / registro do CODIF."},"nPercGLP":{"type":"number","maxLength":6,"description":"Combustíveis - Percentual de Gás Natural para o produto GLP."},"nPercGasNacional":{"type":"number","maxLength":8,"description":"Combustíveis - Percentual de Gás Natural Nacional."},"nPercGasImportado":{"type":"number","maxLength":8,"description":"Combustíveis - Percentual de Gás Natural Importado."},"nValorPartida":{"type":"number","maxLength":16,"description":"Combustíveis - Valor de Partida."},"nQtdeFatTempAmb":{"type":"number","maxLength":16,"description":"Combustíveis - Quantidade de combustível faturada à temperatura ambiente."},"cUFConsumoComb":{"type":"string","maxLength":2,"description":"Combustíveis - Sigla da UF de consumo."},"nBC_CIDE":{"type":"number","maxLength":18,"description":"Combustíveis - Base de Cálculo (em quantidade)  da CIDE."},"nAliquota_CIDE":{"type":"number","maxLength":10,"description":"Combustíveis - Valor da Alíquota em Reais da CIDE."},"nValor_CIDE":{"type":"number","maxLength":18,"description":"Combustíveis - Valor da CIDE."}},"description":"Detalhamento específico de combustíveis."},"custos":{"type":"object","properties":{"cICMSCusto":{"type":"string","maxLength":1,"description":"ICMS é custo de estoque.\n\nInformar \"S\" ou \"N\"."},"cPISCusto":{"type":"string","maxLength":1,"description":"PIS é custo de estoque.\n\nInformar \"S\" ou \"N\"."},"cICMSSTCusto":{"type":"string","maxLength":1,"description":"ICMS ST é custo de estoque.\n\nInformar \"S\" ou \"N\"."},"cCOFINSCusto":{"type":"string","maxLength":1,"description":"COFINS é custo de estoque.\n\nInformar \"S\" ou \"N\"."},"cIPICusto":{"type":"string","maxLength":1,"description":"IPI é custo de estoque.\n\nInformar \"S\" ou \"N\"."},"cFreteCusto":{"type":"string","maxLength":1,"description":"Frete é custo de estoque.\n\nInformar \"S\" ou \"N\"."},"cSeguroCusto":{"type":"string","maxLength":1,"description":"Seguro é custo de estoque.\n\nInformar \"S\" ou \"N\"."},"cOutrosDespCusto":{"type":"string","maxLength":1,"description":"Outras Desp. é custo de estoque.\n\nInformar \"S\" ou \"N\"."},"nValorICMSSTCusto":{"type":"number","maxLength":18,"description":"Valor do ICMS ST."},"nAliqCredPISCusto":{"type":"number","maxLength":10,"description":"% Alíq. de Crédito do PIS"},"nAliqCredCOFINSCusto":{"type":"number","maxLength":10,"description":"% Alíq. de Crédito do COFINS"}},"description":"Custos de estoque do item da nota de entrada."},"cAcaoItem":{"type":"string","maxLength":1,"description":"Ação a ser realizada no item.\n\nPode ser:\n\n\"A\" - Alterar o item.\n\"E\" - Excluir o item.\n\"I\" - Incluir o item.\n\nObrigatório na operação \"AlterarNotaEnt\"; opcional em \"IncluirNotaEnt\" (assume \"I\"\ncomo padrão, já que toda inclusão de nota implica itens novos)."},"lote_validade":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","maxLength":15,"description":"Id do Lote do produto.\n\nObrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.."},"nQtdLote":{"type":"number","maxLength":18,"description":"Informe aqui a quantidade do lote para o produto.\n\nÉ obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações."},"cNumLote":{"type":"string","maxLength":20,"description":"Número do lote do produto.\n\nDeve ser informado apenas quando a tag [nIdLote] não for informada, com isso, será criado um novo lote a partir do número informado."},"cCodAgreg":{"type":"string","maxLength":20,"description":"Código de agregação do lote do produto.\n\nDeve ser informado apenas quando a tag [nIdLote] não for informada."},"dDataFab":{"type":"string","maxLength":10,"description":"Data de fabricação do lote.\n\nDeve ser informado apenas quando a tag [nIdLote] não for informada.\n\nComo default é utilizado a data atual."},"dDataVal":{"type":"string","maxLength":10,"description":"Data de validade do lote.\n\nDeve ser informado apenas quando a tag [nIdLote] não for informada."}},"required":["nQtdLote"]},"description":"Informações referentes ao lote e validade do produto.\n\nA tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes \"manualmente\" por API."},"IBS_CBS":{"type":"object","properties":{"cCstIbsCbs":{"type":"string","maxLength":3,"description":"Código de Situação Tributária do IBS e CBS."},"cClassTrib":{"type":"string","maxLength":6,"description":"Código de Classificação Tributária do IBS e CBS."},"nBaseIbsCbs":{"type":"number","maxLength":15,"description":"Base de cálculo do IBS e CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será calculado automaticamente."}}},"IBS":{"type":"object","properties":{"nAliqIbsUf":{"type":"number","maxLength":7,"description":"Alíquota do IBS de competência das UF."},"nPercDiferimentoIbsUf":{"type":"number","maxLength":7,"description":"Percentual do Diferimento - IBS UF."},"nPercReducaoIbsUf":{"type":"number","maxLength":7,"description":"Percentual da redução de alíquota - IBS UF."},"nValDiferimentoIbsUf":{"type":"number","maxLength":15,"description":"Valor do Diferimento - IBS UF.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será calculado automaticamente."},"nValIbsUf":{"type":"number","maxLength":15,"description":"Valor do IBS de competência da UF.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será calculado automaticamente."},"nAliqIbsMun":{"type":"number","maxLength":7,"description":"Alíquota do IBS de competência do Município."},"nPercDiferimentoIbsMun":{"type":"number","maxLength":7,"description":"Percentual do diferimento - UBS Município."},"nPercReducaoIbsMun":{"type":"number","maxLength":7,"description":"Percentual da redução de alíquota - IBS Município."},"nValDiferimentoIbsMun":{"type":"number","maxLength":15,"description":"Valor do Diferimento - IBS Município.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será calculado automaticamente."},"nValIbsMun":{"type":"number","maxLength":15,"description":"Valor do IBS de competência do Município.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será calculado automaticamente."},"nValIbs":{"type":"number","maxLength":15,"description":"Valor total do IBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será calculado automaticamente."}}},"CBS":{"type":"object","properties":{"nAliqCbs":{"type":"number","maxLength":7,"description":"Alíquota da CBS."},"nPercDiferimentoCbs":{"type":"number","maxLength":7,"description":"Percentual do diferimento - CBS."},"nPercReducaoCbs":{"type":"number","maxLength":7,"description":"Percentual da redução de alíquota - CBS."},"nValDiferimentoCbs":{"type":"number","maxLength":15,"description":"Valor do diferimento - CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será calculado automaticamente."},"nValCbs":{"type":"number","maxLength":15,"description":"Valor da CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será calculado automaticamente."}}},"TRIB_REG":{"type":"object","properties":{"cCstIbsCbsReg":{"type":"string","maxLength":3,"description":"Código da Situação Tributária do IBS e CBS (Tributação Regular)."},"cClassTribReg":{"type":"string","maxLength":6,"description":"Código de Classificação Tributária do IBS e CBS (Tributação Regular)."},"nAliqIbsUfReg":{"type":"number","maxLength":7,"description":"Valor da alíquota do IBS da UF na tributação regular."},"nAliqIbsMunReg":{"type":"number","maxLength":7,"description":"Valor da alíquota do IBS do Município na tributação regular."},"nAliqCbsReg":{"type":"number","maxLength":7,"description":"Valor da alíquota da CBS na tributação regular."},"nValIbsUfReg":{"type":"number","maxLength":15,"description":"Valor do Tributo do IBS da UF na tributação regular.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será calculado automaticamente."},"nValIbsMunReg":{"type":"number","maxLength":15,"description":"Valor do Tributo do IBS do Município na tributação regular.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será calculado automaticamente."},"nValCbsReg":{"type":"number","maxLength":15,"description":"Valor do Tributo da CBS na tributação regular.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será calculado automaticamente."}}}}}},"departamentos":{"type":"array","items":{"type":"object","properties":{"cCodDepto":{"type":"string","maxLength":40,"description":"Código do Departamento - Preenchimento obrigatório.\n\nInformação localizada na Aba \"Departamentos\" da Nota de Entrada.\n\nUtilize a tag \"codigo\" do método \"ListarDepatartamentos\" da API\n/api/v1/geral/departamentos/ para obter essa informação."},"nValor":{"type":"number","maxLength":18,"description":"Valor do rateio - Preenchimento obrigatório.\n\nInformação localizada na Aba \"Departamentos\" da Nota de Entrada."},"nPerc":{"type":"number","maxLength":10,"description":"Percentual do rateio - Preenchimento obrigatório.\n\nInformação localizada na Aba \"Departamentos\" da Nota de Entrada."}},"required":["cCodDepto","nPerc","nValor"]}}}}}},"example":{"call":"IncluirNotaEnt","param":[{"cabec":{"nCodCli":123456,"dPrevisao":"20/10/2026","cCodParc":"999"},"produtos":{"nCodProd":654321,"cCFOP":"1102","nQtde":10,"nValUnit":25.5}}]}},"produtos_notaentrada_IncluirNotaEnt_retorno":{"type":"object","properties":{"nCodNotaEnt":{"type":"integer","description":"Código da nota de entrada."},"cCodIntNotaEnt":{"type":"string","description":"Código de integração da nota de entrada."},"cCodStatus":{"type":"string","description":"Código do status da nota de entrada."},"cDesStatus":{"type":"string","description":"Descrição do status da nota de entrada."},"cNumeroNotaEnt":{"type":"string","description":"Número da nota de entrada exibido na tela."}},"title":"IncluirNotaEnt (retorno)"},"produtos_notaentrada_ListarNotaEnt":{"type":"object","title":"ListarNotaEnt","description":"Listagem de nota de entrada.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarNotaEnt"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página."},"nRegistrosPorPagina":{"type":"integer","maxLength":15,"description":"Quantidade de registros por página."},"cOrdenarPor":{"type":"string","maxLength":100,"description":"Ordenar o resultado da página por:\n\nCODIGO - Código do lançamento do Omie;\nCODINT - Código do lançamento interno do seu sistema."},"dtAltDe":{"type":"string","maxLength":10,"description":"Filtra os registros a partir da data específicada."},"dtAltAte":{"type":"string","maxLength":10,"description":"Filtra os registros até a data específicada."},"hrAltDe":{"type":"string","maxLength":8,"description":"Filtra os registros a partir da hora específicada."},"hrAltAte":{"type":"string","maxLength":8,"description":"Filtra os registros até a hora específicada."},"nIdCliente":{"type":"integer","maxLength":15,"description":"Filtra os registros do cliente específicado."},"cExibirDetalhes":{"type":"string","maxLength":1,"description":"Exibir os detalhes da nota de entrada.\n\nPreencher com \"S\" ou \"N\"."}}}}},"example":{"call":"ListarNotaEnt","param":[{"nPagina":1,"nRegistrosPorPagina":20}]}},"produtos_notaentrada_ListarNotaEnt_retorno":{"type":"object","properties":{"nPagina":{"type":"integer"},"nTotalPaginas":{"type":"integer"},"nRegistros":{"type":"integer"},"nTotalRegistros":{"type":"integer"},"notas":{"type":"array","items":{"type":"object","properties":{"cabec":{"type":"object","properties":{"nCodNotaEnt":{"type":"integer","description":"Código da Nota de Entrada no Omie Esse campo não é exibido na tela é uma informação interna, utilizada apenas nas APIs."},"cCodIntNotaEnt":{"type":"string","description":"Código de Integração da Nota de Entrada Preencha esse campo com o código da nota de entrada no aplicativo que você está integrando com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de notas de entrada você conseguirá ver a relação entre o id da nota de entrada gerado no Omie e o código de pedido existente em sua aplicação."},"nCodCli":{"type":"integer","description":"Código do cliente. Preencher quando não for informado cCodIntCli. Não preencher quando informado cCodIntCli. Utilize a tag \"codigo_cliente_omie\" do método \"ListarClientes\" da API http://app.omie.com.br/api/v1/geral/clientes/ para obter essa informação."},"cCodIntCli":{"type":"string","description":"Código de Integração do Cliente Preencher quando não for informado nCodCli. Não preencher quando informado nCodCli. Esse campo deve ser informado apenas se você incluiu o cliente via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag nCodCli."},"dPrevisao":{"type":"string","description":"Data de previsão de faturamento. Utilize o formato \"dd/mm/aaaa\". Esse campo indica a data da previsão do faturamento do pedido e deve ser informado com uma data igual ou superior a data corrente. Obrigatório na operação \"IncluirNotaEnt\"; opcional nas demais operações que reutilizam esta estrutura, como \"AlterarNotaEnt\"."},"nCodVend":{"type":"integer","description":"Código do vendedor Utilize a tag \"codigo\" do método \"ListarVendedores\" da API http://app.omie.com.br/api/v1/geral/vendedores para obter essa informação."},"cNumeroNotaEnt":{"type":"string","description":"Número da noata de entrada exibido na tela. Disponível apenas na consulta/listagem como retorno de informação."},"cGeraFinanceiro":{"type":"string","description":"Gerar movimentação financeira para a nota de entrada. Informar \"S\" ou \"N\"."},"cCodParc":{"type":"string","description":"Código da Condição de Pagamento/Parcelamento."},"nQtdeParc":{"type":"integer","description":"Quantidade de parcelas a serem geradas quando a condição de pagamento informada for \"999\"."}}},"frete":{"type":"object","properties":{"nCodTransp":{"type":"integer","description":"Código da transportadora Esse campo não é exibido na tela do pedido. É uma informação interna, utilizada apenas nas APIs. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido. Utilize a tag \"codigo_cliente_omie\" do método \"ListarClientes\" da API http://app.omie.com.br/api/v1/geral/clientes/ para obter essa informação. OBS: O Omie uitliza o cadastro de clientes para registrar também fornecedores e transportadoras."},"cTpFrete":{"type":"string","description":"Tipo de frete. Informação localizada na Aba \"Frete e Outras Despesas\" do pedido. Valores disponíveis: \"0\" - Frete por conta do emitente. \"1\" - Frete por conta do destinatário. \"2\" - Frete por conta de terceiros. \"9\" - Sem frete."},"cPlaca":{"type":"string","description":"Placa do veículo. Informação localizada na Aba \"Frete e Outras Despesas\" do pedido."},"cUF":{"type":"string","description":"Estado da placa do veículo. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido."},"nQtdVol":{"type":"integer","description":"Quantidade de volumes Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido."},"cEspVol":{"type":"string","description":"Espécie de volume. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido."},"cMarVol":{"type":"string","description":"Marca dos volumes. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido."},"cNumVol":{"type":"string","description":"Numeração dos volumes. Informação localizada na Aba \"Frete e Outras Despesas\" do pedido."},"nPesoLiq":{"type":"decimal","description":"Peso líquído (Kg) Informação localizada na Aba \"Frete e Outras Despesas\" do pedido."},"nPesoBruto":{"type":"decimal","description":"Peso bruto (Kg) Informação localizada na Aba \"Frete e Outras Despesas\" do pedido."},"nValFrete":{"type":"decimal","description":"Valor do frete Informação localizada na Aba \"Frete e Outras Despesas\" do pedido."},"nValSeguro":{"type":"decimal","description":"Valor do seguro Informação localizada na Aba \"Frete e Outras Despesas\" do pedido."},"nValOutras":{"type":"decimal","description":"Valor de outras despesas acessórias. Informação localizada na Aba \"Frete e Outras Despesas\" do pedido."},"cNumeroLacre":{"type":"string","description":"Número dos Lacres."},"cRegistroTransp":{"type":"string","description":"RNTRC (ANTT) - Registro de transporte."},"cVeiculoProprio":{"type":"string","description":"O transporte será realizado com veículo próprio. Informar \"S\" ou \"N\". Informação localizada na Aba \"Frete e Outras Despesas\"."}}},"infAdic":{"type":"object","properties":{"cCodCateg":{"type":"string","description":"Código da categoria. Informação localizada na Aba \"Informações Adicionais\" do pedido. Utilize a tag \"codigo\" do método \"ListarCategorias\" da API http://app.omie.com.br/api/v1/geral/categorias/ para obter essa informação. Obrigatório na operação \"IncluirNotaEnt\"; opcional nas demais operações que reutilizam esta estrutura, como \"AlterarNotaEnt\"."},"cContato":{"type":"string","description":"Contato. Informação localizada na Aba \"Informações Adicionais\" do pedido."},"nCodProj":{"type":"integer","description":"Código do projeto. Informação localizada na Aba \"Informações Adicionais\" do pedido. Utilize a tag \"codigo\" do método \"ListarProjetos\" da API http://app.omie.com.br/api/v1/geral/projetos/ para obter essa informação."},"cPedido":{"type":"string","description":"Número do pedido do cliente. Informação localizada na Aba \"Informações Adicionais\" do pedido."},"outrosDet":{"type":"object","properties":{"dDataSaida":{"type":"string","description":"Data de entrada/saída."},"cHoraSaida":{"type":"string","description":"Hora de entrada/saída."},"cNatOperacao":{"type":"string","description":"Natureza de operação."},"indIntermediario":{"type":"string","description":"Indicador de Intermediador. Esta informação deverá ser enviada quando se tratar de uma operação não presencial. Opções disponíveis: 0=Operação sem intermediador(em site ou plataforma própria) 1=Operação em site ou plataforma de terceiros(intermediadores/marketplace) Se não informado, utilizaremos automaticamente a opção \"0-Operação sem intermediador(em site ou plataforma própria)\". Informação localizada na Aba \"Informações Adicionais\"."},"indPresenca":{"type":"string","description":"Indicador de Presença da Operação."},"identIntermediario":{"type":"string","description":"Identificação no Intermediador. Este identificador pode ser o nome do usuário ou identificação do perfil do vendedor no site do intermediador. Informação localizada na Aba \"Informações Adicionais\"."},"cnpjIntermediario":{"type":"string","description":"CNPJ do Intermediador. Preencimento obrigatório caso o Indicador de Intermediador seja igual a opção \"1-Operação em site ou plataforma de terceiros(intermediadores/marketplace)\". Este campo representa o CNPJ do Intermediador da Transação. Informação localizada na Aba \"Informações Adicionais\"."},"infCanaAcucar":{"type":"object","properties":{"cSafra":{"type":"string","description":"Safra."},"cPerRef":{"type":"string","description":"Mês e Ano de referência da Safra de Cana-de-acúçar."},"nQuantMes":{"type":"decimal","description":"Quantidade total de fornecimento de cana-de-açúcar no período."},"nQuantAnt":{"type":"decimal","description":"Quantidade do fornecimento de cana-de-açúcar no período anterior."},"nQuantTot":{"type":"decimal","description":"Quantidade total atualizada do fornecimento de cana-de-açúcar."},"nValForn":{"type":"decimal","description":"Valor do fornecimento de cana-de-açúcar."},"nValDed":{"type":"decimal","description":"Valor total das deduções do período."},"nValLiq":{"type":"decimal","description":"Valor líquido do fornecimento de cana-de-açúcar."},"QtdDiariaCanaAc":{"type":"array","items":{"type":"object","properties":{"nDia":{"type":"integer","description":"Dia do mês do fornecimento de cana-de-açúcar."},"nQuantDia":{"type":"decimal","description":"Quantidade diária de fornecimento de cana-de-açúcar."}}},"description":"Registro do fornecimento diário de cana-de-açúcar."},"DeducaoCanaAc":{"type":"array","items":{"type":"object","properties":{"cDescrDed":{"type":"string","description":"Descrição da dedução na aquisição de cana-de-açúcar."},"nValorDed":{"type":"decimal","description":"Valor da dedução."}}},"description":"Deduções na aquisição de cana-de-açúcar."}},"description":"Informações da aquisição de Cana-de-açúcar."}},"description":"Informações adicionais outros detalhes da nota de entrada."},"cDadosAdic":{"type":"string","description":"Dados adicionais para a nota fiscal. Utilize o caracter pipe ( | ) como separador de linha. Informação localizada na Aba \"Informações Adicionais\" do pedido."},"cConsFinal":{"type":"string","description":"Nota fiscal para consumo final. Informar \"S\" ou \"N\". Informação localizada na Aba \"Informações Adicionais\" do pedido."},"nCodCC":{"type":"integer","description":"Código interno da conta corrente da nota fiscal (este é o código da conta corrente no Omie)."},"nfRelacionada":{"type":"object","properties":{"cChaveRef":{"type":"string","description":"Chave da NF-e (ou NFC-e ou SAT) Relacionada."},"nNFRef":{"type":"string","description":"Número da Nota Fiscal Nota Fiscal Relacionada Modelo 1/1A."},"cSerieRef":{"type":"string","description":"Série da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A."},"dtEmissaoRef":{"type":"string","description":"Data de emissão da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A."},"cnpjEmitRef":{"type":"string","description":"CNPJ da Emitente da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A."},"cUfRef":{"type":"string","description":"Estado do Emitente da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A."},"nNfPR":{"type":"string","description":"Número da Nota Fiscal relacionada do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural."},"cSeriePR":{"type":"string","description":"Série da NF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural."},"dtEmissaoPR":{"type":"string","description":"Data de emissão da NF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural."},"cnpjPR":{"type":"string","description":"CNPJ/CPF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural."},"InscrEstPR":{"type":"string","description":"Inscrição Estadual do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural."},"cUfPR":{"type":"string","description":"Estado do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural."},"nCOORef":{"type":"string","description":"Número do COO - Contador de Ordem de Operação. Cupom Fiscal Relacionado."},"nECFRef":{"type":"string","description":"Número de Ordem Sequencial do ECF."},"nrProdutorRural":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","description":"Ação a ser realizada no item na alteração. Pode ser: \"I\" - Incluir o item. \"E\" - Excluir o item."},"nrNumero":{"type":"string","description":"Número da NF relacionada."},"nrSerie":{"type":"string","description":"Série da NF relacionada."},"nrDtEmissao":{"type":"string","description":"Data de emissão da NF relacionada."},"nrCnpjCpf":{"type":"string","description":"CNPJ/CPF do emitente da NF relacionada."},"nrIE":{"type":"string","description":"Inscrição Estadual do emitente da NF relacionada."},"nrUF":{"type":"string","description":"Unidade federativa do emitente da NF relacionada."}}},"description":"Outras notas de produtor rural relacionadas."},"nrNF":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","description":"Ação a ser realizada no item na alteração. Pode ser: \"I\" - Incluir o item. \"E\" - Excluir o item."},"nrChave":{"type":"string","description":"Chave da NF-e, NFC-e ou SAT relacionada."}}},"description":"Outras NF-e, NFC-e ou SAT relacionadas."},"nrCupomFiscal":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","description":"Ação a ser realizada no item na alteração. Pode ser: \"I\" - Incluir o item. \"E\" - Excluir o item."},"nrCOO":{"type":"string","description":"Contador de Ordem de Operação (COO)."},"nrNumeroECF":{"type":"string","description":"Número do ECF."}}},"description":"Outros cupons fiscais relacionados."},"nrModelo1_1A":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","description":"Ação a ser realizada no item na alteração. Pode ser: \"I\" - Incluir o item. \"E\" - Excluir o item."},"nrNumero":{"type":"string","description":"Número da NF relacionada."},"nrSerie":{"type":"string","description":"Série da NF relacionada."},"nrDtEmissao":{"type":"string","description":"Data de emissão da NF relacionada."},"nrCnpjCpf":{"type":"string","description":"CNPJ/CPF do emitente da NF relacionada."},"nrUF":{"type":"string","description":"Unidade federativa do emitente da NF relacionada."}}},"description":"Outras notas modelo 1/1A relacionadas."},"cSigNFRef":{"type":"string","description":"Manter o sigilo da NF-e referenciada. Preencher com \"S\" ou \"N\". Default \"N\"."}},"description":"Detalhes da NF referenciada."},"infAdicFisco":{"type":"object","properties":{"cRegimeEsp":{"type":"string","description":"Possui regime especial S/N."},"cObsSped":{"type":"string","description":"Observação para uso exclusivo do SPED (Registro C110). (Necessário preencher campo cRegimeEsp \"S\" para alterar esta informação)."},"cInfAdic":{"type":"string","description":"Informações Adicionais de interesse do Fisco para a Nota Fiscal."}},"description":"Informações adicionais de interesse do fisco."}}},"email":{"type":"object","properties":{"cEmail":{"type":"string","description":"E-mail do cliente."}}},"obs":{"type":"object","properties":{"cObs":{"type":"string","description":"Observações da Remessa."}}},"totais":{"type":"object","properties":{"nMercadorias":{"type":"decimal","description":"Total de mercadorias."},"nDescontos":{"type":"decimal","description":"Total de descontos."},"nIPI":{"type":"decimal","description":"Total de IPI."},"nICMSST":{"type":"decimal","description":"Total de ICMS ST."},"nTotalNotaEnt":{"type":"decimal","description":"Valor total da nota de entrada."},"nTotIbsUf":{"type":"decimal"},"nTotIbsMun":{"type":"decimal"},"nTotIbs":{"type":"decimal"},"nTotCbs":{"type":"decimal"},"nTotIbsCbsIs":{"type":"decimal"}},"description":"Totais da nota de entrada."},"produtos":{"type":"array","items":{"type":"object","properties":{"nCodIt":{"type":"integer","description":"Código do item da nota de entrada Não informar na inclusão preenchimento automático. Informe esse campo na alteração somente quando cCodItInt não for informado. Esse campo não é exibido na tela é uma informação interna, utilizada apenas nas APIs."},"cCodItInt":{"type":"string","description":"Código de integração do item da nota de entrada Preencha esse campo com o código do item do pedido no aplicativo que você está integrando com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de itens de pedidos você conseguirá ver a relação entre o id do item do pedido gerado no Omie e o código de item de pedido existente em sua aplicação."},"nCodProd":{"type":"integer","description":"ID do Produto. Informe esse campo somente quando cCodProdInt não for informado. Esse campo não é exibido na tela do pedido. É uma informação interna, utilizada apenas nas APIs. Utilize a tag \"codigo_produto\" do método \"ListarProdutos\" da API http://app.omie.com.br/api/v1/geral/produtos/ para obter essa informação."},"cCodProdInt":{"type":"string","description":"Código de integração do produto. Informe esse campo somente quando nCodProd não for informado. Esse campo deve ser informado apenas se você incluiu o produto via API e informou um código de integração para o produto. Do contrário, informe sempre a tag \"nCodProd\"."},"cCFOP":{"type":"string","description":"CFOP - Código Fiscal de Operações e Prestações. Utilize a tag \"nCodigo\" do método \"ListarCFOP\" da API http://app.omie.com.br/api/v1/produtos/cfop/ para obter essa informação. Obrigatório na operação \"IncluirNotaEnt\"; obrigatório também em \"AlterarNotaEnt\" apenas quando o item for novo (`cAcaoItem = \"I\"`) — opcional ao alterar ou excluir um item já existente."},"nQtde":{"type":"decimal","description":"Quantidade."},"nValUnit":{"type":"decimal","description":"Valor unitário."},"cNCM":{"type":"string","description":"NCM - Nomenclatura Comum do Mercosul Utilize a tag \"cCodigo\" do método \"ListarNCM\" da API http://app.omie.com.br/api/v1/produtos/ncm/ para obter essa informação."},"cEAN":{"type":"string","description":"EAN - European Article Number."},"nDesconto":{"type":"decimal","description":"Valor do desconto."},"ICMS":{"type":"object","properties":{"cSitTrib":{"type":"string","description":"Situação Tributária do ICMS."},"cOrigem":{"type":"string","description":"Origem."},"cModBC":{"type":"string","description":"Modalidade da BC do ICMS."},"nRedBC":{"type":"decimal","description":"Redução da BC do ICMS (%)."},"nBC":{"type":"decimal","description":"Base de Calculo do ICMS."},"nAliq":{"type":"decimal","description":"Alíquota de ICMS."},"nValor":{"type":"decimal","description":"Valor do ICMS."},"nBCRet":{"type":"decimal","description":"Base de Cálculo do ICMS Retido."},"nAliqCN":{"type":"decimal","description":"Alíquota Suportada pelo Cons. Final."},"nValorRetST":{"type":"decimal","description":"Valor do ICMS Retido por ST."},"nValorDif":{"type":"decimal","description":"Valor do ICMS Diferido."},"nValorICMD":{"type":"decimal","description":"Valor do ICMS Desonerado."},"nValorICMOP":{"type":"decimal","description":"Valor do ICMS Oper. Própria."},"cMotDeson":{"type":"string","description":"Motivo da Desoneração do ICMS Pode ser: 01 - Táxi 03 - Produtor Agropecuário 04 - Frotista/Locadora 05 - Diplomático/Consular 06 - Utilitários e Motocicletas da Amazônia Ocidental e Áreas de Livre Comércio (Resolução 714/88 e 790/94 – CONTRAN e suas alterações) 07 - SUFRAMA 08 - Venda a Órgão Público 09 - Outros. (NT 2011/004) 10 - Deficiente Condutor (Convênio ICMS 38/12) 11 - Deficiente Não Condutor (Convênio ICMS 38/12) 16 - Olimpíadas Rio 2016 90 - Solicitado pelo Fisco."},"nPercDif":{"type":"decimal","description":"Percentual do Diferimento (%)."}}},"ICMS_ST":{"type":"object","properties":{"cModBCST":{"type":"string","description":"Modalidade da Base de Cálculo do ICMS Substituição Tributária."},"nMargVrAd":{"type":"decimal","description":"Margem de Valor Adicionado (%)."},"nRedBCST":{"type":"decimal","description":"Redução da BC do ICMS ST (%)."},"nBCST":{"type":"decimal","description":"Base de Cálculo do ICMS ST."},"nAliqST":{"type":"decimal","description":"Alíquota do ICMS ST (%)."},"nAliqOP":{"type":"decimal","description":"Alíq. do ICMS Oper. Própria (%)."},"nValorST":{"type":"decimal","description":"Valor do ICMS ST."}}},"ICMS_SN":{"type":"object","properties":{"cSitTribSN":{"type":"string","description":"Situação Tributária do ICMS."},"cOrigem":{"type":"string","description":"Origem."},"nAliqCredSN":{"type":"decimal","description":"Alíq. de Cálculo de Crédito (%)."},"nCredSN":{"type":"decimal","description":"Crédito do ICMS Aproveitado."},"nBCSNST":{"type":"decimal","description":"Base de Cálculo do ICMS Retido."},"nValorSNST":{"type":"decimal","description":"Valor do ICMS Retido por ST."},"cModBCSN":{"type":"string","description":"Modalidade da BC do ICMS."},"nAliqRedBCSN":{"type":"decimal","description":"Redução da BC do ICMS (%)."},"nBCSN":{"type":"decimal","description":"Base de Cálculo do ICMS."},"nAliqSN":{"type":"decimal","description":"Alíquota do ICMS (%)."},"nValorSN":{"type":"decimal","description":"Valor do ICMS."}}},"ICMS_INTER":{"type":"object","properties":{"nBCUFDest":{"type":"decimal","description":"Base de Cálculo ICMS na UF de Destino."},"nValorFCPUFDest":{"type":"decimal","description":"Valor do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de Destino."},"nAliqICMSUFDest":{"type":"decimal","description":"Alíquota Interna da UF de Destino."},"nICMSInter":{"type":"decimal","description":"Alíquota Interestadual das UFs Envolvidas."},"nRedICMSUFDest":{"type":"decimal","description":"Alíquota Redução Base ICMS da UF Destino."},"nPercFCPUFDest":{"type":"decimal","description":"Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de Destino."},"nValorICMSUFDest":{"type":"decimal","description":"Valor do ICMS - UF Destino."},"nICMSUFRemet":{"type":"decimal","description":"Valor do ICMS - UF Remetente."}},"description":"Informações do ICMS Interestadual."},"IPI":{"type":"object","properties":{"cSitTribIPI":{"type":"string","description":"Situação Tributária do IPI."},"cTpCalcIPI":{"type":"string","description":"Tipo de Cálculo para obter o IPI."},"nBCIPI":{"type":"decimal","description":"Base de Cálculo do IPI."},"cEnqIPI":{"type":"string","description":"Enquadramento do IPI."},"nAliqIPI":{"type":"decimal","description":"Alíquota do IPI (%)."},"nQtdUTIPI":{"type":"decimal","description":"Qtd Unidades Tributáveis."},"nValIPIUT":{"type":"decimal","description":"Valor do IPI por Unid. Tributável."},"nValIPI":{"type":"decimal","description":"Valor do IPI."}}},"PIS":{"type":"object","properties":{"cSitTribPIS":{"type":"string","description":"Situação Tributária doPIS."},"cTpCalcPIS":{"type":"string","description":"Tipo de Cálculo para obter o PIS."},"nBCPIS":{"type":"decimal","description":"Base de Cálculo do PIS."},"nAliqPIS":{"type":"decimal","description":"Alíquota do PIS (%)."},"nQtdUTPIS":{"type":"decimal","description":"Qtd Unidades Tributáveis."},"nValPISUT":{"type":"decimal","description":"Valor do PIS por Unid. Tributável."},"nValPIS":{"type":"decimal","description":"Valor do PIS."},"nPercRedBCPIS":{"type":"decimal","description":"Percentual de Redução da Base de Cálculo do PIS."}}},"COFINS":{"type":"object","properties":{"cSitTribCOFINS":{"type":"string","description":"Situação Tributária do COFINS."},"cTpCalcCOFINS":{"type":"string","description":"Tipo de Cálculo para obter o COFINS."},"nBCCOFINS":{"type":"decimal","description":"Base de Cálculo do COFINS."},"nAliqCOFINS":{"type":"decimal","description":"Alíquota do COFINS (%)."},"nQtdUTCOFINS":{"type":"decimal","description":"Qtd Unidades Tributáveis."},"nVaCOFINSSUT":{"type":"decimal","description":"Valor do COFINS Unid. Tributável."},"nValCOFINS":{"type":"decimal","description":"Valor do COFINS."},"nPercRedBCCOFINS":{"type":"decimal","description":"Percentual de Redução da Base de Cálculo do COFINS."}}},"infAdicItem":{"type":"object","properties":{"nPesoLiq":{"type":"decimal","description":"Peso líquido (Kg)."},"nPesoBruto":{"type":"decimal","description":"Peso bruto (Kg)."},"cPedCompra":{"type":"string","description":"Número do pedido de compra."},"nItemPedCompra":{"type":"integer","description":"Item do pedido de compra."},"cInfItemNF":{"type":"string","description":"Informações para a nota fiscal."},"cNaoMovEstoque":{"type":"string","description":"Não gerar a saída de estoque deste item ao emitir NF-e. Informar \"S\" ou \"N\". (informe \"S\" para ativar essa opção)."},"cCodBenef":{"type":"string","description":"Código de Beneficiário Fiscal na UF aplicado ao item."},"numero_recopi":{"type":"string","description":"Número do registro gerado pelo sistema RECOPI Nacional (Reconhecimento e Controle das Operações com Papel Imune)."}}},"cCest":{"type":"string","description":"CEST."},"rastreabilidade":{"type":"object","properties":{"numeroLote":{"type":"string","description":"Número do Lote."},"qtdeProdutoLote":{"type":"decimal","description":"Quantidade de Produto."},"dataFabricacaoLote":{"type":"string","description":"Data de Fabricação/Produção."},"dataValidadeLote":{"type":"string","description":"Data de Validade."},"codigoAgregacaoLote":{"type":"string","description":"Código de Agregação."}},"description":"Rastreabilidade do produto."},"codigo_local_estoque":{"type":"integer","description":"Código do local do estoque. Caso não preenchido assumirá o local de estoque padrão."},"codigo_local_estoque_saida":{"type":"integer","description":"Código do local do estoque saída. Este é o local de estoque de saída do cliente ou fornecedor (terceiro). Ao concluir a nota de entrada, o sistema poderá criar automaticamente a saída de estoque neste local."},"medicamentos":{"type":"object","properties":{"cCodigoAnvisa":{"type":"string","description":"Código ANVISA. O \"Código de Produto da ANVISA\" deve possuir 13 caractéres."},"nValMaxCons":{"type":"decimal","description":"Preço máximo consumidor. Preço máximo deve ser maior ou igual a zero."}},"description":"Detalhamento específico para medicamentos."},"veiculos":{"type":"object","properties":{"cTipoOpVeiculo":{"type":"string","description":"Veículos - Tipo da Operação Pode ser: 1 - Venda concessionária 2 - Faturamento direto para consumidor final 3 - Venda direta para grandes consumidores (frotista, governo, ...) 0 - Outros."},"cChassiVeiculo":{"type":"string","description":"Veículos - Chassi do Veículo."},"cCondVinVeiculo":{"type":"string","description":"Veículos - Condição do VIN Pode ser: R - Remarcado N - Normal."},"cModAnoFabrVeiculo":{"type":"string","description":"Veículos - Ano Modelo de Fabricação."},"cAnoFabrVeiculo":{"type":"string","description":"Veículos - Ano de Fabricação."},"cEspecieVeiculo":{"type":"string","description":"Veículos - Espécie de Veículo Pode ser: 1 - PASSAGEIRO 2 - CARGA 3 - MISTO 4 - CORRIDA 5 - TRAÇÃO 6 - ESPECIAL."},"cTipoVeiculo":{"type":"string","description":"Veículos - Tipo de Veículo Pode ser: 02 - CICLOMOTO 03 - MOTONETA 04 - MOTOCICLO 05 - TRICICLO 06 - AUTOMÓVEL 07 - MICROÔNIBUS 08 - ÔNIBUS 10 - REBOQUE 11 - SEMIRREBOQUE 13 - CAMINHONETA 14 - CAMINHÃO 17 - C. TRATOR 22 - ESP/ÔNIBUS 23 - MISTO/CAM 24 - CARGA/CAM."},"potenciaMotor":{"type":"object","properties":{"cPotenciaVeiculo":{"type":"string","description":"Veículos - Potência Motor (CV)."},"cCilindradasVeiculo":{"type":"string","description":"Veículos - Cilindradas."},"cTipoCombVeiculo":{"type":"string","description":"Veículos - Tipo de Combustível Pode ser: 01 - Álcool 02 - Gasolina 03 - Diesel 16 - Álcool/Gasolina 17 - Gasolina/Álcool/GNV 18 - Gasolina/Elétrico 04 - Gasogênio 05 - Gás Metano 06 - Elétrico/Fonte Interna 07 - Elétrico/Fonte Externa 08 - Gasolina/Gás Natural Combustív 09 - Álcool/Gás Natural Combustível 10 - Diesel/Gas Natural Combustível 11 - Vide/Campo/Observação 12 - Álcool/Gás Natural Veicular 13 - Gasolina/Gás Natural Veicular 14 - Diesel/Gás Natural Veicular 15 - Gás Natural Veicular 19 - Gasolina/Álcool/Elétrico 20 - Gás Natural Liquefeito 21 - Diesel/Elétrico 22 - Híbrido 23 - Híbrido Plug-in 24 - Elétrico 25 - Célula Combustível 26 - Híbrido/Gás Natural Veicular 27 - Etanol/Elétrico."},"cNumMotorVeiculo":{"type":"string","description":"Veículos - Número de Motor."}},"description":"Dados específico para veículos novos - Potência, Combustível e Motor."},"pinturaCor":{"type":"object","properties":{"cTipoPinVeiculo":{"type":"string","description":"Veículos - Tipo de Pintura."},"cCodCorDENATRANVeiculo":{"type":"string","description":"Veículos - Código da Cor (DENATRAN) Pode ser: 01 - AMARELO 02 - AZUL 03 - BEGE 04 - BRANCA 05 - CINZA 06 - DOURADA 07 - GRENÁ 08 - LARANJA 09 - MARROM 10 - PRATA 11 - PRETA 12 - ROSA 13 - ROXA 14 - VERDE 15 - VERMELHA 16 - FANTASIA."},"cCodCorMontVeiculo":{"type":"string","description":"Veículos - Código da Cor da Montadora."},"cDescMontVeiculo":{"type":"string","description":"Veículos - Descrição da Cor da Montadora."}},"description":"Dados específico para veículos novos - Pintura e Cor."},"outrasInfVeiculo":{"type":"object","properties":{"cCodMarcaModVeiculo":{"type":"string","description":"Veículos - Código Marca Modelo."},"cSerialVeiculo":{"type":"string","description":"Veículos - Serial (série)."},"cMaxTracaoVeiculo":{"type":"string","description":"Veículos - Capacidade Máxima de Tração."},"cDisEixosVeiculo":{"type":"string","description":"Veículos - Distância entre Eixos."},"cCondVeiVeiculo":{"type":"string","description":"Veículos - Condição do Veículo Pode ser: 1 - Acabado 2 - Inacabado 3 - Semiacabado."},"cMaxLotVeiculo":{"type":"string","description":"Veículos - Capacidade máxima de lotação."},"cRestVeiculo":{"type":"string","description":"Veículos - Restrição Pode ser: 0 - Não há 1 - Alienação Fiduciária 2 - Arrendamento Mercantil 3 - Reserva de Domínio 4 - Penhor de Veículos 9 - Outras."},"cPesoBrutoVeiculo":{"type":"string","description":"Veículos - Peso Bruto (toneladas)."},"cPesoLiqVeiculo":{"type":"string","description":"Veículos - Peso Líquido (toneladas)."}},"description":"Dados específico para veículos novos - Outras informações."}},"description":"Dados específico para veículos novos."},"combustivel":{"type":"object","properties":{"cCodigoANP":{"type":"string","description":"Combustíveis - Código de produto da ANP."},"cDescrANP":{"type":"string","description":"Combustíveis - Descrição do Produto conforme ANP."},"cCODIF":{"type":"string","description":"Combustíveis - Código de autorização / registro do CODIF."},"nPercGLP":{"type":"decimal","description":"Combustíveis - Percentual de Gás Natural para o produto GLP."},"nPercGasNacional":{"type":"decimal","description":"Combustíveis - Percentual de Gás Natural Nacional."},"nPercGasImportado":{"type":"decimal","description":"Combustíveis - Percentual de Gás Natural Importado."},"nValorPartida":{"type":"decimal","description":"Combustíveis - Valor de Partida."},"nQtdeFatTempAmb":{"type":"decimal","description":"Combustíveis - Quantidade de combustível faturada à temperatura ambiente."},"cUFConsumoComb":{"type":"string","description":"Combustíveis - Sigla da UF de consumo."},"nBC_CIDE":{"type":"decimal","description":"Combustíveis - Base de Cálculo (em quantidade) da CIDE."},"nAliquota_CIDE":{"type":"decimal","description":"Combustíveis - Valor da Alíquota em Reais da CIDE."},"nValor_CIDE":{"type":"decimal","description":"Combustíveis - Valor da CIDE."}},"description":"Detalhamento específico de combustíveis."},"custos":{"type":"object","properties":{"cICMSCusto":{"type":"string","description":"ICMS é custo de estoque. Informar \"S\" ou \"N\"."},"cPISCusto":{"type":"string","description":"PIS é custo de estoque. Informar \"S\" ou \"N\"."},"cICMSSTCusto":{"type":"string","description":"ICMS ST é custo de estoque. Informar \"S\" ou \"N\"."},"cCOFINSCusto":{"type":"string","description":"COFINS é custo de estoque. Informar \"S\" ou \"N\"."},"cIPICusto":{"type":"string","description":"IPI é custo de estoque. Informar \"S\" ou \"N\"."},"cFreteCusto":{"type":"string","description":"Frete é custo de estoque. Informar \"S\" ou \"N\"."},"cSeguroCusto":{"type":"string","description":"Seguro é custo de estoque. Informar \"S\" ou \"N\"."},"cOutrosDespCusto":{"type":"string","description":"Outras Desp. é custo de estoque. Informar \"S\" ou \"N\"."},"nValorICMSSTCusto":{"type":"decimal","description":"Valor do ICMS ST."},"nAliqCredPISCusto":{"type":"decimal","description":"% Alíq. de Crédito do PIS"},"nAliqCredCOFINSCusto":{"type":"decimal","description":"% Alíq. de Crédito do COFINS"}},"description":"Custos de estoque do item da nota de entrada."},"cAcaoItem":{"type":"string","description":"Ação a ser realizada no item. Pode ser: \"A\" - Alterar o item. \"E\" - Excluir o item. \"I\" - Incluir o item. Obrigatório na operação \"AlterarNotaEnt\"; opcional em \"IncluirNotaEnt\" (assume \"I\" como padrão, já que toda inclusão de nota implica itens novos)."},"lote_validade":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","description":"Id do Lote do produto. Obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.."},"nQtdLote":{"type":"decimal","description":"Informe aqui a quantidade do lote para o produto. É obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações."},"cNumLote":{"type":"string","description":"Número do lote do produto. Deve ser informado apenas quando a tag [nIdLote] não for informada, com isso, será criado um novo lote a partir do número informado."},"cCodAgreg":{"type":"string","description":"Código de agregação do lote do produto. Deve ser informado apenas quando a tag [nIdLote] não for informada."},"dDataFab":{"type":"string","description":"Data de fabricação do lote. Deve ser informado apenas quando a tag [nIdLote] não for informada. Como default é utilizado a data atual."},"dDataVal":{"type":"string","description":"Data de validade do lote. Deve ser informado apenas quando a tag [nIdLote] não for informada."}}},"description":"Informações referentes ao lote e validade do produto. A tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes \"manualmente\" por API."},"IBS_CBS":{"type":"object","properties":{"cCstIbsCbs":{"type":"string","description":"Código de Situação Tributária do IBS e CBS."},"cClassTrib":{"type":"string","description":"Código de Classificação Tributária do IBS e CBS."},"nBaseIbsCbs":{"type":"decimal","description":"Base de cálculo do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será calculado automaticamente."}}},"IBS":{"type":"object","properties":{"nAliqIbsUf":{"type":"decimal","description":"Alíquota do IBS de competência das UF."},"nPercDiferimentoIbsUf":{"type":"decimal","description":"Percentual do Diferimento - IBS UF."},"nPercReducaoIbsUf":{"type":"decimal","description":"Percentual da redução de alíquota - IBS UF."},"nValDiferimentoIbsUf":{"type":"decimal","description":"Valor do Diferimento - IBS UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será calculado automaticamente."},"nValIbsUf":{"type":"decimal","description":"Valor do IBS de competência da UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será calculado automaticamente."},"nAliqIbsMun":{"type":"decimal","description":"Alíquota do IBS de competência do Município."},"nPercDiferimentoIbsMun":{"type":"decimal","description":"Percentual do diferimento - UBS Município."},"nPercReducaoIbsMun":{"type":"decimal","description":"Percentual da redução de alíquota - IBS Município."},"nValDiferimentoIbsMun":{"type":"decimal","description":"Valor do Diferimento - IBS Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será calculado automaticamente."},"nValIbsMun":{"type":"decimal","description":"Valor do IBS de competência do Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será calculado automaticamente."},"nValIbs":{"type":"decimal","description":"Valor total do IBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será calculado automaticamente."}}},"CBS":{"type":"object","properties":{"nAliqCbs":{"type":"decimal","description":"Alíquota da CBS."},"nPercDiferimentoCbs":{"type":"decimal","description":"Percentual do diferimento - CBS."},"nPercReducaoCbs":{"type":"decimal","description":"Percentual da redução de alíquota - CBS."},"nValDiferimentoCbs":{"type":"decimal","description":"Valor do diferimento - CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será calculado automaticamente."},"nValCbs":{"type":"decimal","description":"Valor da CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será calculado automaticamente."}}},"TRIB_REG":{"type":"object","properties":{"cCstIbsCbsReg":{"type":"string","description":"Código da Situação Tributária do IBS e CBS (Tributação Regular)."},"cClassTribReg":{"type":"string","description":"Código de Classificação Tributária do IBS e CBS (Tributação Regular)."},"nAliqIbsUfReg":{"type":"decimal","description":"Valor da alíquota do IBS da UF na tributação regular."},"nAliqIbsMunReg":{"type":"decimal","description":"Valor da alíquota do IBS do Município na tributação regular."},"nAliqCbsReg":{"type":"decimal","description":"Valor da alíquota da CBS na tributação regular."},"nValIbsUfReg":{"type":"decimal","description":"Valor do Tributo do IBS da UF na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será calculado automaticamente."},"nValIbsMunReg":{"type":"decimal","description":"Valor do Tributo do IBS do Município na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será calculado automaticamente."},"nValCbsReg":{"type":"decimal","description":"Valor do Tributo da CBS na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será calculado automaticamente."}}}}}},"departamentos":{"type":"array","items":{"type":"object","properties":{"cCodDepto":{"type":"string","description":"Código do Departamento - Preenchimento obrigatório. Informação localizada na Aba \"Departamentos\" da Nota de Entrada. Utilize a tag \"codigo\" do método \"ListarDepatartamentos\" da API /api/v1/geral/departamentos/ para obter essa informação."},"nValor":{"type":"decimal","description":"Valor do rateio - Preenchimento obrigatório. Informação localizada na Aba \"Departamentos\" da Nota de Entrada."},"nPerc":{"type":"decimal","description":"Percentual do rateio - Preenchimento obrigatório. Informação localizada na Aba \"Departamentos\" da Nota de Entrada."}}}}}}}},"title":"ListarNotaEnt (retorno)"},"produtos_notaentrada_StatusNotaEnt":{"type":"object","title":"StatusNotaEnt","description":"Status de nota de entrada.","required":["call","param"],"properties":{"call":{"type":"string","enum":["StatusNotaEnt"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodNotaEnt":{"type":"integer","maxLength":15,"description":"Código da nota de entrada."},"cCodIntNotaEnt":{"type":"string","maxLength":20,"description":"Código de integração da nota de entrada."}}}}},"example":{"call":"StatusNotaEnt","param":[{"nCodNotaEnt":112233}]}},"produtos_notaentrada_StatusNotaEnt_retorno":{"type":"object","properties":{"nCodNotaEnt":{"type":"integer","description":"Código da nota de entrada."},"cCodIntNotaEnt":{"type":"string","description":"Código de integração da nota de entrada."},"cNumeroNotaEnt":{"type":"string","description":"Número da nota de entrada exibido na tela."},"cancelada":{"type":"string","description":"NF-e Cancelada?"},"faturada":{"type":"string"},"cAmbiente":{"type":"string"},"nValorTotal":{"type":"decimal","description":"Valor total da nota de entrada."},"ListaNfe":{"type":"array","items":{"type":"object","properties":{"nNumLote":{"type":"integer","description":"Número do lote da NF-e."},"cStatusLote":{"type":"string","description":"Status do Lote da NF-e."},"nRecibo":{"type":"integer","description":"Recibo."},"contingencia":{"type":"string","description":"NF-e emitida em contingência."},"cNumNFe":{"type":"string","description":"Número da NF-e gerada."},"cSerieNFe":{"type":"string","description":"Série da NF-e."},"cStatusNFe":{"type":"string","description":"Status da NF-e."},"cChaveNFe":{"type":"string","description":"Chave de Acesso da NF-e."},"nProtocolo":{"type":"integer","description":"Número do Protocolo."},"cTipo":{"type":"string","description":"Tipo de Emissão. Pode ser: E - Entrada S - Saída."},"dtEmissao":{"type":"string","description":"Data da Emissão da NF-e."},"hrEmissao":{"type":"string","description":"Hora da Emissão da NF-e."},"dtFatura":{"type":"string","description":"Data do faturamento."},"hrFatura":{"type":"string","description":"Hora de Faturamento."},"dtSaida":{"type":"string","description":"Data de Saída."},"hrSaida":{"type":"string","description":"Hora de Saída da NF-e."},"mensagens":{"type":"array","items":{"type":"object","properties":{"cCodigo":{"type":"string","description":"Código da mensagem de erro/aviso."},"cDescricao":{"type":"string","description":"Descrição da mensagem de erro/aviso."},"cCorrecao":{"type":"string","description":"Correção da descrição de mensagem de erro/aviso."}}},"description":"Mensagens de Erros."},"cXmlDistribuicao":{"type":"string","description":"XML de distribuição da NF-e."},"cDanfe":{"type":"string","description":"Link para o DANFE da NF-e gerada."}}},"description":"Lista de NF-es geradas."}},"title":"StatusNotaEnt (retorno)"},"produtos_notaentradafat_CancelarNotaEnt":{"type":"object","title":"CancelarNotaEnt","description":"Cancelar nota de entrada.","required":["call","param"],"properties":{"call":{"type":"string","enum":["CancelarNotaEnt"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodNotaEnt":{"type":"integer","maxLength":15,"description":"ID da nota de entrada."},"cCodIntNotaEnt":{"type":"string","maxLength":20,"description":"Código de integração da nota de entrada."}}}}},"example":{"call":"CancelarNotaEnt","param":[{"nCodNotaEnt":0,"cCodIntNotaEnt":""}]}},"produtos_notaentradafat_CancelarNotaEnt_retorno":{"type":"object","properties":{"nCodNotaEnt":{"type":"integer","description":"ID da nota de entrada. Esse campo não é exibido na tela. É uma informação interna, utilizada apenas nas APIs."},"cCodIntNotaEnt":{"type":"string","description":"Código de integração da nota de entrada. Preencha esse campo com o código da nota de entrada no aplicativo que você está integrando com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de notas de entrada você conseguirá ver a relação entre o id da nota de entrada gerado no Omie e o código de nota de entrada existente em sua aplicação."},"cCodStatus":{"type":"string","description":"Código do status."},"cDescStatus":{"type":"string","description":"Descrição do status."}},"title":"CancelarNotaEnt (retorno)"},"produtos_notaentradafat_ConcluirNotaEnt":{"type":"object","title":"ConcluirNotaEnt","description":"Concluir nota de entrada.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConcluirNotaEnt"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodNotaEnt":{"type":"integer","maxLength":15,"description":"ID da nota de entrada."},"cCodIntNotaEnt":{"type":"string","maxLength":20,"description":"Código de integração da nota de entrada."}}}}},"example":{"call":"ConcluirNotaEnt","param":[{"nCodNotaEnt":0,"cCodIntNotaEnt":""}]}},"produtos_notaentradafat_ConcluirNotaEnt_retorno":{"type":"object","properties":{"nCodNotaEnt":{"type":"integer","description":"ID da nota de entrada. Esse campo não é exibido na tela. É uma informação interna, utilizada apenas nas APIs."},"cCodIntNotaEnt":{"type":"string","description":"Código de integração da nota de entrada. Preencha esse campo com o código da nota de entrada no aplicativo que você está integrando com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de notas de entrada você conseguirá ver a relação entre o id da nota de entrada gerado no Omie e o código de nota de entrada existente em sua aplicação."},"cCodStatus":{"type":"string","description":"Código do status."},"cDescStatus":{"type":"string","description":"Descrição do status."}},"title":"ConcluirNotaEnt (retorno)"},"produtos_notaentradafat_ConferirNotaEnt":{"type":"object","title":"ConferirNotaEnt","description":"Conferir nota de entrada.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConferirNotaEnt"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodNotaEnt":{"type":"integer","maxLength":15,"description":"ID da nota de entrada."},"cCodIntNotaEnt":{"type":"string","maxLength":20,"description":"Código de integração da nota de entrada."}}}}},"example":{"call":"ConferirNotaEnt","param":[{"nCodNotaEnt":0,"cCodIntNotaEnt":""}]}},"produtos_notaentradafat_ConferirNotaEnt_retorno":{"type":"object","properties":{"nCodNotaEnt":{"type":"integer","description":"ID da nota de entrada. Esse campo não é exibido na tela. É uma informação interna, utilizada apenas nas APIs."},"cCodIntNotaEnt":{"type":"string","description":"Código de integração da nota de entrada. Preencha esse campo com o código da nota de entrada no aplicativo que você está integrando com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de notas de entrada você conseguirá ver a relação entre o id da nota de entrada gerado no Omie e o código de nota de entrada existente em sua aplicação."},"cCodStatus":{"type":"string","description":"Código do status."},"cDescStatus":{"type":"string","description":"Descrição do status."}},"title":"ConferirNotaEnt (retorno)"},"produtos_notaentradafat_DuplicarNotaEnt":{"type":"object","title":"DuplicarNotaEnt","description":"Duplicar nota de entrada.","required":["call","param"],"properties":{"call":{"type":"string","enum":["DuplicarNotaEnt"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodNotaEnt":{"type":"integer","maxLength":15,"description":"ID da nota de entrada."},"cCodIntNotaEnt":{"type":"string","maxLength":20,"description":"Código de integração da nota de entrada."}}}}},"example":{"call":"DuplicarNotaEnt","param":[{"nCodNotaEnt":0,"cCodIntNotaEnt":""}]}},"produtos_notaentradafat_DuplicarNotaEnt_retorno":{"type":"object","properties":{"nCodNotaEnt":{"type":"integer","description":"ID da nota de entrada. Esse campo não é exibido na tela. É uma informação interna, utilizada apenas nas APIs."},"cCodIntNotaEnt":{"type":"string","description":"Código de integração da nota de entrada. Preencha esse campo com o código da nota de entrada no aplicativo que você está integrando com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de notas de entrada você conseguirá ver a relação entre o id da nota de entrada gerado no Omie e o código de nota de entrada existente em sua aplicação."},"cCodStatus":{"type":"string","description":"Código do status."},"cDescStatus":{"type":"string","description":"Descrição do status."}},"title":"DuplicarNotaEnt (retorno)"},"produtos_notafiscalutil_GetUrlDanfe":{"type":"object","title":"GetUrlDanfe","description":"Retorna o DANFE emitido da Nota Fiscal eletrônica.","required":["call","param"],"properties":{"call":{"type":"string","enum":["GetUrlDanfe"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodNF":{"type":"integer","maxLength":15,"description":"Código da Nota Fiscal."},"cCodNFInt":{"type":"string","maxLength":20,"description":"Código de Integração da Nota Fiscal."}}}}},"example":{"call":"GetUrlDanfe","param":[{"nCodNF":0,"cCodNFInt":""}]}},"produtos_notafiscalutil_GetUrlDanfe_retorno":{"type":"object","properties":{"cUrlDanfe":{"type":"string","description":"URL do DANFE da Nota Fiscal."},"dtValUrl":{"type":"string"}},"title":"GetUrlDanfe (retorno)"},"produtos_notafiscalutil_GetUrlLogo":{"type":"object","title":"GetUrlLogo","description":"Retorna a URL do Logotipo.","required":["call","param"],"properties":{"call":{"type":"string","enum":["GetUrlLogo"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodEmpr":{"type":"integer","maxLength":15},"cCodEmprInt":{"type":"string","maxLength":20}}}}},"example":{"call":"GetUrlLogo","param":[{"nCodEmpr":0,"cCodEmprInt":""}]}},"produtos_notafiscalutil_GetUrlLogo_retorno":{"type":"object","properties":{"cUrlLogo":{"type":"string"},"dtValUrl":{"type":"string"}},"title":"GetUrlLogo (retorno)"},"produtos_notafiscalutil_GetUrlNotaFiscal":{"type":"object","title":"GetUrlNotaFiscal","description":"Retorna a URL da Nota Fiscal.","required":["call","param"],"properties":{"call":{"type":"string","enum":["GetUrlNotaFiscal"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodNF":{"type":"integer","maxLength":15,"description":"Código da Nota Fiscal."},"cCodNFInt":{"type":"string","maxLength":20,"description":"Código de Integração da Nota Fiscal."}}}}},"example":{"call":"GetUrlNotaFiscal","param":[{"nCodNF":0,"cCodNFInt":""}]}},"produtos_notafiscalutil_GetUrlNotaFiscal_retorno":{"type":"object","properties":{"cUrlNF":{"type":"string","description":"URL da Nota Fiscal."},"dtValUrl":{"type":"string"}},"title":"GetUrlNotaFiscal (retorno)"},"produtos_op_AlterarOrdemProducao":{"type":"object","title":"AlterarOrdemProducao","description":"Alteração de Ordem de Produção.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarOrdemProducao"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"identificacao":{"type":"object","properties":{"nCodOP":{"type":"integer","maxLength":15,"description":"Código da ordem de produção.\n(Gerado internamente, não é visualizado na tela)."},"cCodIntOP":{"type":"string","maxLength":20,"description":"Código de integração da ordem de produção.\n(Utilizado em títulos criados via API, não é visualizado na tela)."},"cNumOP":{"type":"string","maxLength":15,"description":"Número da ordem de produção."},"nCodProduto":{"type":"integer","maxLength":15,"description":"Código do produto.\n(Gerado internamente, não é visualizado na tela)."},"cCodIntProd":{"type":"string","maxLength":60,"description":"Código de Integração do Produto\n(Utilizado para integração via API, não aparece na tela)."},"dDtPrevisao":{"type":"string","maxLength":10,"description":"Data de previsão da conclusão da produção."},"nQtde":{"type":"number","maxLength":18,"description":"Quantidade a produzir."},"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do Local do Estoque.\n\n\nCaso não informado assumirá o Local do Estoque padrão."},"cReservado":{"type":"string","maxLength":1,"example":"S","description":"Preencher com \"S\" ou \"N\"\n\nDefault \"N\"\n\nUtilizado apenas nos métodos de inclusão e alteração"},"lote_validade_op":{"type":"object","properties":{"nIdLote":{"type":"integer","maxLength":15,"description":"Id do lote do produto.\n\n\nQuando informado, vincula um lote já existente. Quando não informado, a tag\n[cNumLote] passa a ser obrigatória e o lote é criado no momento da conclusão\nda Ordem de Produção."},"cNumLote":{"type":"string","maxLength":60,"description":"Número do lote do produto.\n\n\nDeve ser informado apenas quando a tag [nIdLote] não for informada, com isso,\nserá criado um novo lote a partir do número informado."},"cCodAgreg":{"type":"string","maxLength":20,"description":"Código de agregação do lote do produto.\n\n\nDeve ser informado apenas quando a tag [nIdLote] não for informada."},"dDataFab":{"type":"string","description":"Data de fabricação do lote.\n\n\nDeve ser informado apenas quando a tag [nIdLote] não for informada.\n\n\nComo default é utilizado a data atual."},"dDataVal":{"type":"string","description":"Data de validade do lote.\n\n\nDeve ser informado apenas quando a tag [nIdLote] não for informada.\n\n\nQuando não informada, é calculada a partir do prazo de validade cadastrado\nno produto; se o produto não tiver prazo cadastrado, o preenchimento é obrigatório."}},"required":["dDataVal"],"description":"Informações referente ao lote e validade do produto principal da Ordem de Produção.\n\n\nSomente um lote pode ser informado para o produto principal — a quantidade é a\nprópria quantidade a produzir informada na tag [nQtde]."}}},"infAdicionais":{"type":"object","properties":{"dDtInicio":{"type":"string","maxLength":10,"description":"Data de início da produção."},"dDtConclusao":{"type":"string","maxLength":10,"description":"Data de conclusão da produção."},"nCodProjeto":{"type":"integer","maxLength":15,"description":"Código do projeto.\n(Gerado internamente, não é visualizado na tela)."},"cEtapa":{"type":"string","maxLength":2,"description":"Etapa da Ordem de Produção."}}},"observacoes":{"type":"object","properties":{"cObs":{"type":"string","description":"Observações da ordem de produção."}}},"outrasInf":{"type":"object","properties":{"cConcluida":{"type":"string","maxLength":1,"description":"Indica se a ordem de produção está concluída."},"dConclusao":{"type":"string","maxLength":10,"description":"Data da conclusão."},"hConclusao":{"type":"string","maxLength":8,"description":"Hora da conclusão."},"dInclusao":{"type":"string","maxLength":10,"description":"Data de inclusão da oportunidade."},"hInclusao":{"type":"string","maxLength":8,"description":"Hora de inclusão da oportunidade."},"uInc":{"type":"string","maxLength":10,"description":"Usuário da Inclusão."},"dAlteracao":{"type":"string","maxLength":10,"description":"Data de alteração da oportunidade."},"hAlteracao":{"type":"string","maxLength":8,"description":"Hora de alteração da oportunidade."},"uAlt":{"type":"string","maxLength":10,"description":"Usuário da Alteração."}}},"itens":{"type":"array","items":{"type":"object","properties":{"nIdProdutoMalha":{"type":"integer","maxLength":15,"description":"ID do produto da malha."},"cUtilizarDoEstoque":{"type":"string","maxLength":1,"description":"Utilizar os itens que já estão prontos no estoque deste produto\n\nValores possíveis:\n\nS = Sim\nN = Não."},"lote_validade":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","maxLength":15,"description":"Código do lote."},"nQtdLote":{"type":"number","maxLength":19,"description":"Quantidade do lote."}}},"description":"Informação do lote."}},"required":["cUtilizarDoEstoque","nIdProdutoMalha"]},"description":"Itens da ordem de produção."}}}}},"example":{"call":"AlterarOrdemProducao","param":[{"identificacao":{"cCodIntOP":"OP0001","dDtPrevisao":"30/09/2026","nCodProduto":0,"nQtde":3}}]}},"produtos_op_AlterarOrdemProducao_retorno":{"type":"object","properties":{"nCodOP":{"type":"integer","description":"Código da ordem de produção."},"cCodIntOP":{"type":"string","description":"Código de integração da ordem de produção."},"cCodStatus":{"type":"string","description":"Código do Status."},"cDesStatus":{"type":"string","description":"Descrição do Status."}},"title":"AlterarOrdemProducao (retorno)"},"produtos_op_ConcluirOrdemProducao":{"type":"object","title":"ConcluirOrdemProducao","description":"Conclui a Ordem de Produção.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConcluirOrdemProducao"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodOP":{"type":"integer","maxLength":15,"description":"Código da ordem de produção."},"cCodIntOP":{"type":"string","maxLength":20,"description":"Código de integração da ordem de produção."},"dDtConclusao":{"type":"string","maxLength":10,"description":"Data da conclusão da ordem de produção."},"nQtdeProduzida":{"type":"number","maxLength":18,"description":"Quantidade produzida."},"cObsConclusao":{"type":"string","description":"Observação da ordem de produção."}},"required":["dDtConclusao","nQtdeProduzida"]}}},"example":{"call":"ConcluirOrdemProducao","param":[{"cCodIntOP":"","nCodOP":0,"dDtConclusao":"30/09/2026","nQtdeProduzida":3,"cObsConclusao":""}]}},"produtos_op_ConcluirOrdemProducao_retorno":{"type":"object","properties":{"nCodOP":{"type":"integer","description":"Código da ordem de produção."},"cCodIntOP":{"type":"string","description":"Código de integração da ordem de produção."},"cCodStatus":{"type":"string","description":"Código do Status."},"cDesStatus":{"type":"string","description":"Descrição do Status."}},"title":"ConcluirOrdemProducao (retorno)"},"produtos_op_ConsultarOrdemProducao":{"type":"object","title":"ConsultarOrdemProducao","description":"Consulta da ordem de produção.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarOrdemProducao"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodOP":{"type":"integer","maxLength":15,"description":"Código da ordem de produção."},"cCodIntOP":{"type":"string","maxLength":20,"description":"Código de integração da ordem de produção."}}}}},"example":{"call":"ConsultarOrdemProducao","param":[{"cCodIntOP":"","nCodOP":0}]}},"produtos_op_ConsultarOrdemProducao_retorno":{"type":"object","properties":{"identificacao":{"type":"object","properties":{"nCodOP":{"type":"integer","description":"Código da ordem de produção. (Gerado internamente, não é visualizado na tela)."},"cCodIntOP":{"type":"string","description":"Código de integração da ordem de produção. (Utilizado em títulos criados via API, não é visualizado na tela)."},"cNumOP":{"type":"string","description":"Número da ordem de produção."},"nCodProduto":{"type":"integer","description":"Código do produto. (Gerado internamente, não é visualizado na tela)."},"cCodIntProd":{"type":"string","description":"Código de Integração do Produto (Utilizado para integração via API, não aparece na tela)."},"dDtPrevisao":{"type":"string","description":"Data de previsão da conclusão da produção."},"nQtde":{"type":"decimal","description":"Quantidade a produzir."},"codigo_local_estoque":{"type":"integer","description":"Código do Local do Estoque. Caso não informado assumirá o Local do Estoque padrão."},"cReservado":{"type":"string","description":"Preencher com \"S\" ou \"N\" Default \"N\" Utilizado apenas nos métodos de inclusão e alteração"},"lote_validade_op":{"type":"object","properties":{"nIdLote":{"type":"integer","description":"Id do lote do produto. Quando informado, vincula um lote já existente. Quando não informado, a tag [cNumLote] passa a ser obrigatória e o lote é criado no momento da conclusão da Ordem de Produção."},"cNumLote":{"type":"string","description":"Número do lote do produto. Deve ser informado apenas quando a tag [nIdLote] não for informada, com isso, será criado um novo lote a partir do número informado."},"cCodAgreg":{"type":"string","description":"Código de agregação do lote do produto. Deve ser informado apenas quando a tag [nIdLote] não for informada."},"dDataFab":{"type":"string","description":"Data de fabricação do lote. Deve ser informado apenas quando a tag [nIdLote] não for informada. Como default é utilizado a data atual."},"dDataVal":{"type":"string","description":"Data de validade do lote. Deve ser informado apenas quando a tag [nIdLote] não for informada. Quando não informada, é calculada a partir do prazo de validade cadastrado no produto; se o produto não tiver prazo cadastrado, o preenchimento é obrigatório."}},"description":"Informações referente ao lote e validade do produto principal da Ordem de Produção. Somente um lote pode ser informado para o produto principal — a quantidade é a própria quantidade a produzir informada na tag [nQtde]."}}},"infAdicionais":{"type":"object","properties":{"dDtInicio":{"type":"string","description":"Data de início da produção."},"dDtConclusao":{"type":"string","description":"Data de conclusão da produção."},"nCodProjeto":{"type":"integer","description":"Código do projeto. (Gerado internamente, não é visualizado na tela)."},"cEtapa":{"type":"string","description":"Etapa da Ordem de Produção."}}},"observacoes":{"type":"object","properties":{"cObs":{"type":"string","description":"Observações da ordem de produção."}}},"outrasInf":{"type":"object","properties":{"cConcluida":{"type":"string","description":"Indica se a ordem de produção está concluída."},"dConclusao":{"type":"string","description":"Data da conclusão."},"hConclusao":{"type":"string","description":"Hora da conclusão."},"dInclusao":{"type":"string","description":"Data de inclusão da oportunidade."},"hInclusao":{"type":"string","description":"Hora de inclusão da oportunidade."},"uInc":{"type":"string","description":"Usuário da Inclusão."},"dAlteracao":{"type":"string","description":"Data de alteração da oportunidade."},"hAlteracao":{"type":"string","description":"Hora de alteração da oportunidade."},"uAlt":{"type":"string","description":"Usuário da Alteração."}}},"itens":{"type":"array","items":{"type":"object","properties":{"nIdProdutoMalha":{"type":"integer","description":"ID do produto da malha."},"cUtilizarDoEstoque":{"type":"string","description":"Utilizar os itens que já estão prontos no estoque deste produto Valores possíveis: S = Sim N = Não."},"lote_validade":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","description":"Código do lote."},"nQtdLote":{"type":"decimal","description":"Quantidade do lote."}}},"description":"Informação do lote."}}},"description":"Itens da ordem de produção."},"itensDetalhes":{"type":"array","items":{"type":"object","properties":{"nIdProdutoMalha":{"type":"integer","description":"ID do produto da malha."},"cUtilizarDoEstoque":{"type":"string","description":"Utilizar os itens que já estão prontos no estoque deste produto Valores possíveis: S = Sim N = Não."},"cReservado":{"type":"string","description":"Reserva o estoque dos itens da ordem de produção. Valores possíveis: S = Sim N = Não."},"nQtde":{"type":"decimal","description":"Quantidade necessária do item."},"codigo_local_estoque":{"type":"integer","description":"Código do local do estoque."},"cObs":{"type":"string","description":"Observação do Item."},"info":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão. No formato dd/mm/aaaa."},"hInc":{"type":"string","description":"Hora da Inclusão. No formato hh:mm:ss."},"uInc":{"type":"string","description":"Usuário da Inclusão."},"dAlt":{"type":"string","description":"Data da Alteração. No formato dd/mm/aaaa."},"hAlt":{"type":"string","description":"Hora da Alteração. No formato hh:mm:ss."},"uAlt":{"type":"string","description":"Usuário da Alteração."}},"description":"Informações complementares do Item."}}},"description":"Detalhes dos itens da Ordem de Produção."}},"title":"ConsultarOrdemProducao (retorno)"},"produtos_op_ExcluirOrdemProducao":{"type":"object","title":"ExcluirOrdemProducao","description":"Exclusão da Ordem de Produção.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirOrdemProducao"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodOP":{"type":"integer","maxLength":15,"description":"Código da ordem de produção."},"cCodIntOP":{"type":"string","maxLength":20,"description":"Código de integração da ordem de produção."}}}}},"example":{"call":"ExcluirOrdemProducao","param":[{"cCodIntOP":"","nCodOP":0}]}},"produtos_op_ExcluirOrdemProducao_retorno":{"type":"object","properties":{"nCodOP":{"type":"integer","description":"Código da ordem de produção."},"cCodIntOP":{"type":"string","description":"Código de integração da ordem de produção."},"cCodStatus":{"type":"string","description":"Código do Status."},"cDesStatus":{"type":"string","description":"Descrição do Status."}},"title":"ExcluirOrdemProducao (retorno)"},"produtos_op_IncluirOrdemProducao":{"type":"object","title":"IncluirOrdemProducao","description":"Inclusão de Ordem de Produção.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirOrdemProducao"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"identificacao":{"type":"object","properties":{"nCodOP":{"type":"integer","maxLength":15,"description":"Código da ordem de produção.\n(Gerado internamente, não é visualizado na tela)."},"cCodIntOP":{"type":"string","maxLength":20,"description":"Código de integração da ordem de produção.\n(Utilizado em títulos criados via API, não é visualizado na tela)."},"cNumOP":{"type":"string","maxLength":15,"description":"Número da ordem de produção."},"nCodProduto":{"type":"integer","maxLength":15,"description":"Código do produto.\n(Gerado internamente, não é visualizado na tela)."},"cCodIntProd":{"type":"string","maxLength":60,"description":"Código de Integração do Produto\n(Utilizado para integração via API, não aparece na tela)."},"dDtPrevisao":{"type":"string","maxLength":10,"description":"Data de previsão da conclusão da produção."},"nQtde":{"type":"number","maxLength":18,"description":"Quantidade a produzir."},"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do Local do Estoque.\n\n\nCaso não informado assumirá o Local do Estoque padrão."},"cReservado":{"type":"string","maxLength":1,"example":"S","description":"Preencher com \"S\" ou \"N\"\n\nDefault \"N\"\n\nUtilizado apenas nos métodos de inclusão e alteração"},"lote_validade_op":{"type":"object","properties":{"nIdLote":{"type":"integer","maxLength":15,"description":"Id do lote do produto.\n\n\nQuando informado, vincula um lote já existente. Quando não informado, a tag\n[cNumLote] passa a ser obrigatória e o lote é criado no momento da conclusão\nda Ordem de Produção."},"cNumLote":{"type":"string","maxLength":60,"description":"Número do lote do produto.\n\n\nDeve ser informado apenas quando a tag [nIdLote] não for informada, com isso,\nserá criado um novo lote a partir do número informado."},"cCodAgreg":{"type":"string","maxLength":20,"description":"Código de agregação do lote do produto.\n\n\nDeve ser informado apenas quando a tag [nIdLote] não for informada."},"dDataFab":{"type":"string","description":"Data de fabricação do lote.\n\n\nDeve ser informado apenas quando a tag [nIdLote] não for informada.\n\n\nComo default é utilizado a data atual."},"dDataVal":{"type":"string","description":"Data de validade do lote.\n\n\nDeve ser informado apenas quando a tag [nIdLote] não for informada.\n\n\nQuando não informada, é calculada a partir do prazo de validade cadastrado\nno produto; se o produto não tiver prazo cadastrado, o preenchimento é obrigatório."}},"required":["dDataVal"],"description":"Informações referente ao lote e validade do produto principal da Ordem de Produção.\n\n\nSomente um lote pode ser informado para o produto principal — a quantidade é a\nprópria quantidade a produzir informada na tag [nQtde]."}}},"infAdicionais":{"type":"object","properties":{"dDtInicio":{"type":"string","maxLength":10,"description":"Data de início da produção."},"dDtConclusao":{"type":"string","maxLength":10,"description":"Data de conclusão da produção."},"nCodProjeto":{"type":"integer","maxLength":15,"description":"Código do projeto.\n(Gerado internamente, não é visualizado na tela)."},"cEtapa":{"type":"string","maxLength":2,"description":"Etapa da Ordem de Produção."}}},"observacoes":{"type":"object","properties":{"cObs":{"type":"string","description":"Observações da ordem de produção."}}},"outrasInf":{"type":"object","properties":{"cConcluida":{"type":"string","maxLength":1,"description":"Indica se a ordem de produção está concluída."},"dConclusao":{"type":"string","maxLength":10,"description":"Data da conclusão."},"hConclusao":{"type":"string","maxLength":8,"description":"Hora da conclusão."},"dInclusao":{"type":"string","maxLength":10,"description":"Data de inclusão da oportunidade."},"hInclusao":{"type":"string","maxLength":8,"description":"Hora de inclusão da oportunidade."},"uInc":{"type":"string","maxLength":10,"description":"Usuário da Inclusão."},"dAlteracao":{"type":"string","maxLength":10,"description":"Data de alteração da oportunidade."},"hAlteracao":{"type":"string","maxLength":8,"description":"Hora de alteração da oportunidade."},"uAlt":{"type":"string","maxLength":10,"description":"Usuário da Alteração."}}},"itens":{"type":"array","items":{"type":"object","properties":{"nIdProdutoMalha":{"type":"integer","maxLength":15,"description":"ID do produto da malha."},"cUtilizarDoEstoque":{"type":"string","maxLength":1,"description":"Utilizar os itens que já estão prontos no estoque deste produto\n\nValores possíveis:\n\nS = Sim\nN = Não."},"lote_validade":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","maxLength":15,"description":"Código do lote."},"nQtdLote":{"type":"number","maxLength":19,"description":"Quantidade do lote."}}},"description":"Informação do lote."}},"required":["cUtilizarDoEstoque","nIdProdutoMalha"]},"description":"Itens da ordem de produção."}}}}},"example":{"call":"IncluirOrdemProducao","param":[{"identificacao":{"cCodIntOP":"OP0001","dDtPrevisao":"30/09/2026","nCodProduto":0,"nQtde":3}}]}},"produtos_op_IncluirOrdemProducao_retorno":{"type":"object","properties":{"nCodOP":{"type":"integer","description":"Código da ordem de produção."},"cCodIntOP":{"type":"string","description":"Código de integração da ordem de produção."},"cCodStatus":{"type":"string","description":"Código do Status."},"cDesStatus":{"type":"string","description":"Descrição do Status."}},"title":"IncluirOrdemProducao (retorno)"},"produtos_op_ListarOrdemProducao":{"type":"object","title":"ListarOrdemProducao","description":"Listagem de Ordem de Produção.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarOrdemProducao"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"apenas_importado_api":{"type":"string","maxLength":1,"description":"Exibir apenas os registros gerados pela API"},"ordenar_por":{"type":"string","maxLength":100,"description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."},"nCodProjeto":{"type":"integer","maxLength":15,"description":"Código do projeto.\n(Gerado internamente, não é visualizado na tela)."},"nIdProd":{"type":"integer","maxLength":15,"description":"ID do produto"},"lExibirItens":{"type":"boolean","description":"Exibir os itens da ordem de produção.\n\nSerá retornado os detalhes dos itens da ordem de produção na tag \"itensDetalhes\".\n\nDefault false\n\nPode ser:\nfalse\ntrue"},"dDtConclusaoDe":{"type":"string","maxLength":10,"description":"Data inicial da consulta de Ordem de Produção por data de conclusão."},"dDtConclusaoAte":{"type":"string","maxLength":10,"description":"Data final da consulta de Ordem de Produção por data de conclusão."},"cConcluida":{"type":"string","maxLength":1,"description":"Indica se a ordem de produção está concluída."}}}}},"example":{"call":"ListarOrdemProducao","param":[{"pagina":1,"registros_por_pagina":20,"dDtConclusaoDe":"30/09/2026","dDtConclusaoAte":"30/09/2026"}]}},"produtos_op_ListarOrdemProducao_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada"},"total_de_paginas":{"type":"integer","description":"Número total de páginas"},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"total de registros encontrados"},"cadastros":{"type":"array","items":{"type":"object","properties":{"identificacao":{"type":"object","properties":{"nCodOP":{"type":"integer","description":"Código da ordem de produção. (Gerado internamente, não é visualizado na tela)."},"cCodIntOP":{"type":"string","description":"Código de integração da ordem de produção. (Utilizado em títulos criados via API, não é visualizado na tela)."},"cNumOP":{"type":"string","description":"Número da ordem de produção."},"nCodProduto":{"type":"integer","description":"Código do produto. (Gerado internamente, não é visualizado na tela)."},"cCodIntProd":{"type":"string","description":"Código de Integração do Produto (Utilizado para integração via API, não aparece na tela)."},"dDtPrevisao":{"type":"string","description":"Data de previsão da conclusão da produção."},"nQtde":{"type":"decimal","description":"Quantidade a produzir."},"codigo_local_estoque":{"type":"integer","description":"Código do Local do Estoque. Caso não informado assumirá o Local do Estoque padrão."},"cReservado":{"type":"string","description":"Preencher com \"S\" ou \"N\" Default \"N\" Utilizado apenas nos métodos de inclusão e alteração"},"lote_validade_op":{"type":"object","properties":{"nIdLote":{"type":"integer","description":"Id do lote do produto. Quando informado, vincula um lote já existente. Quando não informado, a tag [cNumLote] passa a ser obrigatória e o lote é criado no momento da conclusão da Ordem de Produção."},"cNumLote":{"type":"string","description":"Número do lote do produto. Deve ser informado apenas quando a tag [nIdLote] não for informada, com isso, será criado um novo lote a partir do número informado."},"cCodAgreg":{"type":"string","description":"Código de agregação do lote do produto. Deve ser informado apenas quando a tag [nIdLote] não for informada."},"dDataFab":{"type":"string","description":"Data de fabricação do lote. Deve ser informado apenas quando a tag [nIdLote] não for informada. Como default é utilizado a data atual."},"dDataVal":{"type":"string","description":"Data de validade do lote. Deve ser informado apenas quando a tag [nIdLote] não for informada. Quando não informada, é calculada a partir do prazo de validade cadastrado no produto; se o produto não tiver prazo cadastrado, o preenchimento é obrigatório."}},"description":"Informações referente ao lote e validade do produto principal da Ordem de Produção. Somente um lote pode ser informado para o produto principal — a quantidade é a própria quantidade a produzir informada na tag [nQtde]."}}},"infAdicionais":{"type":"object","properties":{"dDtInicio":{"type":"string","description":"Data de início da produção."},"dDtConclusao":{"type":"string","description":"Data de conclusão da produção."},"nCodProjeto":{"type":"integer","description":"Código do projeto. (Gerado internamente, não é visualizado na tela)."},"cEtapa":{"type":"string","description":"Etapa da Ordem de Produção."}}},"observacoes":{"type":"object","properties":{"cObs":{"type":"string","description":"Observações da ordem de produção."}}},"outrasInf":{"type":"object","properties":{"cConcluida":{"type":"string","description":"Indica se a ordem de produção está concluída."},"dConclusao":{"type":"string","description":"Data da conclusão."},"hConclusao":{"type":"string","description":"Hora da conclusão."},"dInclusao":{"type":"string","description":"Data de inclusão da oportunidade."},"hInclusao":{"type":"string","description":"Hora de inclusão da oportunidade."},"uInc":{"type":"string","description":"Usuário da Inclusão."},"dAlteracao":{"type":"string","description":"Data de alteração da oportunidade."},"hAlteracao":{"type":"string","description":"Hora de alteração da oportunidade."},"uAlt":{"type":"string","description":"Usuário da Alteração."}}},"itens":{"type":"array","items":{"type":"object","properties":{"nIdProdutoMalha":{"type":"integer","description":"ID do produto da malha."},"cUtilizarDoEstoque":{"type":"string","description":"Utilizar os itens que já estão prontos no estoque deste produto Valores possíveis: S = Sim N = Não."},"lote_validade":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","description":"Código do lote."},"nQtdLote":{"type":"decimal","description":"Quantidade do lote."}}},"description":"Informação do lote."}}},"description":"Itens da ordem de produção."},"itensDetalhes":{"type":"array","items":{"type":"object","properties":{"nIdProdutoMalha":{"type":"integer","description":"ID do produto da malha."},"cUtilizarDoEstoque":{"type":"string","description":"Utilizar os itens que já estão prontos no estoque deste produto Valores possíveis: S = Sim N = Não."},"cReservado":{"type":"string","description":"Reserva o estoque dos itens da ordem de produção. Valores possíveis: S = Sim N = Não."},"nQtde":{"type":"decimal","description":"Quantidade necessária do item."},"codigo_local_estoque":{"type":"integer","description":"Código do local do estoque."},"cObs":{"type":"string","description":"Observação do Item."},"info":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão. No formato dd/mm/aaaa."},"hInc":{"type":"string","description":"Hora da Inclusão. No formato hh:mm:ss."},"uInc":{"type":"string","description":"Usuário da Inclusão."},"dAlt":{"type":"string","description":"Data da Alteração. No formato dd/mm/aaaa."},"hAlt":{"type":"string","description":"Hora da Alteração. No formato hh:mm:ss."},"uAlt":{"type":"string","description":"Usuário da Alteração."}},"description":"Informações complementares do Item."}}},"description":"Detalhes dos itens da Ordem de Produção."}}},"description":"Lista os cadastros encontrados."}},"title":"ListarOrdemProducao (retorno)"},"produtos_op_ReverterOrdemProducao":{"type":"object","title":"ReverterOrdemProducao","description":"Reversão da conclusão da ordem de produção.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ReverterOrdemProducao"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodOP":{"type":"integer","maxLength":15,"description":"Código da ordem de produção."},"cCodIntOP":{"type":"string","maxLength":20,"description":"Código de integração da ordem de produção."}}}}},"example":{"call":"ReverterOrdemProducao","param":[{"cCodIntOP":"","nCodOP":0}]}},"produtos_op_ReverterOrdemProducao_retorno":{"type":"object","properties":{"nCodOP":{"type":"integer","description":"Código da ordem de produção."},"cCodIntOP":{"type":"string","description":"Código de integração da ordem de produção."},"cCodStatus":{"type":"string","description":"Código do Status."},"cDesStatus":{"type":"string","description":"Descrição do Status."}},"title":"ReverterOrdemProducao (retorno)"},"produtos_op_UpsertOrdemProducao":{"type":"object","title":"UpsertOrdemProducao","description":"Upsert Ordem de Produção.","required":["call","param"],"properties":{"call":{"type":"string","enum":["UpsertOrdemProducao"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"identificacao":{"type":"object","properties":{"nCodOP":{"type":"integer","maxLength":15,"description":"Código da ordem de produção.\n(Gerado internamente, não é visualizado na tela)."},"cCodIntOP":{"type":"string","maxLength":20,"description":"Código de integração da ordem de produção.\n(Utilizado em títulos criados via API, não é visualizado na tela)."},"cNumOP":{"type":"string","maxLength":15,"description":"Número da ordem de produção."},"nCodProduto":{"type":"integer","maxLength":15,"description":"Código do produto.\n(Gerado internamente, não é visualizado na tela)."},"cCodIntProd":{"type":"string","maxLength":60,"description":"Código de Integração do Produto\n(Utilizado para integração via API, não aparece na tela)."},"dDtPrevisao":{"type":"string","maxLength":10,"description":"Data de previsão da conclusão da produção."},"nQtde":{"type":"number","maxLength":18,"description":"Quantidade a produzir."},"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do Local do Estoque.\n\n\nCaso não informado assumirá o Local do Estoque padrão."},"cReservado":{"type":"string","maxLength":1,"example":"S","description":"Preencher com \"S\" ou \"N\"\n\nDefault \"N\"\n\nUtilizado apenas nos métodos de inclusão e alteração"},"lote_validade_op":{"type":"object","properties":{"nIdLote":{"type":"integer","maxLength":15,"description":"Id do lote do produto.\n\n\nQuando informado, vincula um lote já existente. Quando não informado, a tag\n[cNumLote] passa a ser obrigatória e o lote é criado no momento da conclusão\nda Ordem de Produção."},"cNumLote":{"type":"string","maxLength":60,"description":"Número do lote do produto.\n\n\nDeve ser informado apenas quando a tag [nIdLote] não for informada, com isso,\nserá criado um novo lote a partir do número informado."},"cCodAgreg":{"type":"string","maxLength":20,"description":"Código de agregação do lote do produto.\n\n\nDeve ser informado apenas quando a tag [nIdLote] não for informada."},"dDataFab":{"type":"string","description":"Data de fabricação do lote.\n\n\nDeve ser informado apenas quando a tag [nIdLote] não for informada.\n\n\nComo default é utilizado a data atual."},"dDataVal":{"type":"string","description":"Data de validade do lote.\n\n\nDeve ser informado apenas quando a tag [nIdLote] não for informada.\n\n\nQuando não informada, é calculada a partir do prazo de validade cadastrado\nno produto; se o produto não tiver prazo cadastrado, o preenchimento é obrigatório."}},"required":["dDataVal"],"description":"Informações referente ao lote e validade do produto principal da Ordem de Produção.\n\n\nSomente um lote pode ser informado para o produto principal — a quantidade é a\nprópria quantidade a produzir informada na tag [nQtde]."}}},"infAdicionais":{"type":"object","properties":{"dDtInicio":{"type":"string","maxLength":10,"description":"Data de início da produção."},"dDtConclusao":{"type":"string","maxLength":10,"description":"Data de conclusão da produção."},"nCodProjeto":{"type":"integer","maxLength":15,"description":"Código do projeto.\n(Gerado internamente, não é visualizado na tela)."},"cEtapa":{"type":"string","maxLength":2,"description":"Etapa da Ordem de Produção."}}},"observacoes":{"type":"object","properties":{"cObs":{"type":"string","description":"Observações da ordem de produção."}}},"outrasInf":{"type":"object","properties":{"cConcluida":{"type":"string","maxLength":1,"description":"Indica se a ordem de produção está concluída."},"dConclusao":{"type":"string","maxLength":10,"description":"Data da conclusão."},"hConclusao":{"type":"string","maxLength":8,"description":"Hora da conclusão."},"dInclusao":{"type":"string","maxLength":10,"description":"Data de inclusão da oportunidade."},"hInclusao":{"type":"string","maxLength":8,"description":"Hora de inclusão da oportunidade."},"uInc":{"type":"string","maxLength":10,"description":"Usuário da Inclusão."},"dAlteracao":{"type":"string","maxLength":10,"description":"Data de alteração da oportunidade."},"hAlteracao":{"type":"string","maxLength":8,"description":"Hora de alteração da oportunidade."},"uAlt":{"type":"string","maxLength":10,"description":"Usuário da Alteração."}}},"itens":{"type":"array","items":{"type":"object","properties":{"nIdProdutoMalha":{"type":"integer","maxLength":15,"description":"ID do produto da malha."},"cUtilizarDoEstoque":{"type":"string","maxLength":1,"description":"Utilizar os itens que já estão prontos no estoque deste produto\n\nValores possíveis:\n\nS = Sim\nN = Não."},"lote_validade":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","maxLength":15,"description":"Código do lote."},"nQtdLote":{"type":"number","maxLength":19,"description":"Quantidade do lote."}}},"description":"Informação do lote."}},"required":["cUtilizarDoEstoque","nIdProdutoMalha"]},"description":"Itens da ordem de produção."}}}}},"example":{"call":"UpsertOrdemProducao","param":[{"identificacao":{"cCodIntOP":"OP0001","dDtPrevisao":"30/09/2026","nCodProduto":0,"nQtde":3}}]}},"produtos_op_UpsertOrdemProducao_retorno":{"type":"object","properties":{"nCodOP":{"type":"integer","description":"Código da ordem de produção."},"cCodIntOP":{"type":"string","description":"Código de integração da ordem de produção."},"cCodStatus":{"type":"string","description":"Código do Status."},"cDesStatus":{"type":"string","description":"Descrição do Status."}},"title":"UpsertOrdemProducao (retorno)"},"produtos_pdvcadastros_ListarExcluidos":{"type":"object","title":"ListarExcluidos","description":"Lista de cadastros excluídos utilizados pelo PDV.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarExcluidos"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página. Padrão 1."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Registros por página. Padrão 100, máximo 100. Hoje a consulta ignora este campo e a página e devolve sempre os primeiros 100 registros."},"apenas_importado_api":{"type":"string","maxLength":1,"description":"Aceito (\"S\"/\"N\"), mas hoje não filtra nada."},"ordenar_por":{"type":"string","maxLength":100,"description":"Ordem dentro de cada tipo de cadastro: CODIGO (padrão), COD_INT ou DESCRICAO."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"\"S\" para ordem decrescente."},"data_inicial":{"type":"string","maxLength":10,"description":"Data inicial da exclusão, no formato dd/mm/aaaa."},"data_final":{"type":"string","maxLength":10,"description":"Data final da exclusão, no formato dd/mm/aaaa."},"hora_inicial":{"type":"string","maxLength":8,"description":"Hora inicial da exclusão, no formato hh:mm:ss."},"hora_final":{"type":"string","maxLength":8,"description":"Hora final da exclusão, no formato hh:mm:ss."}}}}},"example":{"call":"ListarExcluidos","param":[{"pagina":1,"registros_por_pagina":100,"data_inicial":"08/10/2026","data_final":"08/10/2026","hora_inicial":"00:00:00","hora_final":"23:59:59"}]}},"produtos_pdvcadastros_ListarExcluidos_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página devolvida."},"total_de_paginas":{"type":"integer","description":"Total de páginas."},"registros":{"type":"integer","description":"Registros devolvidos nesta página."},"total_de_registros":{"type":"integer","description":"Total de registros encontrados."},"cadastros":{"type":"object","properties":{"clientes":{"type":"array","items":{"type":"object","properties":{"nCodCliente":{"type":"integer","description":"Código do cliente. (Código interno utilizado apenas na API)."},"cCodIntCliente":{"type":"string","description":"Código de Integração do Cliente. (Código do cliente no sistema legado, visualizado apenas via API)."},"cCnpjCpf":{"type":"string","description":"CNPJ ou CPF do cliente excluído."},"cRazao":{"type":"string","description":"Razão social do cliente excluído, sem acentos."},"dDataExc":{"type":"string","description":"Data da exclusão, no formato dd/mm/aaaa."},"cHoraExc":{"type":"string","description":"Hora da exclusão, no formato hh:mm:ss."},"cUsuarioExc":{"type":"string","description":"Usuário que fez a exclusão."},"cTipo":{"type":"string","description":"Tipo de ação executada. Pode ser: E - Cliente excluído."}}},"description":"Clientes excluídos."},"produtos":{"type":"array","items":{"type":"object","properties":{"nCodProd":{"type":"integer","description":"Código do produto. (Código interno utilizado apenas na API)."},"cCodIntProd":{"type":"string","description":"Código de integração do cadastro excluído."},"cCodigo":{"type":"string","description":"Código do produto. (Visualizado no cadastro do Omie)."},"cDescricao":{"type":"string","description":"Descrição, sem acentos."},"dDataExc":{"type":"string","description":"Data da exclusão, no formato dd/mm/aaaa."},"cHoraExc":{"type":"string","description":"Hora da exclusão, no formato hh:mm:ss."},"cUsuarioExc":{"type":"string","description":"Usuário que fez a exclusão."},"cTipo":{"type":"string","description":"Tipo de ação executada. Pode ser: E - Produto excluído. A - Regra de Imposto alterada para não enviar para o PDV."}}},"description":"Produtos excluídos."},"contasCorrentes":{"type":"array","items":{"type":"object","properties":{"nCodConta":{"type":"integer","description":"Código interno da conta corrente excluída."},"cCodIntProd":{"type":"string","description":"Código de integração do cadastro excluído."},"cDescricao":{"type":"string","description":"Descrição, sem acentos."},"dDataExc":{"type":"string","description":"Data da exclusão, no formato dd/mm/aaaa."},"cHoraExc":{"type":"string","description":"Hora da exclusão, no formato hh:mm:ss."},"cUsuarioExc":{"type":"string","description":"Usuário que fez a exclusão."},"cTipo":{"type":"string","description":"Tipo de ação executada. Pode ser: E - Conta a pagar/receber excluída."}}},"description":"Contas correntes excluídas."},"pedidos":{"type":"array","items":{"type":"object","properties":{"nCodPedido":{"type":"integer","description":"Código do Pedido. (Código interno utilizado apenas na API)."},"cCodIntPedido":{"type":"string","description":"Código de Integração do Pedido. (Código do cliente no sistema legado, visualizado apenas via API)."},"cNumeroPedido":{"type":"string","description":"Número do Pedido no Omie. Exibido na tela."},"cPedidoCliente":{"type":"string","description":"Número do Pedido informado pelo Cliente."},"cOperacao":{"type":"string","description":"Operação do pedido. Hoje vem sempre vazio."},"nValorTotal":{"type":"decimal","description":"Valor total do pedido. Hoje vem sempre 0."},"dDataExc":{"type":"string","description":"Data da exclusão, no formato dd/mm/aaaa."},"cHoraExc":{"type":"string","description":"Hora da exclusão, no formato hh:mm:ss."},"cUsuarioExc":{"type":"string","description":"Usuário que fez a exclusão."},"cTipo":{"type":"string","description":"Tipo de ação executada. Pode ser: E - Pedido excluído."}}},"description":"Pedidos excluídos."},"cenarios":{"type":"array","items":{"type":"object","properties":{"nCodCenario":{"type":"integer","description":"Código do Cenário Fiscal. (Código interno utilizado apenas na API)."},"cDescrCenario":{"type":"string","description":"Descrição do Cenário."},"dDataExc":{"type":"string","description":"Data da exclusão, no formato dd/mm/aaaa."},"cHoraExc":{"type":"string","description":"Hora da exclusão, no formato hh:mm:ss."},"cUsuarioExc":{"type":"string","description":"Usuário que fez a exclusão."},"cTipo":{"type":"string","description":"Tipo de ação executada. Pode ser: E - Cenário Fiscal excluído."}}},"description":"Cenários fiscais excluídos."}},"description":"Cadastros excluídos no período, separados por tipo."}},"title":"ListarExcluidos (retorno)"},"produtos_pdvcadastros_ListarTitulosExcluidos":{"type":"object","title":"ListarTitulosExcluidos","description":"Títulos de contas a pagar/receber excluídos.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarTitulosExcluidos"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página. Padrão 1."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Registros por página. Padrão 100, máximo 100 (valor maior volta a 100)."},"data_inicial":{"type":"string","maxLength":10,"description":"Data inicial da exclusão, no formato dd/mm/aaaa."},"data_final":{"type":"string","maxLength":10,"description":"Data final da exclusão, no formato dd/mm/aaaa."}}}}},"example":{"call":"ListarTitulosExcluidos","param":[{"pagina":1,"registros_por_pagina":100,"data_inicial":"01/10/2026","data_final":"08/10/2026"}]}},"produtos_pdvcadastros_ListarTitulosExcluidos_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página devolvida."},"total_de_paginas":{"type":"integer","description":"Total de páginas."},"registros":{"type":"integer","description":"Registros devolvidos nesta página."},"total_de_registros":{"type":"integer","description":"Total de registros encontrados."},"titulos":{"type":"array","items":{"type":"object","properties":{"nCodTitulo":{"type":"integer","description":"Código interno do título excluído (gerado pela Omie, não aparece na tela)."},"dDataExc":{"type":"string","description":"Data da exclusão, no formato dd/mm/aaaa."},"cHoraExc":{"type":"string","description":"Hora da exclusão, no formato hh:mm:ss."},"cUsuarioExc":{"type":"string","description":"Usuário que fez a exclusão."},"cTipo":{"type":"string","description":"Ação registrada. Vem sempre \"EXC\" (exclusão)."}}},"description":"Títulos de contas a pagar e a receber excluídos no período."}},"title":"ListarTitulosExcluidos (retorno)"},"produtos_pedido_AlterarPedFaturado":{"type":"object","title":"AlterarPedFaturado","description":"Alteração dos dados de um pedido faturado.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarPedFaturado"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_pedido":{"type":"integer","maxLength":15,"description":"ID do pedido do venda.\n\nEsse campo não é exibido na tela do Pedido de Vendas.\nÉ uma informação interna, utilizada apenas nas APIs."},"codigo_pedido_integracao":{"type":"string","maxLength":60,"description":"Código de integração do pedido de venda.\n\nPreencha esse campo com o código do pedido no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de pedidos você conseguirá ver a relação entre o id do pedido gerado no Omie e o código de pedido existente em sua aplicação."},"numero_pedido":{"type":"string","maxLength":15,"description":"Número do pedido de venda.\n\nEsse é o número do pedido de venda no Omie, que é gerado automaticamente e exibido na tela."},"codigo_rastreio":{"type":"string","maxLength":500,"description":"Código de Rastreio da Entrega do Pedido de Venda.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"link_rastreio":{"type":"string","maxLength":300,"description":"Link de Rastreio da Entrega do Pedido de Venda.\n\nInformação interna pode ser visualizada e consultada via API '/api/v1/produtos/pedido/'."},"previsao_entrega":{"type":"string","maxLength":10,"description":"Previsão de entrega do Pedido de Venda\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"obs_venda":{"type":"string","description":"Observações da venda (elas não serão exibidas na Nota Fiscal).\n\nInformação localizada na Aba \"Observações\" do Pedido de Venda."}}}}},"example":{"call":"AlterarPedFaturado","param":[{"codigo_pedido":0,"codigo_pedido_integracao":"","codigo_rastreio":"","previsao_entrega":"","obs_venda":""}]}},"produtos_pedido_AlterarPedFaturado_retorno":{"type":"object","properties":{"codigo_pedido":{"type":"integer","description":"ID do pedido do venda. Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs."},"codigo_pedido_integracao":{"type":"string","description":"Código de integração do pedido de venda. Preencha esse campo com o código do pedido no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de pedidos você conseguirá ver a relação entre o id do pedido gerado no Omie e o código de pedido existente em sua aplicação."},"numero_pedido":{"type":"string","description":"Número do pedido de venda. Esse é o número do pedido de venda no Omie, que é gerado automaticamente e exibido na tela."},"codigo_status":{"type":"string","description":"Código do Status do Pedido de Venda."},"descricao_status":{"type":"string","description":"Descrição do status."}},"title":"AlterarPedFaturado (retorno)"},"produtos_pedido_AlterarPedidoVenda":{"type":"object","title":"AlterarPedidoVenda","description":"Alteração do Pedido de Venda","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarPedidoVenda"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cabecalho":{"type":"object","properties":{"codigo_pedido":{"type":"integer","maxLength":15,"description":"ID do pedido do venda.\n\nEsse campo não é exibido na tela do Pedido de Vendas.\nÉ uma informação interna, utilizada apenas nas APIs."},"codigo_pedido_integracao":{"type":"string","maxLength":60,"description":"Código de integração do pedido de venda.\n\nPreencha esse campo com o código do pedido no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de pedidos você conseguirá ver a relação entre o id do pedido gerado no Omie e o código de pedido existente em sua aplicação."},"numero_pedido":{"type":"string","maxLength":15,"description":"Número do pedido de venda.\n\nEsse é o número do pedido de venda no Omie, que é gerado automaticamente e exibido na tela."},"sequencial":{"type":"string","maxLength":4,"description":"Número sequencial do pedido de venda parcial.\n\nEsse é o número do pedido de venda parcial no Omie, que é gerado automaticamente e exibido na tela."},"codigo_cliente":{"type":"integer","maxLength":15,"description":"Código do cliente.\n\nUtilize a tag \"codigo_cliente_omie\" do método \"ListarClientes\" da API\nhttp://app.omie.com.br/api/v1/geral/clientes/\npara obter essa informação."},"codigo_cliente_integracao":{"type":"string","maxLength":60,"description":"Código de Integração do Cliente\n\nEsse campo deve ser informado apenas se você incluiu o cliente via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag \"codigo_cliente\"."},"data_previsao":{"type":"string","maxLength":10,"description":"Data de Previsão de Faturamento.\n\nUtilize o formato \"dd/mm/aaaa\".\n\nEsse campo indica a data da previsão do faturamento do pedido e deve ser informado com uma data igual ou superior a data corrente."},"quantidade_itens":{"type":"integer","maxLength":6,"description":"Quantidade de Itens."},"etapa":{"type":"string","maxLength":2,"description":"Etapa do pedido de venda.\n\nEsse campo indica em que coluna o pedido de venda irá figurar no processo de faturamento do Omie.\n\nUtilize a tag \"codigo\" do método \"ListarEtapasFaturamento\" da API\nhttp://app.omie.com.br/api/v1/produtos/etapafat/\npara obter essa informação.\n\nOs valores são fixos, mas as descrições (funções atribuídas a cada coluna pode mudar. A API irá indicar a descrição de cada coluna.\n\nOs valores disponíveis para esse campo podem ser:\n\n\"10\" - Primeira coluna\n\"20\" - Segunda coluna\n\"30\" - Terceira coluna\n\"40\" - Quarta coluna\n\"50\" - Faturar."},"codigo_parcela":{"type":"string","maxLength":3,"description":"Código da parcela/Condição de pagamento.\n\nUtilize a tag \"nCodigo\" do método \"ListarFormasPagVendas\" da API\nhttp://app.omie.com.br/api/v1/produtos/formaspagvendas/\npara obter essa informação.\n\nO código \"999\" é o único que permite uma definição de forma de pagamento customizada. Caso você escolha essa opção, deve também informar a tag \"qtde_parcelas\" e a estrutura \"lista_parcelas\".\n\nConsultar a API de parcelas para obter código: 'api/v1/geral/parcelas/#ListarParcelas'."},"qtde_parcelas":{"type":"integer","maxLength":3,"description":"Quantidade de parcelas.\n\nValores permitidos de 1 a 999."},"origem_pedido":{"type":"string","maxLength":3,"description":"Origem do Pedido.\n\nDefault:\nAPI - Importado via API.\nMLV - Mercado Livre\n\nEsse campo será ignorado no método AlterarPedidoVenda."},"codigo_cenario_impostos":{"type":"integer","maxLength":15,"description":"Código do Cenário de Impostos.\n\nSe não informado, será assumido o cenário padrão."},"bloqueado":{"type":"string","maxLength":1,"description":"Pedido Bloqueado pela API."},"importado_api":{"type":"string","maxLength":1,"description":"Pedido de venda de produto importada pela API."},"codigo_empresa":{"deprecated":true,"type":"integer","maxLength":15,"description":"DEPRECATED"},"codigo_empresa_integracao":{"deprecated":true,"type":"string","maxLength":20,"description":"DEPRECATED"},"tipo_desconto_pedido":{"type":"string","maxLength":1,"description":"Tipo de desconto para o pedido.\n\nPode ser:\nV - Valor\nP - Percentual\n\n\nAo informar o desconto na capa do pedido o mesmo será distribuído proporcionalmente para os itens. Uma vez realizada a distribuição os valores do desconto serão exibidos apenas nos itens.\n\nIMPORTANTE:\n- Não será permitido informar desconto na capa caso já exista distribuição pelos itens.\n- Na alteração o desconto será aplicado para todos os itens do pedido."},"perc_desconto_pedido":{"type":"number","maxLength":10,"description":"Percentual do desconto do pedido.\n\n\nAo informar o desconto na capa do pedido o mesmo será distribuído proporcionalmente para os itens. Uma vez realizada a distribuição os valores do desconto serão exibidos apenas nos itens.\n\nIMPORTANTE:\n- Não será permitido informar desconto na capa caso já exista distribuição pelos itens.\n- Na alteração o desconto será aplicado para todos os itens do pedido."},"valor_desconto_pedido":{"type":"number","maxLength":18,"description":"Valor do desconto do pedido.\n\n\nAo informar o desconto na capa do pedido o mesmo será distribuído proporcionalmente para os itens. Uma vez realizada a distribuição os valores do desconto serão exibidos apenas nos itens.\n\nIMPORTANTE:\n- Não será permitido informar desconto na capa caso já exista distribuição pelos itens.\n- Na alteração o desconto será aplicado para todos os itens do pedido.\n- Se o desconto for superior ao valor do pedido ele não será aplicado."},"encerrado":{"type":"string","maxLength":1,"example":"S","description":"Indica que o pedido foi encerrado (S/N).\nTag utilizada apenas nos métodos de listagem e consulta."},"enc_motivo":{"type":"string","maxLength":100,"description":"Descrição do motivo do encerramento.\nTag utilizada apenas nos métodos de listagem e consulta."},"enc_data":{"type":"string","maxLength":10,"description":"Data de encerramento,\nTag utilizada apenas nos métodos de listagem e consulta."},"enc_hora":{"type":"string","maxLength":8,"description":"Hora de encerramento,\nTag utilizada apenas nos métodos de listagem e consulta."},"enc_user":{"type":"string","maxLength":10,"description":"Usuário do encerramento,\nTag utilizada apenas nos métodos de listagem e consulta."},"nao_gerar_boleto":{"type":"string","maxLength":1,"description":"Indica se o boleto não deve ser gerado para a(s) parcela(s) ao emitir a nota fiscal.\n\nInforme \"S\" para não gerar o boleto. O padrão é \"N\".\n\nQuando informado dentro do tag \"cabecalho\", aplica-se como valor padrão para todas as parcelas, caso não seja especificado individualmente em cada uma.\n\nQuando informado dentro da tag \"lista_parcelas\", aplica-se individualmente para cada parcela (tem prioridade sobre o valor informado no cabeçalho).\n\n\nInformação localizada na Aba \"Parcelas\" do Pedido de Venda."}},"description":"Informações do cabeçalho do pedido."},"departamentos":{"type":"array","items":{"type":"object","properties":{"cCodDepto":{"type":"string","maxLength":40,"description":"ID do Departamento.\n\nInformação localizada na Aba \"Departamentos\" do Pedido de Venda.\n\nUtilize a tag \"codigo\" do método \"ListarDepatartamentos\" da API\nhttp://app.omie.com.br/api/v1/geral/departamentos/\npara obter essa informação."},"nPerc":{"type":"number","maxLength":10,"description":"Percentual de Rateio.\n\nInformação localizada na Aba \"Departamentos\" do Pedido de Venda."},"nValor":{"type":"number","maxLength":18,"description":"Valor do Rateio.\n\nInformação localizada na Aba \"Departamentos\" do Pedido de Venda."},"nValorFixo":{"type":"string","maxLength":1,"description":"Indica que o valor foi fixado na distribuição do rateio.\n\nInformar \"S\" ou \"N\".\n\nInformação localizada na Aba \"Departamentos\" do Pedido de Venda."}}},"description":"Dados da Aba \"Departamentos\" do Pedido de Venda."},"frete":{"type":"object","properties":{"codigo_transportadora":{"type":"integer","maxLength":15,"description":"ID da transportadora.\n\nEsse campo não é exibido na tela do Pedido de Vendas.\nÉ uma informação interna, utilizada apenas nas APIs.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda.\n\nUtilize a tag \"codigo_cliente_omie\" do método \"ListarClientes\" da API\nhttp://app.omie.com.br/api/v1/geral/clientes/\npara obter essa informação.\n\nOBS: O Omie uitliza o cadastro de clientes para registrar também fornecedores e transportadoras."},"codigo_transportadora_integracao":{"type":"string","maxLength":60,"description":"Código Integração da Transportadora.\n\nEsse campo deve ser informado apenas se você incluiu o cliente (transportadora) via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag \"codigo_cliente\"."},"modalidade":{"type":"string","maxLength":1,"description":"Tipo de  Frete.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda.\n\nValores disponíveis:\n\n\"0\" - Contratação do Frete por conta do Remetente (CIF)\n\"1\" - Contratação do Frete por conta do Destinatário (FOB)\n\"2\" - Contratação do Frete por conta de Terceiros\n\"3\" - Transporte Próprio por conta do Remetente\n\"4\" - Transporte Próprio por conta do Destinatário\n\"9\" - Sem frete."},"placa":{"type":"string","maxLength":7,"description":"Placa do Veículo.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"placa_estado":{"type":"string","maxLength":2,"description":"Estado da Placa do Veículo.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"registro_transportador":{"type":"string","maxLength":20,"description":"RNTRC (ANTT) - Registro Nacional de Transportador de Cargas.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"quantidade_volumes":{"type":"integer","maxLength":15,"description":"Quantidade de Volumes.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"especie_volumes":{"type":"string","maxLength":60,"description":"Espécie dos Volumes.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"marca_volumes":{"type":"string","maxLength":60,"description":"Marca dos Volumes.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"numeracao_volumes":{"type":"string","maxLength":60,"description":"Numeração dos Volumes.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"peso_liquido":{"type":"number","maxLength":18,"description":"Peso Líquido (Kg).\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"peso_bruto":{"type":"number","maxLength":18,"description":"Peso Bruto (Kg).\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"valor_frete":{"type":"number","maxLength":18,"description":"Valor do Frete.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"valor_seguro":{"type":"number","maxLength":18,"description":"Valor do Seguro.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"numero_lacre":{"type":"string","maxLength":60,"description":"Número do Lacre.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"outras_despesas":{"type":"number","maxLength":18,"description":"Outras Despesas Acessórias.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"veiculo_proprio":{"type":"string","maxLength":1,"description":"O transporte será realizado com veículo próprio.\n\nInformar \"S\" ou \"N\".\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"previsao_entrega":{"type":"string","maxLength":10,"description":"Previsão de entrega do Pedido de Venda\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"codigo_rastreio":{"type":"string","maxLength":500,"description":"Código de Rastreio da Entrega do Pedido de Venda.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"icms_retido":{"type":"object","properties":{"vServicoTr":{"type":"number","maxLength":18,"description":"Valor de Serviço de Transporte.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"vBCRetencaoTr":{"type":"number","maxLength":18,"description":"Base de Cálculo da Retenção.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"vAliquotaRetencaoTr":{"type":"number","maxLength":10,"description":"Percentual de Alíquota de Retenção.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"vIcmsRetidoTr":{"type":"number","maxLength":18,"description":"Valor de ICMS Retido.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"cCfopTr":{"type":"string","maxLength":10,"description":"CFOP.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda.\n\nUtilize a tag \"nCodigo\" do método \"ListarCFOP\" da API\nhttp://app.omie.com.br/api/v1/produtos/cfop/\npara obter essa informação."},"cCidadeTr":{"type":"string","maxLength":40,"description":"Cidade de Ocorrência do Fato Gerador do ICMS.\n\nUtilize o formato: CIDADE (UF), como no exemplos:\n\n\"SAO PAULO (SP)\"\n\"RIO DE JANEIRO (RJ)\"\n\"FLORIANOPOLIS (SC)\"\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda.\n\nUtilize a tag \"cCod\" do método \"PesquisarCidades\" da API\nhttp://app.omie.com.br/api/v1/geral/cidades/\npara obter essa informação."}},"description":"Dados do ICMS Retido do Serviço de Transporte.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"codigo_tipo_entrega":{"type":"integer","maxLength":15,"description":"Código do tipo de entrega."},"link_rastreio":{"type":"string","maxLength":300,"description":"Link de Rastreio da Entrega do Pedido de Venda.\n\nInformação interna pode ser visualizada e consultada via API '/api/v1/produtos/pedido/'."}},"description":"Dados da Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"informacoes_adicionais":{"type":"object","properties":{"codigo_categoria":{"type":"string","maxLength":20,"description":"Código da categoria.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda.\n\nUtilize a tag \"codigo\" do método \"ListarCategorias\" da API\nhttp://app.omie.com.br/api/v1/geral/categorias/\npara obter essa informação."},"codigo_conta_corrente":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda.\n\nUtilize a tag \"codigo\" do método \"PesquisarContaCorrente\" da API\nhttp://app.omie.com.br/api/v1/geral/contacorrente/\npara obter essa informação."},"numero_pedido_cliente":{"type":"string","maxLength":30,"description":"Número do pedido do cliente.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"numero_contrato":{"type":"string","maxLength":20,"description":"Número do Contrato de Venda.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"contato":{"type":"string","maxLength":100,"description":"Contato.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"dados_adicionais_nf":{"type":"string","description":"Dados adicionais para a Nota Fiscal.\n\nUtilize o caracter pipe ( | ) como separador de linha.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"consumidor_final":{"type":"string","maxLength":1,"description":"Nota Fiscal para Consumo Final.\n\nInformar \"S\" ou \"N\".\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"utilizar_emails":{"type":"string","description":"Utilizar os seguintes endereços de e-mail.\n\nInformar a lista de e-mail que receberão a Nota Fiscal.\nUtilize a virgula (,) como separador.\n\nInformação localizada na Aba \"E-mail para o Cliente\" do Pedido de Venda."},"enviar_email":{"type":"string","maxLength":1,"description":"Enviar e-mail com o boleto de cobrança gerado pelo faturamento (juntamente com o DANFE e o XML da NF-e).\n\nInformar \"S\" ou \"N\".\nDefault \"N\"\n\nInformação localizada na Aba \"E-mail para o Cliente\" do Pedido de Venda.\n\nÉ permitido somente o preenchimento de uma das tags \"enviar_pix\" ou \"enviar_email\"."},"enviar_pix":{"type":"string","maxLength":1,"description":"Enviar e-mail com o PIX de cobrança gerado pelo faturamento (juntamente com o DANFE e o XML da NF-e).\n\nInformar \"S\" ou \"N\".\nDefault \"N\"\n\nInformação localizada na Aba \"E-mail para o Cliente\" do Pedido de Venda.\n\nÉ permitido somente o preenchimento de uma das tags \"enviar_pix\" ou \"enviar_email\"."},"codVend":{"type":"integer","maxLength":15,"description":"Código do Vendedor.\n\nInformação localizada no cabeçalho do Pedido de Venda.\n\nUtilize a tag \"codigo\" do método \"ListarVendedores\" da API\nhttp://app.omie.com.br/api/v1/geral/vendedores/\npara obter essa informação."},"codProj":{"type":"integer","maxLength":15,"description":"Código do Projeto.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda.\n\nUtilize a tag \"codigo\" do método \"ListarProjetos\" da API\nhttp://app.omie.com.br/api/v1/geral/projetos/\npara obter essa informação."},"outros_detalhes":{"type":"object","properties":{"cNatOperacaoOd":{"type":"string","maxLength":60,"description":"Natureza da Operação.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cIndicadorOd":{"type":"string","maxLength":1,"description":"Indicador de Presença da Operação.\n\n1 - Operação presencial.\n2 - Operação não presencial, pela Internet.\n3 - Operação não presencial, Teleatendimento.\n4 - NFC-e em operação com entrega a domicílio.\n9 -Operação não presencial, outros.\n\n\nSe não informado, utilizaremos automaticamente o \"9 - Outros\".\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cIndicadorIntOd":{"type":"string","maxLength":1,"description":"Indicador de Intermediador.\n\n\nEsta informação deverá ser enviada quando se tratar de uma operação não presencial.\n\nOpções disponíveis:\n0=Operação sem intermediador(em site ou plataforma própria)\n1=Operação em site ou plataforma de terceiros(intermediadores/marketplace)\n\nSe não informado, utilizaremos automaticamente a opção \"0-Operação sem intermediador(em site ou plataforma própria)\".\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cCnpjIntOd":{"type":"string","maxLength":20,"description":"CNPJ do Intermediador.\n\nPreencimento obrigatório caso o Indicador de Intermediador seja igual a opção \"1-Operação em site ou plataforma de terceiros(intermediadores/marketplace)\".\n\nEste campo representa o CNPJ do Intermediador da Transação.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cIdentificadorIntOd":{"type":"string","maxLength":60,"description":"Identificação no Intermediador.\n\n\nEste identificador pode ser o nome do usuário ou identificação do perfil do vendedor no site do intermediador.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"dDataSaidaOd":{"type":"string","maxLength":10,"description":"Data de Saída.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cHoraSaidaOd":{"type":"string","maxLength":8,"description":"Hora de Saída.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cCnpjCpfOd":{"type":"string","maxLength":20,"description":"CNPJ / CPF (do recebedor).\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cNomeOd":{"type":"string","maxLength":60,"description":"Nome / Razão Social.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cInscrEstadualOd":{"type":"string","maxLength":20,"description":"Inscrição Estadual.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cEnderecoOd":{"type":"string","maxLength":60,"description":"Endereço.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cNumeroOd":{"type":"string","maxLength":10,"description":"Número do endereço.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cComplementoOd":{"type":"string","maxLength":60,"description":"Complemento do endereço.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cBairroOd":{"type":"string","maxLength":60,"description":"Bairro.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cEstadoOd":{"type":"string","maxLength":2,"description":"Estado.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cCidadeOd":{"type":"string","maxLength":40,"description":"Cidade.\n\nUtilize o padrão: CIDADE (UF), como no exemplo:\n\n\"SAO PAULO (SP)\"\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda.\n\nUtilize a tag \"cCod\" do método \"PesquisarCidades\" da API\nhttp://app.omie.com.br/api/v1/geral/cidades/\npara obter essa informação."},"cCEPOd":{"type":"string","maxLength":10,"description":"CEP.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cSepararEnderecoOd":{"type":"string","maxLength":1,"description":"Separar endereço.\nValores possível S ou N, sendo N o padrão.\nQuando igual S separa do endereço o número o e complemento, caso existirem."},"cTelefoneOd":{"type":"string","maxLength":15,"description":"Telefone.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cCnpjCpfOdRet":{"type":"string","maxLength":20,"description":"CPF/CNPJ (Local de Retirada).\n\nPreencimento opcional quando a mercadoria não está com o Emitente e deve ser retirada em outro local.\n\nEste campo representa o CPF/CNPJ do responsável pela retirada da mercadoria.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cNomeOdRet":{"type":"string","maxLength":60,"description":"Nome / Razão Social (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cInscrEstadualOdRet":{"type":"string","maxLength":20,"description":"Inscrição Estadual (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cEnderecoOdRet":{"type":"string","maxLength":60,"description":"Endereço (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cNumeroOdRet":{"type":"string","maxLength":10,"description":"Número do endereço (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cComplementoOdRet":{"type":"string","maxLength":60,"description":"Complemento do endereço (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cBairroOdRet":{"type":"string","maxLength":60,"description":"Bairro (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cEstadoOdRet":{"type":"string","maxLength":2,"description":"Estado (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cCidadeOdRet":{"type":"string","maxLength":40,"description":"Cidade (Local de Retirada).\n\nUtilize o padrão: CIDADE (UF), como no exemplo:\n\n\"SAO PAULO (SP)\"\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda.\n\nUtilize a tag \"cCod\" do método \"PesquisarCidades\" da API\nhttp://app.omie.com.br/api/v1/geral/cidades/\npara obter essa informação."},"cCEPOdRet":{"type":"string","maxLength":10,"description":"CEP (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cSepararEnderecoOdRet":{"type":"string","maxLength":1,"description":"Separar endereço.\nValores possível S ou N, sendo N o padrão.\nQuando igual S separa do endereço o número o e complemento, caso existirem."},"cTelefoneOdRet":{"type":"string","maxLength":15,"description":"Telefone (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."}},"description":"Outros detalhes da NF-e."},"impostos_embutidos":{"deprecated":true,"type":"string","maxLength":1,"description":"DEPRECATED"},"meio_pagamento":{"type":"string","maxLength":100,"description":"Meio de Pagamento - Utilizado apenas para emissão de NF-e (campo \"tPag\" do XML).\nEsse campo indica como a parcela da nota será paga.\n\n\nInformação localizada na Aba \"Parcelas\" do Pedido de Venda.\n\nCaso informado na estrutura \"informacoes_adicionais\" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura \"parcela\".\nPode ser:\n01  Dinheiro\n02  Cheque\n03  Cartão de Crédito\n04  Cartão de Débito\n05  Crédito Loja\n10  Vale Alimentação\n11  Vale Refeição\n12  Vale Presente\n13  Vale Combustível\n15  Boleto Bancário\n16  Depósito Bancário\n17  Pagamento Instantâneo (PIX)\n18  Transferência bancária, Carteira Digital\n19  Programa de fidelidade, Cashback, Crédito Virtual.\n90  Sem Pagamento\n99  Outros\n\nListagem completa disponível na API:\n/api/v1/geral/meiospagamento/"},"descr_meio_pagamento":{"type":"string","description":"Descrição do Meio de Pagamento - Utilizado apenas para emissão de NF-e (campo \"xPag\" do XML).\n\nEsse campo precisa ser informado quando a tag \"meio_pagamento\" for igual a 99 (Outros).\n\nInformação localizada na Aba \"Parcelas\" do Pedido de Venda.\n\nCaso informado na estrutura \"informacoes_adicionais\" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura \"parcela\"."},"tipo_documento":{"type":"string","maxLength":5,"description":"Tipo de Documento.\n\n\nInformação localizada na Aba \"Parcelas\" do Pedido de Venda.\n\nPode ser:\n13S   13o. Salário\n99999 Outros\nACO   Acordo\nACOB  Acordo - Boleto\nACOT  Acordo - Transferência\nADI   Adiantamento\nANT   Antecipação\nAPL   Aplicação\nAPO   Apólice\nAPOR  Aporte\nASS   Assinatura\nBIL   Bilhete\nBOL   Boleto\nBOLV  Boleto à Vista\nBONUS Bonus\nCAP   Capitalização\nCART  Carteira\nCF    Cupom Fiscal\nCHD   Cheque Devolvido\nCHP   Cheque Pré\nCHQ   Cheque\nCHT   Cheque de Terceiros\nCNT   Crédito em Conta\nCOB   Cobrança\nCOM   Comissão\nCON   Convênios\nCONC  Cobrança de Concessionária\nCOND  Condicional\nCONS  Consignado\nCONSO Consórcio\nCRC   Cartão de Crédito\nCRD   Cartão de Débito\nCRE   Crediário\nCRP   Cartão Pré-Pago\nCRT   Cartão\nCRTO  Cartório\nCTE   CT-e\nCTR   Contrato\nCUSJ  Custos Judiciais\nDACTE DACTE\nDAE   DAE\nDAJE  DAJE\nDAM   DAM\nDANFE DANFE\nDAR   DAR\nDARE  DARE\nDARJ  DARJ\nDARM  DARM\nDAS   DAS\nDDA   DDA\nDEB   Débito em Conta\nDEBA  Débito Automático\nDEP   Depósito\nDEV   Devolução\nDFE   Documento Fiscal Equivalente\nDIN   Dinheiro\nDLC   Distribuição de Lucros\nDNF   Documento não fiscal\nDNFSE DANFSE\nDOA   Doação\nDOC   DOC\nDPVAT DPVAT\nDRF   DARF\nDUA   DUA\nDUAM  DUAM\nDUP   Duplicata\nEMP   Empréstimo\nENC   Encargos\nETAR  Estorno de Tarifa\nFAT   Fatura\nFER   Férias\nFIA   Fiado\nFIN   Financiamento\nFPGT  Folha de Pagamento\nGAR   Garantia\nGARE  GARE\nGNRE  GNRE\nGPS   GPS\nGRCS  GRCS\nGRCSU GRCSU\nGRF   Guia de Recolhimento do FGTS\nGRU   GRU\nGUIA  Guia de Recolhimento\nHOL   Holerite\nIMP   Imposto\nINV   Invoice\nIPTU  IPTU\nIPVA  IPVA\nJUROS Juros Limite\nMED   Medição\nMULTA Multas\nMUTUO Mútuo\nNC    Nota de Crédito\nND    Nota de Débito\nNF    Nota Fiscal\nNF3E  Nota Fiscal de Energia Elétrica Eletrônica\nNFA   Nota Fiscal de Abastecimento\nNFC   Nota Fiscal de Consumidor\nNFCE  Nota Fiscal de Consumidor Eletrônica\nNFD   Nota Fiscal de Devolução\nNFE   Nota Fiscal Eletrônica\nNFEE  Nota Fiscal Energia Elétrica\nNFS   Nota Fiscal de Serviço\nNFST  Nota Fiscal de Telecomunicações\nNFSTM Nota Fiscal de Serviço Tomado\nPDD   PDD\nPED   Pedido\nPEN   Pensão Alimentícia\nPER   Permuta\nPIX   Pix\nPROF  Proforma Invoice\nPROL  Pro-Labore\nPROT  Protesto\nPROV  Provisão\nREC   Recibo\nREE   Reembolso\nREND  Rendimentos\nRES   Resgate\nRET   Rescisão Trabalhista\nRPA   RPA\nSAN   Sangria\nSAQ   Saque\nSUP   Suprimento\nTAR   Tarifa\nTED   TED\nTFE   Taxa de Fiscalização de Estabelecimentos\nTIC   Ticket\nTID   Título Descontado\nTRA   Transferência\nTRAV  Transferência à Vista\nTRLAV Licenciamento\nTX    Taxa\nVIST  A Vista\nVOU   Voucher\nWSITE Website\n\nListagem completa dispon\"ivel na API:\n/api/v1/ger"},"nfRelacionada":{"type":"object","properties":{"cChaveRef":{"type":"string","maxLength":44,"description":"Chave da NF-e (ou NFC-e ou SAT) Relacionada."},"nNFRef":{"type":"string","maxLength":9,"description":"Número da Nota Fiscal\n\nNota Fiscal Relacionada Modelo 1/1A"},"cSerieRef":{"type":"string","maxLength":3,"description":"Série da NF Referenciada.\n\nNota Fiscal Relacionada Modelo 1/1A"},"dtEmissaoRef":{"type":"string","maxLength":10,"description":"Data de emissão da NF Referenciada.\n\nNota Fiscal Relacionada Modelo 1/1A"},"cnpjEmitRef":{"type":"string","maxLength":20,"description":"CNPJ da Emitente da NF Referenciada.\n\nNota Fiscal Relacionada Modelo 1/1A"},"cUfRef":{"type":"string","maxLength":2,"description":"Estado do Emitente da NF Referenciada.\n\nNota Fiscal Relacionada Modelo 1/1A"},"nNfPR":{"type":"string","maxLength":9,"description":"Número da Nota Fiscal relacionada do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural"},"cSeriePR":{"type":"string","maxLength":3,"description":"Série da NF do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural"},"dtEmissaoPR":{"type":"string","maxLength":10,"description":"Data de emissão da NF do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural"},"cnpjPR":{"type":"string","maxLength":20,"description":"CNPJ/CPF do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural"},"InscrEstPR":{"type":"string","maxLength":20,"description":"Inscrição Estadual do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural"},"cUfPR":{"type":"string","maxLength":2,"description":"Estado do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural"},"nCOORef":{"type":"string","maxLength":6,"description":"Número do COO - Contador de Ordem de Operação.\n\nCupom Fiscal Relacionado"},"nECFRef":{"type":"string","maxLength":3,"description":"Número de Ordem Sequencial do ECF."},"indPresenca":{"type":"string","maxLength":1,"description":"Indicador de Presença da Operação.\n\n1 - Operação presencial.\n2 - Operação não presencial, pela Internet.\n3 - Operação não presencial, Teleatendimento.\n4 - NFC-e em operação com entrega a domicílio.\n5 - Operação presencial, fora do estabelecimento.\n9 - Operação não presencial, outros.\n\n\nSe não informado, utilizaremos automaticamente o \"9 - Outros\".\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"indIntermediario":{"type":"string","maxLength":1,"description":"Indicador de Intermediador.\n\n\nEsta informação deverá ser enviada quando se tratar de uma operação não presencial.\n\nOpções disponíveis:\n0=Operação sem intermediador(em site ou plataforma própria)\n1=Operação em site ou plataforma de terceiros(intermediadores/marketplace)\n\nSe não informado, utilizaremos automaticamente a opção \"0-Operação sem intermediador(em site ou plataforma própria)\".\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cnpjIntermediario":{"type":"string","maxLength":20,"description":"CNPJ do Intermediador.\n\nPreencimento obrigatório caso o Indicador de Intermediador seja igual a opção \"1-Operação em site ou plataforma de terceiros(intermediadores/marketplace)\".\n\nEste campo representa o CNPJ do Intermediador da Transação.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"identIntermediario":{"type":"string","maxLength":60,"description":"Identificação no Intermediador.\n\n\nEste identificador pode ser o nome do usuário ou identificação do perfil do vendedor no site do intermediador.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"nrProdutorRural":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","maxLength":1,"description":"Ação a ser realizada no item na alteração.\n\nPode ser:\n\n\"I\" - Incluir o item.\n\"E\" - Excluir o item."},"nrNumero":{"type":"string","maxLength":9,"description":"Número da NF relacionada"},"nrSerie":{"type":"string","maxLength":3,"description":"Série da NF relacionada"},"nrDtEmissao":{"type":"string","maxLength":10,"description":"Data de emissão da NF relacionada"},"nrCnpjCpf":{"type":"string","maxLength":20,"description":"CNPJ/CPF do emitente da NF relacionada"},"nrIE":{"type":"string","maxLength":20,"description":"Inscrição Estadual do emitente da NF relacionada"},"nrUF":{"type":"string","maxLength":2,"description":"Unidade federativa do emitente da NF relacionada"}}},"description":"Outras notas de produtor rural relacionadas"},"nrNF":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","maxLength":1,"description":"Ação a ser realizada no item na alteração.\n\nPode ser:\n\n\"I\" - Incluir o item.\n\"E\" - Excluir o item."},"nrChave":{"type":"string","maxLength":44,"description":"Chave da NF-e, NFC-e ou SAT relacionada"}}},"description":"Outras NF-e, NFC-e ou SAT relacionadas"},"nrCupomFiscal":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","maxLength":1,"description":"Ação a ser realizada no item na alteração.\n\nPode ser:\n\n\"I\" - Incluir o item.\n\"E\" - Excluir o item."},"nrCOO":{"type":"string","maxLength":6,"description":"Contador de Ordem de Operação (COO)"},"nrNumeroECF":{"type":"string","maxLength":3,"description":"Número do ECF"}}},"description":"Outros cupons fiscais relacionados"},"nrModelo1_1A":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","maxLength":1,"description":"Ação a ser realizada no item na alteração.\n\nPode ser:\n\n\"I\" - Incluir o item.\n\"E\" - Excluir o item."},"nrNumero":{"type":"string","maxLength":9,"description":"Número da NF relacionada"},"nrSerie":{"type":"string","maxLength":3,"description":"Série da NF relacionada"},"nrDtEmissao":{"type":"string","maxLength":10,"description":"Data de emissão da NF relacionada"},"nrCnpjCpf":{"type":"string","maxLength":20,"description":"CNPJ/CPF do emitente da NF relacionada"},"nrUF":{"type":"string","maxLength":2,"description":"Unidade federativa do emitente da NF relacionada"}}},"description":"Outras notas modelo 1/1A relacionadas"},"cSigNFRef":{"type":"string","maxLength":1,"description":"Manter o sigilo da NF-e referenciada.\n\nPreencher com \"S\" ou \"N\".\n\nDefault \"N\""}},"description":"Detalhes da NF referenciada."},"nsu":{"type":"string","maxLength":100,"description":"Número Sequencial Único NSU - Para identificar vendas por cartões ou TransactionID TID - Para identificar vendas de comercio eletrônico.\n\nCaso informado na estrutura \"informacoes_adicionais\" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura \"parcela\"."}},"description":"Dados da Aba \"Informações Adicionais\" do Pedido de Venda."},"lista_parcelas":{"type":"object","properties":{"parcela":{"type":"array","items":{"type":"object","properties":{"numero_parcela":{"type":"integer","maxLength":3,"description":"Número da Parcela.\n\nInformação localizada na Aba \"Parcelas\" do Pedido de Venda."},"valor":{"type":"number","maxLength":18,"description":"Valor da Parcela.\n\nInformação localizada na Aba \"Parcelas\" do Pedido de Venda."},"percentual":{"type":"number","maxLength":9,"description":"Percentual da Parcela.\n\nInformação localizada na Aba \"Parcelas\" do Pedido de Venda."},"data_vencimento":{"type":"string","maxLength":10,"description":"Data de Vencimento da Parcela.\n\nInformação localizada na Aba \"Parcelas\" do Pedido de Venda."},"quantidade_dias":{"type":"integer","maxLength":4,"description":"Quantidade de dias até o vencimento da parcela.\n\nInformação localizada na Aba \"Parcelas\" do Pedido de Venda."},"tipo_documento":{"type":"string","maxLength":5,"description":"Tipo de Documento.\n\n\nInformação localizada na Aba \"Parcelas\" do Pedido de Venda.\n\nPode ser:\n13S   13o. Salário\n99999 Outros\nACO   Acordo\nACOB  Acordo - Boleto\nACOT  Acordo - Transferência\nADI   Adiantamento\nANT   Antecipação\nAPL   Aplicação\nAPO   Apólice\nAPOR  Aporte\nASS   Assinatura\nBIL   Bilhete\nBOL   Boleto\nBOLV  Boleto à Vista\nBONUS Bonus\nCAP   Capitalização\nCART  Carteira\nCF    Cupom Fiscal\nCHD   Cheque Devolvido\nCHP   Cheque Pré\nCHQ   Cheque\nCHT   Cheque de Terceiros\nCNT   Crédito em Conta\nCOB   Cobrança\nCOM   Comissão\nCON   Convênios\nCONC  Cobrança de Concessionária\nCOND  Condicional\nCONS  Consignado\nCONSO Consórcio\nCRC   Cartão de Crédito\nCRD   Cartão de Débito\nCRE   Crediário\nCRP   Cartão Pré-Pago\nCRT   Cartão\nCRTO  Cartório\nCTE   CT-e\nCTR   Contrato\nCUSJ  Custos Judiciais\nDACTE DACTE\nDAE   DAE\nDAJE  DAJE\nDAM   DAM\nDANFE DANFE\nDAR   DAR\nDARE  DARE\nDARJ  DARJ\nDARM  DARM\nDAS   DAS\nDDA   DDA\nDEB   Débito em Conta\nDEBA  Débito Automático\nDEP   Depósito\nDEV   Devolução\nDFE   Documento Fiscal Equivalente\nDIN   Dinheiro\nDLC   Distribuição de Lucros\nDNF   Documento não fiscal\nDNFSE DANFSE\nDOA   Doação\nDOC   DOC\nDPVAT DPVAT\nDRF   DARF\nDUA   DUA\nDUAM  DUAM\nDUP   Duplicata\nEMP   Empréstimo\nENC   Encargos\nETAR  Estorno de Tarifa\nFAT   Fatura\nFER   Férias\nFIA   Fiado\nFIN   Financiamento\nFPGT  Folha de Pagamento\nGAR   Garantia\nGARE  GARE\nGNRE  GNRE\nGPS   GPS\nGRCS  GRCS\nGRCSU GRCSU\nGRF   Guia de Recolhimento do FGTS\nGRU   GRU\nGUIA  Guia de Recolhimento\nHOL   Holerite\nIMP   Imposto\nINV   Invoice\nIPTU  IPTU\nIPVA  IPVA\nJUROS Juros Limite\nMED   Medição\nMULTA Multas\nMUTUO Mútuo\nNC    Nota de Crédito\nND    Nota de Débito\nNF    Nota Fiscal\nNF3E  Nota Fiscal de Energia Elétrica Eletrônica\nNFA   Nota Fiscal de Abastecimento\nNFC   Nota Fiscal de Consumidor\nNFCE  Nota Fiscal de Consumidor Eletrônica\nNFD   Nota Fiscal de Devolução\nNFE   Nota Fiscal Eletrônica\nNFEE  Nota Fiscal Energia Elétrica\nNFS   Nota Fiscal de Serviço\nNFST  Nota Fiscal de Telecomunicações\nNFSTM Nota Fiscal de Serviço Tomado\nPDD   PDD\nPED   Pedido\nPEN   Pensão Alimentícia\nPER   Permuta\nPIX   Pix\nPROF  Proforma Invoice\nPROL  Pro-Labore\nPROT  Protesto\nPROV  Provisão\nREC   Recibo\nREE   Reembolso\nREND  Rendimentos\nRES   Resgate\nRET   Rescisão Trabalhista\nRPA   RPA\nSAN   Sangria\nSAQ   Saque\nSUP   Suprimento\nTAR   Tarifa\nTED   TED\nTFE   Taxa de Fiscalização de Estabelecimentos\nTIC   Ticket\nTID   Título Descontado\nTRA   Transferência\nTRAV  Transferência à Vista\nTRLAV Licenciamento\nTX    Taxa\nVIST  A Vista\nVOU   Voucher\nWSITE Website\n\nListagem completa dispon\"ivel na API:\n/api/v1/ger"},"meio_pagamento":{"type":"string","maxLength":100,"description":"Meio de Pagamento - Utilizado apenas para emissão de NF-e (campo \"tPag\" do XML).\nEsse campo indica como a parcela da nota será paga.\n\n\nInformação localizada na Aba \"Parcelas\" do Pedido de Venda.\n\nCaso informado na estrutura \"informacoes_adicionais\" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura \"parcela\".\n\nPode ser:\n01  Dinheiro\n02  Cheque\n03  Cartão de Crédito\n04  Cartão de Débito\n05  Crédito Loja\n10  Vale Alimentação\n11  Vale Refeição\n12  Vale Presente\n13  Vale Combustível\n15  Boleto Bancário\n16  Depósito Bancário\n17  Pagamento Instantâneo (PIX)\n18  Transferência bancária, Carteira Digital\n19  Programa de fidelidade, Cashback, Crédito Virtual.\n90  Sem Pagamento\n99  Outros\n\nListagem completa disponível na API:\n/api/v1/geral/meiospagamento/"},"descr_meio_pagamento":{"type":"string","description":"Descrição do Meio de Pagamento - Utilizado apenas para emissão de NF-e (campo \"xPag\" do XML).\n\nEsse campo precisa ser informado quando a tag \"meio_pagamento\" for igual a 99 (Outros).\n\nInformação localizada na Aba \"Parcelas\" do Pedido de Venda.\n\nCaso informado na estrutura \"informacoes_adicionais\" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura \"parcela\"."},"nsu":{"type":"string","maxLength":100,"description":"Número Sequencial Único NSU - Para identificar vendas por cartões ou TransactionID TID - Para identificar vendas de comercio eletrônico.\n\nCaso informado na estrutura \"informacoes_adicionais\" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura \"parcela\"."},"nao_gerar_boleto":{"type":"string","maxLength":1,"description":"Indica se o boleto não deve ser gerado para a(s) parcela(s) ao emitir a nota fiscal.\n\nInforme \"S\" para não gerar o boleto. O padrão é \"N\".\n\nQuando informado dentro do tag \"cabecalho\", aplica-se como valor padrão para todas as parcelas, caso não seja especificado individualmente em cada uma.\n\nQuando informado dentro da tag \"lista_parcelas\", aplica-se individualmente para cada parcela (tem prioridade sobre o valor informado no cabeçalho).\n\n\nInformação localizada na Aba \"Parcelas\" do Pedido de Venda."},"parcela_adiantamento":{"type":"string","maxLength":1,"description":"Está é uma parcela de Adiantamento do Cliente.\n\nInforme \"S\" para indicar que é uma parcela de adiantamento.\nO padrão é \"N\".\n\n\nInformação localizada na Aba \"Parcelas\" do Pedido de Venda."},"categoria_adiantamento":{"type":"string","maxLength":20,"description":"Código da Categoria para o Adiantamento.\nSerá utilizada na conta a receber que representa o adiantamento desta parcela.\n\n\nInformação localizada na Aba \"Parcelas\" do Pedido de Venda."},"conta_corrente_adiantamento":{"type":"integer","maxLength":15,"description":"Conta Corrente de Adiantamento.\n\n\nInformação localizada na Aba \"Parcelas\" do Pedido de Venda."},"bandeira":{"type":"string","maxLength":2,"description":"Código da Bandeira da operadora de cartão."},"cnpj_fin":{"type":"string","maxLength":20,"description":"Informar o CNPJ da instituição de pagamento, adquirente ou subadquirente."}}},"description":"Dados da parcela."}},"description":"Dados da Aba \"Parcelas\" do Pedido de Venda.\n\nPara todos os outros códigos o preenchimento é automático - Não informar essa estrutura."},"observacoes":{"type":"object","properties":{"obs_venda":{"type":"string","description":"Observações da venda (elas não serão exibidas na Nota Fiscal).\n\nInformação localizada na Aba \"Observações\" do Pedido de Venda."}},"description":"Dados da Aba \"Observações\" do Pedido de Venda."},"det":{"type":"array","items":{"type":"object","properties":{"ide":{"type":"object","properties":{"codigo_item_integracao":{"type":"string","maxLength":30,"description":"Código de Integração do Item do Pedido de Venda.\n\nInforme a identificação do Item do Pedido de Venda. Caso você não tenha essa informação no seu aplicativo, informe o número sequencial de cada item do pedido.\n\nInforma de 1 a 199."},"codigo_item":{"type":"integer","maxLength":15,"description":"ID do Item do Pedido."},"simples_nacional":{"type":"string","maxLength":1,"description":"Indica que a empresa é Optante pelo Simples Nacional.\n\nInformar \"S\" ou \"N\"."},"acao_item":{"type":"string","maxLength":1,"description":"Ação para o item.\n\nPode ser:\n\n\"E\" - para excluir um item."},"id_ordem_producao":{"type":"integer","maxLength":15,"description":"Id da Ordem de Produção.\n\nCampo disponível apenas para consulta.\n\nNão deve ser informado na Inclusão ou Alteração."},"regra_impostos":{"deprecated":true,"type":"integer","maxLength":15,"description":"DEPRECATED"}},"description":"Identificação do Item do Pedido de Vendas."},"produto":{"type":"object","properties":{"codigo_produto":{"type":"integer","maxLength":15,"description":"ID do Produto.\n\nEsse campo não é exibido na tela do Pedido de Vendas.\nÉ uma informação interna, utilizada apenas nas APIs.\n\nUtilize a tag \"codigo_produto\" do método \"ListarProdutos\" da API\nhttp://app.omie.com.br/api/v1/geral/produtos/\npara obter essa informação."},"codigo_produto_integracao":{"type":"string","maxLength":60,"description":"Código de integração do Produto.\n\nEsse campo deve ser informado apenas se você incluiu o produto via API e informou um código de integração para o produto. Do contrário, informe sempre a tag \"codigo_produto\"."},"codigo":{"type":"string","maxLength":60,"description":"Código do Produto exibido na tela do Pedido de Vendas."},"descricao":{"type":"string","maxLength":120,"description":"Descrição do Produto."},"cfop":{"type":"string","maxLength":10,"description":"CFOP - Código Fiscal de Operações e Prestações.\n\nUtilize a tag \"nCodigo\" do método \"ListarCFOP\" da API\nhttp://app.omie.com.br/api/v1/produtos/cfop/\npara obter essa informação."},"ncm":{"type":"string","maxLength":13,"description":"NCM - Nomenclatura Comum do Mercosul\n\nUtilize a tag \"cCodigo\" do método \"ListarNCM\" da API\nhttp://app.omie.com.br/api/v1/produtos/ncm/\npara obter essa informação."},"ean":{"type":"string","maxLength":14,"description":"EAN - European Article Number"},"unidade":{"type":"string","maxLength":6,"description":"Unidade.\n\nUtilize a tag \"codigo\" do método \"ListarUnidades\" da API\nhttp://app.omie.com.br/api/v1/geral/unidade/\npara obter essa informação."},"quantidade":{"type":"number","maxLength":18,"description":"Quantidade\n\nNo método de devolução de pedido:\nCaso não seja preenchida será feita a devolução integral do produto."},"valor_unitario":{"type":"number","maxLength":18,"description":"Valor Únitário"},"codigo_tabela_preco":{"type":"integer","maxLength":15,"description":"Código da tabela de preço.\n\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nDeve ser informada opcionalmente, caso a tabela de preços esteja configurada no Omie."},"valor_mercadoria":{"type":"number","maxLength":18,"description":"Valor da Mercadoria"},"tipo_desconto":{"type":"string","maxLength":1,"description":"Tipo de Desconto."},"percentual_desconto":{"type":"number","maxLength":18,"description":"Percentual de Desconto."},"valor_desconto":{"type":"number","maxLength":18,"description":"Valor do Desconto"},"valor_deducao":{"type":"number","maxLength":18,"description":"Valor da Dedução"},"valor_icms_desonerado":{"type":"number","maxLength":18,"description":"Valor do ICMS desonerado"},"motivo_icms_desonerado":{"type":"string","maxLength":2,"description":"Código do Motivo de desoneração do ICMS\n\nCódigos válidos para desoneração do ICMS\n01 Táxi\n03 Produtor Agropecuário\n04 Frotista/Locadora\n05 Diplomático/Consular\n06 Utilitários e Motocicletas da Amazônia Ocidental e Áreas de Livre Comércio (Resolução 714/88 e 790/94 ? CONTRAN e suas alterações)\n07 SUFRAMA\n08 Venda a Órgão Público\n09 Outros. (NT 2011/004)\n10 Deficiente Condutor (Convênio ICMS 38/12)\n11 Deficiente Não Condutor (Convênio ICMS 38/12)\n16 Olimpíadas Rio 2016\n90 Solicitado pelo Fisco"},"valor_total":{"type":"number","maxLength":18,"description":"Valor Total."},"indicador_escala":{"type":"string","maxLength":1,"description":"Indicador de Produção em Escala Relevante.\n\nPode ser:\n\"S\" para Produzido em Escala Relevante.\n\"N\" para Produzido em Escala NÃO Relevante."},"cnpj_fabricante":{"type":"string","maxLength":20,"description":"CNPJ do Fabricante da Mercadoria."},"kit":{"type":"string","maxLength":1,"description":"Indica se o produto é um kit"},"componente_kit":{"type":"string","maxLength":1,"description":"Indica se o produto é um componente de um kit"},"codigo_item_kit":{"type":"integer","maxLength":15,"description":"ID do Item do kit (pai) que o componente pertence"},"reservado":{"type":"string","maxLength":1,"example":"S","description":"(S/N) Indica se o estoque do produto será reservado."}},"description":"Identificação do Produto do Item do Pedido de Vendas."},"observacao":{"type":"object","properties":{"obs_item":{"type":"string","description":"Observações do item (elas não serão exibidas na Nota Fisca, mas serão impressas no pedido de vendal).\n\nInformação localizada na Aba \"Observações\" do Item do Pedido de Venda."}},"description":"Dados da aba \"Observações\" do Item do Pedido de Vendas."},"inf_adic":{"type":"object","properties":{"peso_liquido":{"type":"number","maxLength":18,"description":"Peso Líquido (Kg)."},"peso_bruto":{"type":"number","maxLength":18,"description":"Peso Bruto (Kg)."},"numero_pedido_compra":{"type":"string","maxLength":15,"description":"Número do Pedido de Compra."},"item_pedido_compra":{"type":"integer","maxLength":6,"description":"Item do Pedido de Compra."},"dados_adicionais_item":{"type":"string","description":"Informações para a Nota Fiscal."},"nao_movimentar_estoque":{"type":"string","maxLength":1,"description":"Não gerar a saída de estoque deste item ao emitir NF-e.\n\nInformar \"S\" ou \"N\".\n(informe \"S\" para ativar essa opção)."},"nao_gerar_financeiro":{"type":"string","maxLength":1,"description":"Não gerar conta a receber para este item.\n\nInformar \"S\" ou \"N\".\n(Informe \"S\" para ativar essa opção)."},"codigo_categoria_item":{"type":"string","maxLength":20,"description":"Código da Categoria do item."},"codigo_beneficio_fiscal":{"type":"string","maxLength":10,"description":"Código do Benefício Fiscal."},"numero_fci":{"type":"string","maxLength":36,"description":"Número da FCI (Ficha de Conteúdo de Importação)"},"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do Local do Estoque."},"codigo_cenario_impostos_item":{"type":"integer","maxLength":15,"description":"Código do Cenário de Impostos."},"nao_somar_total":{"type":"string","maxLength":1,"description":"Não somar este item no total da NF-e"},"numero_recopi":{"type":"string","maxLength":20,"description":"Número do registro gerado pelo sistema RECOPI Nacional (Reconhecimento e Controle das Operações com Papel Imune)."}},"description":"Dados da aba \"Informações Adicionais\" do Item do Pedido de Vendas."},"imposto":{"type":"object","properties":{"icms_sn":{"type":"object","properties":{"cod_sit_trib_icms_sn":{"type":"string","maxLength":3},"origem_icms_sn":{"type":"string","maxLength":1},"aliq_icms_sn":{"type":"number","maxLength":10},"valor_credito_icms_sn":{"type":"number","maxLength":18},"base_icms_sn":{"type":"number","maxLength":18},"valor_icms_sn":{"type":"number","maxLength":18}},"description":"ICMS - Simples Nacional."},"icms":{"type":"object","properties":{"cod_sit_trib_icms":{"type":"string","maxLength":2},"origem_icms":{"type":"string","maxLength":1},"modalidade_icms":{"type":"string","maxLength":1},"perc_red_base_icms":{"type":"number","maxLength":10},"base_icms":{"type":"number","maxLength":18},"aliq_icms":{"type":"number","maxLength":10},"valor_icms":{"type":"number","maxLength":18},"perc_fcp_icms":{"type":"number","maxLength":10,"description":"Percentual do FCP - Fundo de Combate a Pobreza do ICMS."},"base_fcp_icms":{"type":"number","maxLength":18,"description":"Base de Cálculo do FCP - Fundo de Combate a Pobreza do ICMS."},"valor_fcp_icms":{"type":"number","maxLength":18,"description":"Valor do FCP - Fundo de Combate a Pobreza do ICMS."}},"description":"ICMS"},"icms_st":{"type":"object","properties":{"cod_sit_trib_icms_st":{"type":"string","maxLength":2},"modalidade_icms_st":{"type":"string","maxLength":1},"perc_red_base_icms_st":{"type":"number","maxLength":10},"base_icms_st":{"type":"number","maxLength":18},"aliq_icms_st":{"type":"number","maxLength":10},"margem_icms_st":{"type":"number","maxLength":10},"valor_icms_st":{"type":"number","maxLength":18},"aliq_icms_opprop":{"type":"number","maxLength":10,"description":"Alíquota de ICMS Operação Própria."},"perc_red_base_icms_op":{"type":"number","maxLength":10,"description":"Percentual de redução de base de cálculo de Icms Operação Própria."},"cest":{"type":"string","maxLength":9,"description":"CEST - Código Especificador da Substituíção Tributária."},"perc_fcp_icms_st":{"type":"number","maxLength":10,"description":"Percentual do FCP - Fundo de Combate a Pobreza do ICMS ST."},"base_fcp_icms_st":{"type":"number","maxLength":18,"description":"Base de Cálculo do FCP - Fundo de Combate a Pobreza do ICMS ST."},"valor_fcp_icms_st":{"type":"number","maxLength":18,"description":"Valor do FCP - Fundo de Combate a Pobreza do ICMS ST."}},"description":"ICMS - Substituição Tributária."},"icms_ie":{"type":"object","properties":{"base_icms_uf_destino":{"type":"number","maxLength":18,"description":"BC do ICMS na UF de Destino"},"aliq_icms_FCP":{"type":"number","maxLength":10,"description":"Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de Destino"},"aliq_interna_uf_destino":{"type":"number","maxLength":10,"description":"Alíquota Interna da UF de Destino"},"aliq_interestadual":{"type":"number","maxLength":10,"description":"Alíquota Interestadual das UFs Envolvidas"},"aliq_partilha_icms":{"type":"number","maxLength":10,"description":"Percentual Provisório de Partilha do ICMS Interestadual"},"valor_fcp_icms_inter":{"type":"number","maxLength":18,"description":"Valor do fundo de combate a pobreza."},"valor_icms_uf_dest":{"type":"number","maxLength":18,"description":"Valor do ICMS - UF Destino"},"valor_icms_uf_remet":{"type":"number","maxLength":18,"description":"Valor do ICMS - UF Remetente"}},"description":"ICMS Interestadual."},"icms_efet":{"type":"object","properties":{"cod_sit_trib_icms_efet":{"type":"string","maxLength":2},"origem_icms_efet":{"type":"string","maxLength":1},"modalidade_icms_efet":{"type":"string","maxLength":1},"perc_red_base_icms_efet":{"type":"number","maxLength":10},"base_icms_efet":{"type":"number","maxLength":18},"aliq_icms_efet":{"type":"number","maxLength":10},"valor_icms_efet":{"type":"number","maxLength":18}},"description":"ICMS efetivo.\nNão informar na Inclusão e Alteração.\nUtilizado somente na Consulta e Listagem"},"ipi":{"type":"object","properties":{"cod_sit_trib_ipi":{"type":"string","maxLength":2},"tipo_calculo_ipi":{"type":"string","maxLength":1},"enquadramento_ipi":{"type":"string","description":"Enquadramento do IPI"},"base_ipi":{"type":"number","maxLength":18},"aliq_ipi":{"type":"number","maxLength":10},"qtde_unid_trib_ipi":{"type":"number","maxLength":18},"valor_unid_trib_ipi":{"type":"number","maxLength":18},"valor_ipi":{"type":"number","maxLength":18}},"description":"IPI."},"pis_padrao":{"type":"object","properties":{"cod_sit_trib_pis":{"type":"string","maxLength":2},"tipo_calculo_pis":{"type":"string","maxLength":1},"base_pis":{"type":"number","maxLength":18},"aliq_pis":{"type":"number","maxLength":10},"qtde_unid_trib_pis":{"type":"number","maxLength":18},"valor_unid_trib_pis":{"type":"number","maxLength":18},"valor_pis":{"type":"number","maxLength":18}},"description":"PIS."},"pis_st":{"type":"object","properties":{"cod_sit_trib_pis_st":{"type":"string","maxLength":2},"tipo_calculo_pis_st":{"type":"string","maxLength":1},"base_pis_st":{"type":"number","maxLength":18},"aliq_pis_st":{"type":"number","maxLength":10},"qtde_unid_trib_pis_st":{"type":"number","maxLength":18},"valor_unid_trib_pis_st":{"type":"number","maxLength":18},"margem_pis_st":{"type":"number","maxLength":10},"valor_pis_st":{"type":"number","maxLength":18}},"description":"PIS - Substituíção Tributária."},"cofins_padrao":{"type":"object","properties":{"cod_sit_trib_cofins":{"type":"string","maxLength":2},"tipo_calculo_cofins":{"type":"string","maxLength":1},"base_cofins":{"type":"number","maxLength":18},"aliq_cofins":{"type":"number","maxLength":10},"qtde_unid_trib_cofins":{"type":"number","maxLength":18},"valor_unid_trib_cofins":{"type":"number","maxLength":18},"valor_cofins":{"type":"number","maxLength":18}},"description":"COFINS."},"cofins_st":{"type":"object","properties":{"cod_sit_trib_cofins_st":{"type":"string","maxLength":2},"tipo_calculo_cofins_st":{"type":"string","maxLength":1},"base_cofins_st":{"type":"number","maxLength":18},"aliq_cofins_st":{"type":"number","maxLength":10},"qtde_unid_trib_cofins_st":{"type":"number","maxLength":18},"valor_unid_trib_cofins_st":{"type":"number","maxLength":18},"margem_cofins_st":{"type":"number","maxLength":10},"valor_cofins_st":{"type":"number","maxLength":18}},"description":"COFINS - Substituição Tributária."},"inss":{"type":"object","properties":{"aliq_inss":{"type":"number","maxLength":10},"valor_inss":{"type":"number","maxLength":18}},"description":"INSS."},"csll":{"type":"object","properties":{"aliq_csll":{"type":"number","maxLength":10},"valor_csll":{"type":"number","maxLength":18}},"description":"CSLL."},"irrf":{"type":"object","properties":{"aliq_irrf":{"type":"number","maxLength":10},"valor_irrf":{"type":"number","maxLength":18}},"description":"IRRF."},"iss":{"type":"object","properties":{"base_iss":{"type":"number","maxLength":18},"aliq_iss":{"type":"number","maxLength":10},"valor_iss":{"type":"number","maxLength":18},"retem_iss":{"type":"string","maxLength":1}},"description":"ISS."},"ibs_cbs":{"type":"object","properties":{"cst_ibs_cbs":{"type":"string","maxLength":3,"description":"Código de Situação Tributária do IBS e CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"class_trib":{"type":"string","maxLength":6,"description":"Código de Classificação Tributária do IBS e CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"base_ibs_cbs":{"type":"number","maxLength":15,"description":"Base de cálculo do IBS e CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."}}},"ibs":{"type":"object","properties":{"aliquota_ibs_uf":{"type":"number","maxLength":7,"description":"Alíquota do IBS de competência das UF.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"perc_dif_ibs_uf":{"type":"number","maxLength":7,"description":"Percentual do Diferimento - IBS UF.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"perc_red_ibs_uf":{"type":"number","maxLength":7,"description":"Percentual da redução de alíquota - IBS UF.\n\nNão deve ser informado na Inclusão/Alteração. Campos disponíveis apenas para consulta.\n\nPara os métodos de inclusão e alteração, esses campos serão alimentados conforme o cenário fiscal."},"valor_dif_ibs_uf":{"type":"number","maxLength":15,"description":"Valor do Diferimento - IBS UF.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_ibs_uf":{"type":"number","maxLength":15,"description":"Valor do IBS de competência da UF.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"aliquota_ibs_mu":{"type":"number","maxLength":7,"description":"Alíquota do IBS de competência do Município.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"perc_dif_ibs_mu":{"type":"number","maxLength":7,"description":"Percentual do diferimento - UBS Município.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"perc_red_ibs_mu":{"type":"number","maxLength":7,"description":"Percentual da redução de alíquota - IBS Município.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_dif_ibs_mu":{"type":"number","maxLength":15,"description":"Valor do Diferimento - IBS Município.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_ibs_mu":{"type":"number","maxLength":15,"description":"Valor do IBS de competência do Município.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_ibs":{"type":"number","maxLength":15,"description":"Valor total do IBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."}}},"cbs":{"type":"object","properties":{"aliquota_cbs":{"type":"number","maxLength":7,"description":"Alíquota da CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"perc_dif_cbs":{"type":"number","maxLength":7,"description":"Percentual do diferimento - CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"perc_red_cbs":{"type":"number","maxLength":7,"description":"Percentual da redução de alíquota - CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_dif_cbs":{"type":"number","maxLength":15,"description":"Valor do diferimento - CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_cbs":{"type":"number","maxLength":15,"description":"Valor da CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."}}},"trib_reg":{"type":"object","properties":{"cst_reg_ibs_cst":{"type":"string","maxLength":3,"description":"Código da Situação Tributária do IBS e CBS (Tributação Regular).\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"class_trib_reg":{"type":"string","maxLength":6,"description":"Código de Classificação Tributária do IBS e CBS (Tributação Regular).\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"aliquota_reg_ibs_uf":{"type":"number","maxLength":7,"description":"Valor da alíquota do IBS da UF na tributação regular.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"aliquota_reg_ibs_mu":{"type":"number","maxLength":7,"description":"Valor da alíquota do IBS do Município na tributação regular.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"aliquota_reg_cbs":{"type":"number","maxLength":7,"description":"Valor da alíquota da CBS na tributação regular.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_reg_ibs_uf":{"type":"number","maxLength":15,"description":"Valor do Tributo do IBS da UF na tributação regular.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_reg_ibs_mu":{"type":"number","maxLength":15,"description":"Valor do Tributo do IBS do Município na tributação regular.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_reg_cbs":{"type":"number","maxLength":15,"description":"Valor do Tributo da CBS na tributação regular.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."}}}},"description":"Informações referentes aos impostos do Item do Pedido de Vendas.\n\nEssa estrutura deve ser preenchida quando os dados dos impostos devem ser respeitados tais como foram enviados na API.\n\nCaso essa estrutura não seja enviada, o Omie irá identificar a regra de imposto que melhor se ajusta as condições da venda realizada.\nPara utilizar essa opção esteja seguro de que as regras e cenários de impostos estejam cadastrados corretamente no Omie. As infomações preenchidas serão decorrentes dos dados configurados."},"rastreabilidade":{"type":"object","properties":{"numeroLote":{"type":"string","maxLength":20,"description":"Número do Lote"},"qtdeProdutoLote":{"type":"number","maxLength":12,"description":"Quantidade de Produto"},"dataFabricacaoLote":{"type":"string","maxLength":10,"description":"Data de Fabricação/Produção"},"dataValidadeLote":{"type":"string","maxLength":10,"description":"Data de Validade"},"codigoAgregacaoLote":{"type":"string","maxLength":20,"description":"Código de Agregação"}},"description":"Dados da rastreabilidade do produto."},"combustivel":{"type":"object","properties":{"cCodigoANP":{"type":"string","maxLength":9,"description":"Código de Produto da ANP."},"cDescrANP":{"type":"string","maxLength":95,"description":"Descrição do Produto conforme ANP."},"cCODIF":{"type":"string","maxLength":21,"description":"Registro do CODIF."},"nPercGLP":{"type":"number","maxLength":8,"description":"Percentual de GLP Derivado do Petróleo."},"nPercGasNacional":{"type":"number","maxLength":8,"description":"Percentual de Gás Natural Nacional."},"nPercGasImportado":{"type":"number","maxLength":8,"description":"Percentual de Gás Natural Importado."},"nValorPartida":{"type":"number","maxLength":16,"description":"Valor de Partida."},"nQtdeFatTempAmb":{"type":"number","maxLength":16,"description":"Quantidade Faturada à Temperatura Ambiente."},"cUFConsumoComb":{"type":"string","maxLength":2,"description":"UF de Consumo."},"nBC_CIDE":{"type":"number","maxLength":18,"description":"Base de Cálculo (em quantidade)  da CIDE."},"nAliquota_CIDE":{"type":"number","maxLength":10,"description":"Valor da Alíquota em Reais da CIDE."},"nValor_CIDE":{"type":"number","maxLength":18,"description":"Valor da CIDE."},"nBC_UFRem":{"type":"number","maxLength":18,"description":"Base de Cálculo da UF Remetente.\n\nBase de Cálculo do ICMS retido anteriormente por Substituição Tributária."},"nValorUFRem":{"type":"number","maxLength":10,"description":"Valor da UF Remetente.\n\nAlíquota do ICMS retido anteriormente por Substituição Tributária."},"nBC_UFDest":{"type":"number","maxLength":18,"description":"Base de Cálculo da UF Destino.\n\nBase de Cálculo do ICMS ST da UF Destino."},"nValorUFDest":{"type":"number","maxLength":18,"description":"Valor da UF Destino.\n\nBase de Cálculo do ICMS ST da UF Destino."}},"description":"Detalhamento específico de Combustível."},"tributavel":{"type":"object","properties":{"cUnidTrib":{"type":"string","maxLength":6,"description":"Unidade tributável do Item."},"nQuantTrib":{"type":"number","maxLength":19,"description":"Quantidade tributável do item."},"nValorTrib":{"type":"number","maxLength":18,"description":"Valor tributável do item."},"cEanTrib":{"type":"string","maxLength":14,"description":"código EAN tributável do item."}},"description":"Unidade, Quantidade, Valor e EAN tributáveis do item do pedido."},"lote_validade":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","maxLength":15,"description":"Id do Lote do produto.\n\nObrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.."},"nQtdLote":{"type":"number","maxLength":18,"description":"Informe aqui a quantidade do Lote para o produto.\n\nÉ obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações."}},"required":["nQtdLote"]},"description":"Informações referentes ao lote e validade do produto.\n\nA tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes \"manualmente\" por API."}}},"description":"Dados da Aba \"Itens da Venda\" do Pedido de Venda."},"market_place":{"type":"object","properties":{"nTaxa":{"type":"number","maxLength":18,"description":"Valor da taxa do Market Place."},"nEnvio":{"type":"number","maxLength":18,"description":"Valor do envio do Market Place."}},"description":"Dados para o Market Place."},"total_pedido":{"type":"object","properties":{"base_calculo_icms":{"type":"number","maxLength":18,"description":"Base de Cálculo do ICMS."},"base_calculo_st":{"type":"number","maxLength":18,"description":"Base de cálculo da substituição tributária."},"valor_pis":{"type":"number","maxLength":18,"description":"Valor do PIS."},"valor_cofins":{"type":"number","maxLength":18,"description":"Valor do cofins."},"valor_csll":{"type":"number","maxLength":18,"description":"Valor da CSLL."},"valor_icms":{"type":"number","maxLength":18,"description":"Valor total do ICMS."},"valor_st":{"type":"number","maxLength":18,"description":"Valor total da ST."},"valor_inss":{"type":"number","maxLength":18,"description":"Valor do INSS."},"valor_IPI":{"type":"number","maxLength":18,"description":"Valor do IPI."},"valor_ir":{"type":"number","maxLength":18,"description":"Valor do IR.\n.Preenchimento automático - Não informar."},"valor_iss":{"type":"number","maxLength":18,"description":"Valor do ISS."},"valor_deducoes":{"type":"number","maxLength":28,"description":"Valor das deduções."},"valor_descontos":{"type":"number","maxLength":18,"description":"Valor dos descontos."},"valor_mercadorias":{"type":"number","maxLength":18,"description":"valor das mercadorias."},"valor_total_pedido":{"type":"number","maxLength":18,"description":"Valor total do pedido."},"base_ibs_cbs":{"type":"number","maxLength":15,"description":"Valor total da base de cálculo do IBS e da CBS."},"valor_dif_ibs_uf":{"type":"number","maxLength":15,"description":"Valor total do diferimento do IBS UF."},"valor_ibs_uf":{"type":"number","maxLength":15,"description":"Valor total do IBS da UF."},"valor_dif_ibs_mu":{"type":"number","maxLength":15,"description":"Valor total do diferimento do IBS do município."},"valor_ibs_mu":{"type":"number","maxLength":15,"description":"Valor total do IBS do município."},"valor_ibs":{"type":"number","maxLength":15,"description":"Valor total do IBS."},"valor_dif_cbs":{"type":"number","maxLength":15,"description":"Valor total do diferimento da CBS."},"valor_cbs":{"type":"number","maxLength":15,"description":"Valor total da CBS."},"valor_tot_ibs_cbs_is":{"type":"number","maxLength":15,"description":"Total da NF-e com IBS/CBS/IS."}},"description":"Valores totais do pedido."},"infoCadastro":{"type":"object","properties":{"dInc":{"type":"string","maxLength":10,"description":"Data da Inclusão."},"hInc":{"type":"string","maxLength":8,"description":"Hora da Inclusão."},"uInc":{"type":"string","maxLength":10,"description":"Usuário da Inclusão."},"dAlt":{"type":"string","maxLength":10,"description":"Data da Alteração."},"hAlt":{"type":"string","maxLength":8,"description":"Hora da Alteração."},"uAlt":{"type":"string","maxLength":10,"description":"Usuário da Alteração."},"dCan":{"type":"string","maxLength":10,"description":"Data da Cancelamento."},"hCan":{"type":"string","maxLength":8,"description":"Hora da Cancelamento."},"uCan":{"type":"string","maxLength":10,"description":"Usuário da Cancelamento."},"cancelado":{"type":"string","maxLength":1,"description":"Indica se o pedido foi cancelado."},"dFat":{"type":"string","maxLength":10,"description":"Data de Faturamento."},"hFat":{"type":"string","maxLength":8,"description":"Hora de faturamento."},"uFat":{"type":"string","maxLength":10,"description":"Usuário que realizou o faturamento."},"faturado":{"type":"string","maxLength":1,"description":"Indica se o pedido está faturado."},"denegado":{"type":"string","maxLength":1,"description":"Indica se o pedido foi denegado."},"autorizado":{"type":"string","maxLength":1,"description":"Indica se o pedido foi autorizado."},"devolvido":{"type":"string","maxLength":1,"description":"Indica se o pedido foi devolvido."},"devolvido_parcial":{"type":"string","maxLength":1,"description":"Indica se o pedido foi devolvido parcialmente."},"cImpAPI":{"type":"string","maxLength":1,"description":"Importado pela API."}},"description":"Informações complementares do pedido."},"exportacao":{"type":"object","properties":{"nao_exportacao":{"type":"string","maxLength":1,"description":"O cliente é estrangeiro, mas na verdade não se trata de uma exportação"},"local_embarque":{"type":"string","maxLength":60,"description":"Local de Embarque (ou de transposição de fronteira)"},"uf_embarque":{"type":"string","maxLength":2,"description":"UF do Local de Embarque"},"local_despacho":{"type":"string","maxLength":60,"description":"Local de Despacho"}},"description":"Dados da exportacao"},"lancamentos":{"type":"array","items":{"type":"object","properties":{"nSequencia":{"type":"integer","maxLength":5,"description":"Número da Sequencia.\n\n\nPara os itens da NF identifica qual o item do XML se refere.\n\nPara as parcelas da NF identifica o número da parcela.\n\nPara os lançamentos no Conta Corrente indentifica o lançamento que será gerado.\n\nPermite sequencial de 1 a 999."},"cNaturezaDocumento":{"type":"string","maxLength":1,"description":"Natureza do Documento.\n\n\nPode ser:\nP - Pagar\nR - Receber\n\nObrigatório na operação \"IncluirPedido\"; não é processado nas demais operações que\nreutilizam esta estrutura, como \"AlterarPedidoVenda\"."},"nValorDocumento":{"type":"number","maxLength":18,"description":"Valor do Documento.\n\nObrigatório na operação \"IncluirPedido\"; não é processado nas demais operações que\nreutilizam esta estrutura, como \"AlterarPedidoVenda\"."},"dDataDocumento":{"type":"string","maxLength":10,"description":"Data do documento.\n\nObrigatório na operação \"IncluirPedido\"; não é processado nas demais operações que\nreutilizam esta estrutura, como \"AlterarPedidoVenda\"."},"cTipoDocumento":{"type":"string","maxLength":5,"description":"Tipo de Documento.\n\n\nLista de tipos de documentos em:\n/api/v1/geral/tiposdoc\n\nObrigatório na operação \"IncluirPedido\"; não é processado nas demais operações que\nreutilizam esta estrutura, como \"AlterarPedidoVenda\"."},"cCategoria":{"type":"string","maxLength":20,"description":"Código da Categoria."},"nContaCorrente":{"type":"integer","maxLength":15,"description":"Id da Conta Corrente."},"cOrigem":{"type":"string","maxLength":3,"description":"Origem da Nota Fiscal.\n\n\nCódigos Disponíveis:\n\nAPI - Importado via API.\n\nObrigatório na operação \"IncluirPedido\"; não é processado nas demais operações que\nreutilizam esta estrutura, como \"AlterarPedidoVenda\"."},"cObs":{"type":"string","description":"Observações."},"nProjeto":{"type":"integer","maxLength":15,"description":"Id do projeto."},"nVendedor":{"type":"integer","maxLength":15,"description":"Id do Vendedor."}}},"description":"Lançamentos no Conta Corrente relacionados ao Pedido de Vendas taxas,entre outros)."},"agropecuario":{"type":"object","properties":{"cNumReceita":{"type":"string","maxLength":20,"description":"Número da receita ou receituário do agrotóxico/defensivo agrícola"},"cCpfResponsavel":{"type":"string","maxLength":14,"description":"CPF do responsá¡vel técnico legalmente habilitado"},"nTipoGuia":{"type":"integer","maxLength":1,"description":"Tipo da Guia\n\n1 - Corresponde ao GTA\n2 - Corresponde ao TTA\n3 - Corresponde ao DTA\n4 - Corresponde ao ATV\n5 - Corresponde ao PTV\n6 - Corresponde ao GTV\n7 - Corresponde ao Guia Florestal (DOF, SisFlora - PA e MT, SIAM - MG)"},"cUFGuia":{"type":"string","maxLength":2,"description":"UF de emissão da Guia"},"cSerieGuia":{"type":"string","maxLength":9,"description":"Número de série da guia"},"nNumGuia":{"type":"integer","maxLength":9,"description":"Número da guia"}}}}}}},"example":{"call":"AlterarPedidoVenda","param":[{"cabecalho":{"bloqueado":"N","codigo_cliente":3792227,"codigo_pedido_integracao":"1790776577","data_previsao":"30/09/2026","etapa":"50","quantidade_itens":1},"det":[{"ide":{"codigo_item_integracao":"4422421","simples_nacional":"S"},"imposto":{"cofins_padrao":{"aliq_cofins":3,"base_cofins":400,"cod_sit_trib_cofins":"01","tipo_calculo_cofins":"B","valor_cofins":12},"icms_sn":{"aliq_icms_sn":1.25,"cod_sit_trib_icms_sn":101,"origem_icms_sn":0,"valor_credito_icms_sn":5},"ipi":{"cod_sit_trib_ipi":51},"pis_padrao":{"aliq_pis":0.65,"base_pis":400,"cod_sit_trib_pis":"01","tipo_calculo_pis":"B","valor_pis":2.6}},"inf_adic":{"peso_bruto":150,"peso_liquido":150},"produto":{"cfop":"5.102","codigo_produto":"4422421","descricao":"Telefone Celular X","ncm":"9403.30.00","quantidade":1,"tipo_desconto":"V","unidade":"UN","valor_desconto":0,"valor_mercadoria":200,"valor_total":200,"valor_unitario":200}}],"informacoes_adicionais":{"codigo_categoria":"1.01.03","codigo_conta_corrente":11850365,"consumidor_final":"S","enviar_email":"N"},"agropecuario":{"cNumReceita":"","cCpfResponsavel":"","nTipoGuia":1,"cUFGuia":"","cSerieGuia":"","nNumGuia":1},"lista_parcelas":{"parcela":[{"data_vencimento":"01/10/2026","numero_parcela":1,"percentual":50,"valor":100},{"data_vencimento":"12/12/2026","numero_parcela":2,"percentual":50,"valor":100}]},"total_pedido":{"base_calculo_icms":200,"valor_mercadorias":200,"valor_total_pedido":200}}]}},"produtos_pedido_AlterarPedidoVenda_retorno":{"type":"object","properties":{"codigo_pedido":{"type":"integer","description":"Código do Pedido de Venda de Produto"},"codigo_pedido_integracao":{"type":"string","description":"Código de Integração do Pedido de Venda de Produto"},"codigo_status":{"type":"string","description":"Código do Status do Pedido de Venda."},"descricao_status":{"type":"string","description":"Descrição do status."},"numero_pedido":{"type":"string","description":"Número do pedido - Visualizado pelo cliente."}},"title":"AlterarPedidoVenda (retorno)"},"produtos_pedido_ConsultarPedido":{"type":"object","title":"ConsultarPedido","description":"Consulta de Pedido de Venda de Produto","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarPedido"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_pedido":{"type":"integer","maxLength":15,"description":"ID do pedido do venda.\n\nEsse campo não é exibido na tela do Pedido de Vendas.\nÉ uma informação interna, utilizada apenas nas APIs."},"codigo_pedido_integracao":{"type":"string","maxLength":60,"description":"Código de integração do pedido de venda.\n\nPreencha esse campo com o código do pedido no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de pedidos você conseguirá ver a relação entre o id do pedido gerado no Omie e o código de pedido existente em sua aplicação."},"numero_pedido":{"type":"string","maxLength":15,"description":"Número do pedido de venda.\n\nEsse é o número do pedido de venda no Omie, que é gerado automaticamente e exibido na tela."}}}}},"example":{"call":"ConsultarPedido","param":[{"codigo_pedido":25953530}]}},"produtos_pedido_ConsultarPedido_retorno":{"type":"object","properties":{"pedido_venda_produto":{"type":"object","properties":{"cabecalho":{"type":"object","properties":{"codigo_pedido":{"type":"integer","description":"ID do pedido do venda. Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs."},"codigo_pedido_integracao":{"type":"string","description":"Código de integração do pedido de venda. Preencha esse campo com o código do pedido no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de pedidos você conseguirá ver a relação entre o id do pedido gerado no Omie e o código de pedido existente em sua aplicação."},"numero_pedido":{"type":"string","description":"Número do pedido de venda. Esse é o número do pedido de venda no Omie, que é gerado automaticamente e exibido na tela."},"sequencial":{"type":"string","description":"Número sequencial do pedido de venda parcial. Esse é o número do pedido de venda parcial no Omie, que é gerado automaticamente e exibido na tela."},"codigo_cliente":{"type":"integer","description":"Código do cliente. Utilize a tag \"codigo_cliente_omie\" do método \"ListarClientes\" da API http://app.omie.com.br/api/v1/geral/clientes/ para obter essa informação."},"codigo_cliente_integracao":{"type":"string","description":"Código de Integração do Cliente Esse campo deve ser informado apenas se você incluiu o cliente via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag \"codigo_cliente\"."},"data_previsao":{"type":"string","description":"Data de Previsão de Faturamento. Utilize o formato \"dd/mm/aaaa\". Esse campo indica a data da previsão do faturamento do pedido e deve ser informado com uma data igual ou superior a data corrente."},"quantidade_itens":{"type":"integer","description":"Quantidade de Itens."},"etapa":{"type":"string","description":"Etapa do pedido de venda. Esse campo indica em que coluna o pedido de venda irá figurar no processo de faturamento do Omie. Utilize a tag \"codigo\" do método \"ListarEtapasFaturamento\" da API http://app.omie.com.br/api/v1/produtos/etapafat/ para obter essa informação. Os valores são fixos, mas as descrições (funções atribuídas a cada coluna pode mudar. A API irá indicar a descrição de cada coluna. Os valores disponíveis para esse campo podem ser: \"10\" - Primeira coluna \"20\" - Segunda coluna \"30\" - Terceira coluna \"40\" - Quarta coluna \"50\" - Faturar."},"codigo_parcela":{"type":"string","description":"Código da parcela/Condição de pagamento. Utilize a tag \"nCodigo\" do método \"ListarFormasPagVendas\" da API http://app.omie.com.br/api/v1/produtos/formaspagvendas/ para obter essa informação. O código \"999\" é o único que permite uma definição de forma de pagamento customizada. Caso você escolha essa opção, deve também informar a tag \"qtde_parcelas\" e a estrutura \"lista_parcelas\". Consultar a API de parcelas para obter código: 'api/v1/geral/parcelas/#ListarParcelas'."},"qtde_parcelas":{"type":"integer","description":"Quantidade de parcelas. Valores permitidos de 1 a 999."},"origem_pedido":{"type":"string","description":"Origem do Pedido. Default: API - Importado via API. MLV - Mercado Livre Esse campo será ignorado no método AlterarPedidoVenda."},"codigo_cenario_impostos":{"type":"integer","description":"Código do Cenário de Impostos. Se não informado, será assumido o cenário padrão."},"bloqueado":{"type":"string","description":"Pedido Bloqueado pela API."},"importado_api":{"type":"string","description":"Pedido de venda de produto importada pela API."},"codigo_empresa":{"type":"integer","description":"DEPRECATED"},"codigo_empresa_integracao":{"type":"string","description":"DEPRECATED"},"tipo_desconto_pedido":{"type":"string","description":"Tipo de desconto para o pedido. Pode ser: V - Valor P - Percentual Ao informar o desconto na capa do pedido o mesmo será distribuído proporcionalmente para os itens. Uma vez realizada a distribuição os valores do desconto serão exibidos apenas nos itens. IMPORTANTE: - Não será permitido informar desconto na capa caso já exista distribuição pelos itens. - Na alteração o desconto será aplicado para todos os itens do pedido."},"perc_desconto_pedido":{"type":"decimal","description":"Percentual do desconto do pedido. Ao informar o desconto na capa do pedido o mesmo será distribuído proporcionalmente para os itens. Uma vez realizada a distribuição os valores do desconto serão exibidos apenas nos itens. IMPORTANTE: - Não será permitido informar desconto na capa caso já exista distribuição pelos itens. - Na alteração o desconto será aplicado para todos os itens do pedido."},"valor_desconto_pedido":{"type":"decimal","description":"Valor do desconto do pedido. Ao informar o desconto na capa do pedido o mesmo será distribuído proporcionalmente para os itens. Uma vez realizada a distribuição os valores do desconto serão exibidos apenas nos itens. IMPORTANTE: - Não será permitido informar desconto na capa caso já exista distribuição pelos itens. - Na alteração o desconto será aplicado para todos os itens do pedido. - Se o desconto for superior ao valor do pedido ele não será aplicado."},"encerrado":{"type":"string","description":"Indica que o pedido foi encerrado (S/N). Tag utilizada apenas nos métodos de listagem e consulta."},"enc_motivo":{"type":"string","description":"Descrição do motivo do encerramento. Tag utilizada apenas nos métodos de listagem e consulta."},"enc_data":{"type":"string","description":"Data de encerramento, Tag utilizada apenas nos métodos de listagem e consulta."},"enc_hora":{"type":"string","description":"Hora de encerramento, Tag utilizada apenas nos métodos de listagem e consulta."},"enc_user":{"type":"string","description":"Usuário do encerramento, Tag utilizada apenas nos métodos de listagem e consulta."},"nao_gerar_boleto":{"type":"string","description":"Indica se o boleto não deve ser gerado para a(s) parcela(s) ao emitir a nota fiscal. Informe \"S\" para não gerar o boleto. O padrão é \"N\". Quando informado dentro do tag \"cabecalho\", aplica-se como valor padrão para todas as parcelas, caso não seja especificado individualmente em cada uma. Quando informado dentro da tag \"lista_parcelas\", aplica-se individualmente para cada parcela (tem prioridade sobre o valor informado no cabeçalho). Informação localizada na Aba \"Parcelas\" do Pedido de Venda."}},"description":"Informações do cabeçalho do pedido."},"departamentos":{"type":"array","items":{"type":"object","properties":{"cCodDepto":{"type":"string","description":"ID do Departamento. Informação localizada na Aba \"Departamentos\" do Pedido de Venda. Utilize a tag \"codigo\" do método \"ListarDepatartamentos\" da API http://app.omie.com.br/api/v1/geral/departamentos/ para obter essa informação."},"nPerc":{"type":"decimal","description":"Percentual de Rateio. Informação localizada na Aba \"Departamentos\" do Pedido de Venda."},"nValor":{"type":"decimal","description":"Valor do Rateio. Informação localizada na Aba \"Departamentos\" do Pedido de Venda."},"nValorFixo":{"type":"string","description":"Indica que o valor foi fixado na distribuição do rateio. Informar \"S\" ou \"N\". Informação localizada na Aba \"Departamentos\" do Pedido de Venda."}}},"description":"Dados da Aba \"Departamentos\" do Pedido de Venda."},"frete":{"type":"object","properties":{"codigo_transportadora":{"type":"integer","description":"ID da transportadora. Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda. Utilize a tag \"codigo_cliente_omie\" do método \"ListarClientes\" da API http://app.omie.com.br/api/v1/geral/clientes/ para obter essa informação. OBS: O Omie uitliza o cadastro de clientes para registrar também fornecedores e transportadoras."},"codigo_transportadora_integracao":{"type":"string","description":"Código Integração da Transportadora. Esse campo deve ser informado apenas se você incluiu o cliente (transportadora) via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag \"codigo_cliente\"."},"modalidade":{"type":"string","description":"Tipo de Frete. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda. Valores disponíveis: \"0\" - Contratação do Frete por conta do Remetente (CIF) \"1\" - Contratação do Frete por conta do Destinatário (FOB) \"2\" - Contratação do Frete por conta de Terceiros \"3\" - Transporte Próprio por conta do Remetente \"4\" - Transporte Próprio por conta do Destinatário \"9\" - Sem frete."},"placa":{"type":"string","description":"Placa do Veículo. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"placa_estado":{"type":"string","description":"Estado da Placa do Veículo. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"registro_transportador":{"type":"string","description":"RNTRC (ANTT) - Registro Nacional de Transportador de Cargas. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"quantidade_volumes":{"type":"integer","description":"Quantidade de Volumes. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"especie_volumes":{"type":"string","description":"Espécie dos Volumes. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"marca_volumes":{"type":"string","description":"Marca dos Volumes. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"numeracao_volumes":{"type":"string","description":"Numeração dos Volumes. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"peso_liquido":{"type":"decimal","description":"Peso Líquido (Kg). Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"peso_bruto":{"type":"decimal","description":"Peso Bruto (Kg). Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"valor_frete":{"type":"decimal","description":"Valor do Frete. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"valor_seguro":{"type":"decimal","description":"Valor do Seguro. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"numero_lacre":{"type":"string","description":"Número do Lacre. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"outras_despesas":{"type":"decimal","description":"Outras Despesas Acessórias. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"veiculo_proprio":{"type":"string","description":"O transporte será realizado com veículo próprio. Informar \"S\" ou \"N\". Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"previsao_entrega":{"type":"string","description":"Previsão de entrega do Pedido de Venda Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"codigo_rastreio":{"type":"string","description":"Código de Rastreio da Entrega do Pedido de Venda. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"icms_retido":{"type":"object","properties":{"vServicoTr":{"type":"decimal","description":"Valor de Serviço de Transporte. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"vBCRetencaoTr":{"type":"decimal","description":"Base de Cálculo da Retenção. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"vAliquotaRetencaoTr":{"type":"decimal","description":"Percentual de Alíquota de Retenção. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"vIcmsRetidoTr":{"type":"decimal","description":"Valor de ICMS Retido. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"cCfopTr":{"type":"string","description":"CFOP. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda. Utilize a tag \"nCodigo\" do método \"ListarCFOP\" da API http://app.omie.com.br/api/v1/produtos/cfop/ para obter essa informação."},"cCidadeTr":{"type":"string","description":"Cidade de Ocorrência do Fato Gerador do ICMS. Utilize o formato: CIDADE (UF), como no exemplos: \"SAO PAULO (SP)\" \"RIO DE JANEIRO (RJ)\" \"FLORIANOPOLIS (SC)\" Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda. Utilize a tag \"cCod\" do método \"PesquisarCidades\" da API http://app.omie.com.br/api/v1/geral/cidades/ para obter essa informação."}},"description":"Dados do ICMS Retido do Serviço de Transporte. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"codigo_tipo_entrega":{"type":"integer","description":"Código do tipo de entrega."},"link_rastreio":{"type":"string","description":"Link de Rastreio da Entrega do Pedido de Venda. Informação interna pode ser visualizada e consultada via API '/api/v1/produtos/pedido/'."}},"description":"Dados da Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"informacoes_adicionais":{"type":"object","properties":{"codigo_categoria":{"type":"string","description":"Código da categoria. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda. Utilize a tag \"codigo\" do método \"ListarCategorias\" da API http://app.omie.com.br/api/v1/geral/categorias/ para obter essa informação."},"codigo_conta_corrente":{"type":"integer","description":"Código da Conta Corrente. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda. Utilize a tag \"codigo\" do método \"PesquisarContaCorrente\" da API http://app.omie.com.br/api/v1/geral/contacorrente/ para obter essa informação."},"numero_pedido_cliente":{"type":"string","description":"Número do pedido do cliente. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"numero_contrato":{"type":"string","description":"Número do Contrato de Venda. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"contato":{"type":"string","description":"Contato. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"dados_adicionais_nf":{"type":"string","description":"Dados adicionais para a Nota Fiscal. Utilize o caracter pipe ( | ) como separador de linha. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"consumidor_final":{"type":"string","description":"Nota Fiscal para Consumo Final. Informar \"S\" ou \"N\". Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"utilizar_emails":{"type":"string","description":"Utilizar os seguintes endereços de e-mail. Informar a lista de e-mail que receberão a Nota Fiscal. Utilize a virgula (,) como separador. Informação localizada na Aba \"E-mail para o Cliente\" do Pedido de Venda."},"enviar_email":{"type":"string","description":"Enviar e-mail com o boleto de cobrança gerado pelo faturamento (juntamente com o DANFE e o XML da NF-e). Informar \"S\" ou \"N\". Default \"N\" Informação localizada na Aba \"E-mail para o Cliente\" do Pedido de Venda. É permitido somente o preenchimento de uma das tags \"enviar_pix\" ou \"enviar_email\"."},"enviar_pix":{"type":"string","description":"Enviar e-mail com o PIX de cobrança gerado pelo faturamento (juntamente com o DANFE e o XML da NF-e). Informar \"S\" ou \"N\". Default \"N\" Informação localizada na Aba \"E-mail para o Cliente\" do Pedido de Venda. É permitido somente o preenchimento de uma das tags \"enviar_pix\" ou \"enviar_email\"."},"codVend":{"type":"integer","description":"Código do Vendedor. Informação localizada no cabeçalho do Pedido de Venda. Utilize a tag \"codigo\" do método \"ListarVendedores\" da API http://app.omie.com.br/api/v1/geral/vendedores/ para obter essa informação."},"codProj":{"type":"integer","description":"Código do Projeto. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda. Utilize a tag \"codigo\" do método \"ListarProjetos\" da API http://app.omie.com.br/api/v1/geral/projetos/ para obter essa informação."},"outros_detalhes":{"type":"object","properties":{"cNatOperacaoOd":{"type":"string","description":"Natureza da Operação. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cIndicadorOd":{"type":"string","description":"Indicador de Presença da Operação. 1 - Operação presencial. 2 - Operação não presencial, pela Internet. 3 - Operação não presencial, Teleatendimento. 4 - NFC-e em operação com entrega a domicílio. 9 -Operação não presencial, outros. Se não informado, utilizaremos automaticamente o \"9 - Outros\". Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cIndicadorIntOd":{"type":"string","description":"Indicador de Intermediador. Esta informação deverá ser enviada quando se tratar de uma operação não presencial. Opções disponíveis: 0=Operação sem intermediador(em site ou plataforma própria) 1=Operação em site ou plataforma de terceiros(intermediadores/marketplace) Se não informado, utilizaremos automaticamente a opção \"0-Operação sem intermediador(em site ou plataforma própria)\". Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cCnpjIntOd":{"type":"string","description":"CNPJ do Intermediador. Preencimento obrigatório caso o Indicador de Intermediador seja igual a opção \"1-Operação em site ou plataforma de terceiros(intermediadores/marketplace)\". Este campo representa o CNPJ do Intermediador da Transação. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cIdentificadorIntOd":{"type":"string","description":"Identificação no Intermediador. Este identificador pode ser o nome do usuário ou identificação do perfil do vendedor no site do intermediador. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"dDataSaidaOd":{"type":"string","description":"Data de Saída. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cHoraSaidaOd":{"type":"string","description":"Hora de Saída. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cCnpjCpfOd":{"type":"string","description":"CNPJ / CPF (do recebedor). Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cNomeOd":{"type":"string","description":"Nome / Razão Social. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cInscrEstadualOd":{"type":"string","description":"Inscrição Estadual. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cEnderecoOd":{"type":"string","description":"Endereço. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cNumeroOd":{"type":"string","description":"Número do endereço. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cComplementoOd":{"type":"string","description":"Complemento do endereço. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cBairroOd":{"type":"string","description":"Bairro. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cEstadoOd":{"type":"string","description":"Estado. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cCidadeOd":{"type":"string","description":"Cidade. Utilize o padrão: CIDADE (UF), como no exemplo: \"SAO PAULO (SP)\" Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda. Utilize a tag \"cCod\" do método \"PesquisarCidades\" da API http://app.omie.com.br/api/v1/geral/cidades/ para obter essa informação."},"cCEPOd":{"type":"string","description":"CEP. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cSepararEnderecoOd":{"type":"string","description":"Separar endereço. Valores possível S ou N, sendo N o padrão. Quando igual S separa do endereço o número o e complemento, caso existirem."},"cTelefoneOd":{"type":"string","description":"Telefone. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cCnpjCpfOdRet":{"type":"string","description":"CPF/CNPJ (Local de Retirada). Preencimento opcional quando a mercadoria não está com o Emitente e deve ser retirada em outro local. Este campo representa o CPF/CNPJ do responsável pela retirada da mercadoria. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cNomeOdRet":{"type":"string","description":"Nome / Razão Social (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cInscrEstadualOdRet":{"type":"string","description":"Inscrição Estadual (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cEnderecoOdRet":{"type":"string","description":"Endereço (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cNumeroOdRet":{"type":"string","description":"Número do endereço (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cComplementoOdRet":{"type":"string","description":"Complemento do endereço (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cBairroOdRet":{"type":"string","description":"Bairro (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cEstadoOdRet":{"type":"string","description":"Estado (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cCidadeOdRet":{"type":"string","description":"Cidade (Local de Retirada). Utilize o padrão: CIDADE (UF), como no exemplo: \"SAO PAULO (SP)\" Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda. Utilize a tag \"cCod\" do método \"PesquisarCidades\" da API http://app.omie.com.br/api/v1/geral/cidades/ para obter essa informação."},"cCEPOdRet":{"type":"string","description":"CEP (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cSepararEnderecoOdRet":{"type":"string","description":"Separar endereço. Valores possível S ou N, sendo N o padrão. Quando igual S separa do endereço o número o e complemento, caso existirem."},"cTelefoneOdRet":{"type":"string","description":"Telefone (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."}},"description":"Outros detalhes da NF-e."},"impostos_embutidos":{"type":"string","description":"DEPRECATED"},"meio_pagamento":{"type":"string","description":"Meio de Pagamento - Utilizado apenas para emissão de NF-e (campo \"tPag\" do XML). Esse campo indica como a parcela da nota será paga. Informação localizada na Aba \"Parcelas\" do Pedido de Venda. Caso informado na estrutura \"informacoes_adicionais\" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura \"parcela\". Pode ser: 01 Dinheiro 02 Cheque 03 Cartão de Crédito 04 Cartão de Débito 05 Crédito Loja 10 Vale Alimentação 11 Vale Refeição 12 Vale Presente 13 Vale Combustível 15 Boleto Bancário 16 Depósito Bancário 17 Pagamento Instantâneo (PIX) 18 Transferência bancária, Carteira Digital 19 Programa de fidelidade, Cashback, Crédito Virtual. 90 Sem Pagamento 99 Outros Listagem completa disponível na API: /api/v1/geral/meiospagamento/"},"descr_meio_pagamento":{"type":"string","description":"Descrição do Meio de Pagamento - Utilizado apenas para emissão de NF-e (campo \"xPag\" do XML). Esse campo precisa ser informado quando a tag \"meio_pagamento\" for igual a 99 (Outros). Informação localizada na Aba \"Parcelas\" do Pedido de Venda. Caso informado na estrutura \"informacoes_adicionais\" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura \"parcela\"."},"tipo_documento":{"type":"string","description":"Tipo de Documento. Informação localizada na Aba \"Parcelas\" do Pedido de Venda. Pode ser: 13S 13o. Salário 99999 Outros ACO Acordo ACOB Acordo - Boleto ACOT Acordo - Transferência ADI Adiantamento ANT Antecipação APL Aplicação APO Apólice APOR Aporte ASS Assinatura BIL Bilhete BOL Boleto BOLV Boleto à Vista BONUS Bonus CAP Capitalização CART Carteira CF Cupom Fiscal CHD Cheque Devolvido CHP Cheque Pré CHQ Cheque CHT Cheque de Terceiros CNT Crédito em Conta COB Cobrança COM Comissão CON Convênios CONC Cobrança de Concessionária COND Condicional CONS Consignado CONSO Consórcio CRC Cartão de Crédito CRD Cartão de Débito CRE Crediário CRP Cartão Pré-Pago CRT Cartão CRTO Cartório CTE CT-e CTR Contrato CUSJ Custos Judiciais DACTE DACTE DAE DAE DAJE DAJE DAM DAM DANFE DANFE DAR DAR DARE DARE DARJ DARJ DARM DARM DAS DAS DDA DDA DEB Débito em Conta DEBA Débito Automático DEP Depósito DEV Devolução DFE Documento Fiscal Equivalente DIN Dinheiro DLC Distribuição de Lucros DNF Documento não fiscal DNFSE DANFSE DOA Doação DOC DOC DPVAT DPVAT DRF DARF DUA DUA DUAM DUAM DUP Duplicata EMP Empréstimo ENC Encargos ETAR Estorno de Tarifa FAT Fatura FER Férias FIA Fiado FIN Financiamento FPGT Folha de Pagamento GAR Garantia GARE GARE GNRE GNRE GPS GPS GRCS GRCS GRCSU GRCSU GRF Guia de Recolhimento do FGTS GRU GRU GUIA Guia de Recolhimento HOL Holerite IMP Imposto INV Invoice IPTU IPTU IPVA IPVA JUROS Juros Limite MED Medição MULTA Multas MUTUO Mútuo NC Nota de Crédito ND Nota de Débito NF Nota Fiscal NF3E Nota Fiscal de Energia Elétrica Eletrônica NFA Nota Fiscal de Abastecimento NFC Nota Fiscal de Consumidor NFCE Nota Fiscal de Consumidor Eletrônica NFD Nota Fiscal de Devolução NFE Nota Fiscal Eletrônica NFEE Nota Fiscal Energia Elétrica NFS Nota Fiscal de Serviço NFST Nota Fiscal de Telecomunicações NFSTM Nota Fiscal de Serviço Tomado PDD PDD PED Pedido PEN Pensão Alimentícia PER Permuta PIX Pix PROF Proforma Invoice PROL Pro-Labore PROT Protesto PROV Provisão REC Recibo REE Reembolso REND Rendimentos RES Resgate RET Rescisão Trabalhista RPA RPA SAN Sangria SAQ Saque SUP Suprimento TAR Tarifa TED TED TFE Taxa de Fiscalização de Estabelecimentos TIC Ticket TID Título Descontado TRA Transferência TRAV Transferência à Vista TRLAV Licenciamento TX Taxa VIST A Vista VOU Voucher WSITE Website Listagem completa dispon\"ivel na API: /api/v1/ger"},"nfRelacionada":{"type":"object","properties":{"cChaveRef":{"type":"string","description":"Chave da NF-e (ou NFC-e ou SAT) Relacionada."},"nNFRef":{"type":"string","description":"Número da Nota Fiscal Nota Fiscal Relacionada Modelo 1/1A"},"cSerieRef":{"type":"string","description":"Série da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A"},"dtEmissaoRef":{"type":"string","description":"Data de emissão da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A"},"cnpjEmitRef":{"type":"string","description":"CNPJ da Emitente da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A"},"cUfRef":{"type":"string","description":"Estado do Emitente da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A"},"nNfPR":{"type":"string","description":"Número da Nota Fiscal relacionada do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural"},"cSeriePR":{"type":"string","description":"Série da NF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural"},"dtEmissaoPR":{"type":"string","description":"Data de emissão da NF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural"},"cnpjPR":{"type":"string","description":"CNPJ/CPF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural"},"InscrEstPR":{"type":"string","description":"Inscrição Estadual do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural"},"cUfPR":{"type":"string","description":"Estado do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural"},"nCOORef":{"type":"string","description":"Número do COO - Contador de Ordem de Operação. Cupom Fiscal Relacionado"},"nECFRef":{"type":"string","description":"Número de Ordem Sequencial do ECF."},"indPresenca":{"type":"string","description":"Indicador de Presença da Operação. 1 - Operação presencial. 2 - Operação não presencial, pela Internet. 3 - Operação não presencial, Teleatendimento. 4 - NFC-e em operação com entrega a domicílio. 5 - Operação presencial, fora do estabelecimento. 9 - Operação não presencial, outros. Se não informado, utilizaremos automaticamente o \"9 - Outros\". Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"indIntermediario":{"type":"string","description":"Indicador de Intermediador. Esta informação deverá ser enviada quando se tratar de uma operação não presencial. Opções disponíveis: 0=Operação sem intermediador(em site ou plataforma própria) 1=Operação em site ou plataforma de terceiros(intermediadores/marketplace) Se não informado, utilizaremos automaticamente a opção \"0-Operação sem intermediador(em site ou plataforma própria)\". Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cnpjIntermediario":{"type":"string","description":"CNPJ do Intermediador. Preencimento obrigatório caso o Indicador de Intermediador seja igual a opção \"1-Operação em site ou plataforma de terceiros(intermediadores/marketplace)\". Este campo representa o CNPJ do Intermediador da Transação. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"identIntermediario":{"type":"string","description":"Identificação no Intermediador. Este identificador pode ser o nome do usuário ou identificação do perfil do vendedor no site do intermediador. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"nrProdutorRural":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","description":"Ação a ser realizada no item na alteração. Pode ser: \"I\" - Incluir o item. \"E\" - Excluir o item."},"nrNumero":{"type":"string","description":"Número da NF relacionada"},"nrSerie":{"type":"string","description":"Série da NF relacionada"},"nrDtEmissao":{"type":"string","description":"Data de emissão da NF relacionada"},"nrCnpjCpf":{"type":"string","description":"CNPJ/CPF do emitente da NF relacionada"},"nrIE":{"type":"string","description":"Inscrição Estadual do emitente da NF relacionada"},"nrUF":{"type":"string","description":"Unidade federativa do emitente da NF relacionada"}}},"description":"Outras notas de produtor rural relacionadas"},"nrNF":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","description":"Ação a ser realizada no item na alteração. Pode ser: \"I\" - Incluir o item. \"E\" - Excluir o item."},"nrChave":{"type":"string","description":"Chave da NF-e, NFC-e ou SAT relacionada"}}},"description":"Outras NF-e, NFC-e ou SAT relacionadas"},"nrCupomFiscal":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","description":"Ação a ser realizada no item na alteração. Pode ser: \"I\" - Incluir o item. \"E\" - Excluir o item."},"nrCOO":{"type":"string","description":"Contador de Ordem de Operação (COO)"},"nrNumeroECF":{"type":"string","description":"Número do ECF"}}},"description":"Outros cupons fiscais relacionados"},"nrModelo1_1A":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","description":"Ação a ser realizada no item na alteração. Pode ser: \"I\" - Incluir o item. \"E\" - Excluir o item."},"nrNumero":{"type":"string","description":"Número da NF relacionada"},"nrSerie":{"type":"string","description":"Série da NF relacionada"},"nrDtEmissao":{"type":"string","description":"Data de emissão da NF relacionada"},"nrCnpjCpf":{"type":"string","description":"CNPJ/CPF do emitente da NF relacionada"},"nrUF":{"type":"string","description":"Unidade federativa do emitente da NF relacionada"}}},"description":"Outras notas modelo 1/1A relacionadas"},"cSigNFRef":{"type":"string","description":"Manter o sigilo da NF-e referenciada. Preencher com \"S\" ou \"N\". Default \"N\""}},"description":"Detalhes da NF referenciada."},"nsu":{"type":"string","description":"Número Sequencial Único NSU - Para identificar vendas por cartões ou TransactionID TID - Para identificar vendas de comercio eletrônico. Caso informado na estrutura \"informacoes_adicionais\" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura \"parcela\"."}},"description":"Dados da Aba \"Informações Adicionais\" do Pedido de Venda."},"lista_parcelas":{"type":"object","properties":{"parcela":{"type":"array","items":{"type":"object","properties":{"numero_parcela":{"type":"integer","description":"Número da Parcela. Informação localizada na Aba \"Parcelas\" do Pedido de Venda."},"valor":{"type":"decimal","description":"Valor da Parcela. Informação localizada na Aba \"Parcelas\" do Pedido de Venda."},"percentual":{"type":"decimal","description":"Percentual da Parcela. Informação localizada na Aba \"Parcelas\" do Pedido de Venda."},"data_vencimento":{"type":"string","description":"Data de Vencimento da Parcela. Informação localizada na Aba \"Parcelas\" do Pedido de Venda."},"quantidade_dias":{"type":"integer","description":"Quantidade de dias até o vencimento da parcela. Informação localizada na Aba \"Parcelas\" do Pedido de Venda."},"tipo_documento":{"type":"string","description":"Tipo de Documento. Informação localizada na Aba \"Parcelas\" do Pedido de Venda. Pode ser: 13S 13o. Salário 99999 Outros ACO Acordo ACOB Acordo - Boleto ACOT Acordo - Transferência ADI Adiantamento ANT Antecipação APL Aplicação APO Apólice APOR Aporte ASS Assinatura BIL Bilhete BOL Boleto BOLV Boleto à Vista BONUS Bonus CAP Capitalização CART Carteira CF Cupom Fiscal CHD Cheque Devolvido CHP Cheque Pré CHQ Cheque CHT Cheque de Terceiros CNT Crédito em Conta COB Cobrança COM Comissão CON Convênios CONC Cobrança de Concessionária COND Condicional CONS Consignado CONSO Consórcio CRC Cartão de Crédito CRD Cartão de Débito CRE Crediário CRP Cartão Pré-Pago CRT Cartão CRTO Cartório CTE CT-e CTR Contrato CUSJ Custos Judiciais DACTE DACTE DAE DAE DAJE DAJE DAM DAM DANFE DANFE DAR DAR DARE DARE DARJ DARJ DARM DARM DAS DAS DDA DDA DEB Débito em Conta DEBA Débito Automático DEP Depósito DEV Devolução DFE Documento Fiscal Equivalente DIN Dinheiro DLC Distribuição de Lucros DNF Documento não fiscal DNFSE DANFSE DOA Doação DOC DOC DPVAT DPVAT DRF DARF DUA DUA DUAM DUAM DUP Duplicata EMP Empréstimo ENC Encargos ETAR Estorno de Tarifa FAT Fatura FER Férias FIA Fiado FIN Financiamento FPGT Folha de Pagamento GAR Garantia GARE GARE GNRE GNRE GPS GPS GRCS GRCS GRCSU GRCSU GRF Guia de Recolhimento do FGTS GRU GRU GUIA Guia de Recolhimento HOL Holerite IMP Imposto INV Invoice IPTU IPTU IPVA IPVA JUROS Juros Limite MED Medição MULTA Multas MUTUO Mútuo NC Nota de Crédito ND Nota de Débito NF Nota Fiscal NF3E Nota Fiscal de Energia Elétrica Eletrônica NFA Nota Fiscal de Abastecimento NFC Nota Fiscal de Consumidor NFCE Nota Fiscal de Consumidor Eletrônica NFD Nota Fiscal de Devolução NFE Nota Fiscal Eletrônica NFEE Nota Fiscal Energia Elétrica NFS Nota Fiscal de Serviço NFST Nota Fiscal de Telecomunicações NFSTM Nota Fiscal de Serviço Tomado PDD PDD PED Pedido PEN Pensão Alimentícia PER Permuta PIX Pix PROF Proforma Invoice PROL Pro-Labore PROT Protesto PROV Provisão REC Recibo REE Reembolso REND Rendimentos RES Resgate RET Rescisão Trabalhista RPA RPA SAN Sangria SAQ Saque SUP Suprimento TAR Tarifa TED TED TFE Taxa de Fiscalização de Estabelecimentos TIC Ticket TID Título Descontado TRA Transferência TRAV Transferência à Vista TRLAV Licenciamento TX Taxa VIST A Vista VOU Voucher WSITE Website Listagem completa dispon\"ivel na API: /api/v1/ger"},"meio_pagamento":{"type":"string","description":"Meio de Pagamento - Utilizado apenas para emissão de NF-e (campo \"tPag\" do XML). Esse campo indica como a parcela da nota será paga. Informação localizada na Aba \"Parcelas\" do Pedido de Venda. Caso informado na estrutura \"informacoes_adicionais\" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura \"parcela\". Pode ser: 01 Dinheiro 02 Cheque 03 Cartão de Crédito 04 Cartão de Débito 05 Crédito Loja 10 Vale Alimentação 11 Vale Refeição 12 Vale Presente 13 Vale Combustível 15 Boleto Bancário 16 Depósito Bancário 17 Pagamento Instantâneo (PIX) 18 Transferência bancária, Carteira Digital 19 Programa de fidelidade, Cashback, Crédito Virtual. 90 Sem Pagamento 99 Outros Listagem completa disponível na API: /api/v1/geral/meiospagamento/"},"descr_meio_pagamento":{"type":"string","description":"Descrição do Meio de Pagamento - Utilizado apenas para emissão de NF-e (campo \"xPag\" do XML). Esse campo precisa ser informado quando a tag \"meio_pagamento\" for igual a 99 (Outros). Informação localizada na Aba \"Parcelas\" do Pedido de Venda. Caso informado na estrutura \"informacoes_adicionais\" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura \"parcela\"."},"nsu":{"type":"string","description":"Número Sequencial Único NSU - Para identificar vendas por cartões ou TransactionID TID - Para identificar vendas de comercio eletrônico. Caso informado na estrutura \"informacoes_adicionais\" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura \"parcela\"."},"nao_gerar_boleto":{"type":"string","description":"Indica se o boleto não deve ser gerado para a(s) parcela(s) ao emitir a nota fiscal. Informe \"S\" para não gerar o boleto. O padrão é \"N\". Quando informado dentro do tag \"cabecalho\", aplica-se como valor padrão para todas as parcelas, caso não seja especificado individualmente em cada uma. Quando informado dentro da tag \"lista_parcelas\", aplica-se individualmente para cada parcela (tem prioridade sobre o valor informado no cabeçalho). Informação localizada na Aba \"Parcelas\" do Pedido de Venda."},"parcela_adiantamento":{"type":"string","description":"Está é uma parcela de Adiantamento do Cliente. Informe \"S\" para indicar que é uma parcela de adiantamento. O padrão é \"N\". Informação localizada na Aba \"Parcelas\" do Pedido de Venda."},"categoria_adiantamento":{"type":"string","description":"Código da Categoria para o Adiantamento. Será utilizada na conta a receber que representa o adiantamento desta parcela. Informação localizada na Aba \"Parcelas\" do Pedido de Venda."},"conta_corrente_adiantamento":{"type":"integer","description":"Conta Corrente de Adiantamento. Informação localizada na Aba \"Parcelas\" do Pedido de Venda."},"bandeira":{"type":"string","description":"Código da Bandeira da operadora de cartão."},"cnpj_fin":{"type":"string","description":"Informar o CNPJ da instituição de pagamento, adquirente ou subadquirente."}}},"description":"Dados da parcela."}},"description":"Dados da Aba \"Parcelas\" do Pedido de Venda. Para todos os outros códigos o preenchimento é automático - Não informar essa estrutura."},"observacoes":{"type":"object","properties":{"obs_venda":{"type":"string","description":"Observações da venda (elas não serão exibidas na Nota Fiscal). Informação localizada na Aba \"Observações\" do Pedido de Venda."}},"description":"Dados da Aba \"Observações\" do Pedido de Venda."},"det":{"type":"array","items":{"type":"object","properties":{"ide":{"type":"object","properties":{"codigo_item_integracao":{"type":"string","description":"Código de Integração do Item do Pedido de Venda. Informe a identificação do Item do Pedido de Venda. Caso você não tenha essa informação no seu aplicativo, informe o número sequencial de cada item do pedido. Informa de 1 a 199."},"codigo_item":{"type":"integer","description":"ID do Item do Pedido."},"simples_nacional":{"type":"string","description":"Indica que a empresa é Optante pelo Simples Nacional. Informar \"S\" ou \"N\"."},"acao_item":{"type":"string","description":"Ação para o item. Pode ser: \"E\" - para excluir um item."},"id_ordem_producao":{"type":"integer","description":"Id da Ordem de Produção. Campo disponível apenas para consulta. Não deve ser informado na Inclusão ou Alteração."},"regra_impostos":{"type":"integer","description":"DEPRECATED"}},"description":"Identificação do Item do Pedido de Vendas."},"produto":{"type":"object","properties":{"codigo_produto":{"type":"integer","description":"ID do Produto. Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs. Utilize a tag \"codigo_produto\" do método \"ListarProdutos\" da API http://app.omie.com.br/api/v1/geral/produtos/ para obter essa informação."},"codigo_produto_integracao":{"type":"string","description":"Código de integração do Produto. Esse campo deve ser informado apenas se você incluiu o produto via API e informou um código de integração para o produto. Do contrário, informe sempre a tag \"codigo_produto\"."},"codigo":{"type":"string","description":"Código do Produto exibido na tela do Pedido de Vendas."},"descricao":{"type":"string","description":"Descrição do Produto."},"cfop":{"type":"string","description":"CFOP - Código Fiscal de Operações e Prestações. Utilize a tag \"nCodigo\" do método \"ListarCFOP\" da API http://app.omie.com.br/api/v1/produtos/cfop/ para obter essa informação."},"ncm":{"type":"string","description":"NCM - Nomenclatura Comum do Mercosul Utilize a tag \"cCodigo\" do método \"ListarNCM\" da API http://app.omie.com.br/api/v1/produtos/ncm/ para obter essa informação."},"ean":{"type":"string","description":"EAN - European Article Number"},"unidade":{"type":"string","description":"Unidade. Utilize a tag \"codigo\" do método \"ListarUnidades\" da API http://app.omie.com.br/api/v1/geral/unidade/ para obter essa informação."},"quantidade":{"type":"decimal","description":"Quantidade No método de devolução de pedido: Caso não seja preenchida será feita a devolução integral do produto."},"valor_unitario":{"type":"decimal","description":"Valor Únitário"},"codigo_tabela_preco":{"type":"integer","description":"Código da tabela de preço. (Interno, utilizado apenas na integração via API, não é exibido na tela). Deve ser informada opcionalmente, caso a tabela de preços esteja configurada no Omie."},"valor_mercadoria":{"type":"decimal","description":"Valor da Mercadoria"},"tipo_desconto":{"type":"string","description":"Tipo de Desconto."},"percentual_desconto":{"type":"decimal","description":"Percentual de Desconto."},"valor_desconto":{"type":"decimal","description":"Valor do Desconto"},"valor_deducao":{"type":"decimal","description":"Valor da Dedução"},"valor_icms_desonerado":{"type":"decimal","description":"Valor do ICMS desonerado"},"motivo_icms_desonerado":{"type":"string","description":"Código do Motivo de desoneração do ICMS Códigos válidos para desoneração do ICMS 01 Táxi 03 Produtor Agropecuário 04 Frotista/Locadora 05 Diplomático/Consular 06 Utilitários e Motocicletas da Amazônia Ocidental e Áreas de Livre Comércio (Resolução 714/88 e 790/94 ? CONTRAN e suas alterações) 07 SUFRAMA 08 Venda a Órgão Público 09 Outros. (NT 2011/004) 10 Deficiente Condutor (Convênio ICMS 38/12) 11 Deficiente Não Condutor (Convênio ICMS 38/12) 16 Olimpíadas Rio 2016 90 Solicitado pelo Fisco"},"valor_total":{"type":"decimal","description":"Valor Total."},"indicador_escala":{"type":"string","description":"Indicador de Produção em Escala Relevante. Pode ser: \"S\" para Produzido em Escala Relevante. \"N\" para Produzido em Escala NÃO Relevante."},"cnpj_fabricante":{"type":"string","description":"CNPJ do Fabricante da Mercadoria."},"kit":{"type":"string","description":"Indica se o produto é um kit"},"componente_kit":{"type":"string","description":"Indica se o produto é um componente de um kit"},"codigo_item_kit":{"type":"integer","description":"ID do Item do kit (pai) que o componente pertence"},"reservado":{"type":"string","description":"(S/N) Indica se o estoque do produto será reservado."}},"description":"Identificação do Produto do Item do Pedido de Vendas."},"observacao":{"type":"object","properties":{"obs_item":{"type":"string","description":"Observações do item (elas não serão exibidas na Nota Fisca, mas serão impressas no pedido de vendal). Informação localizada na Aba \"Observações\" do Item do Pedido de Venda."}},"description":"Dados da aba \"Observações\" do Item do Pedido de Vendas."},"inf_adic":{"type":"object","properties":{"peso_liquido":{"type":"decimal","description":"Peso Líquido (Kg)."},"peso_bruto":{"type":"decimal","description":"Peso Bruto (Kg)."},"numero_pedido_compra":{"type":"string","description":"Número do Pedido de Compra."},"item_pedido_compra":{"type":"integer","description":"Item do Pedido de Compra."},"dados_adicionais_item":{"type":"string","description":"Informações para a Nota Fiscal."},"nao_movimentar_estoque":{"type":"string","description":"Não gerar a saída de estoque deste item ao emitir NF-e. Informar \"S\" ou \"N\". (informe \"S\" para ativar essa opção)."},"nao_gerar_financeiro":{"type":"string","description":"Não gerar conta a receber para este item. Informar \"S\" ou \"N\". (Informe \"S\" para ativar essa opção)."},"codigo_categoria_item":{"type":"string","description":"Código da Categoria do item."},"codigo_beneficio_fiscal":{"type":"string","description":"Código do Benefício Fiscal."},"numero_fci":{"type":"string","description":"Número da FCI (Ficha de Conteúdo de Importação)"},"codigo_local_estoque":{"type":"integer","description":"Código do Local do Estoque."},"codigo_cenario_impostos_item":{"type":"integer","description":"Código do Cenário de Impostos."},"nao_somar_total":{"type":"string","description":"Não somar este item no total da NF-e"},"numero_recopi":{"type":"string","description":"Número do registro gerado pelo sistema RECOPI Nacional (Reconhecimento e Controle das Operações com Papel Imune)."}},"description":"Dados da aba \"Informações Adicionais\" do Item do Pedido de Vendas."},"imposto":{"type":"object","properties":{"icms_sn":{"type":"object","properties":{"cod_sit_trib_icms_sn":{"type":"string"},"origem_icms_sn":{"type":"string"},"aliq_icms_sn":{"type":"decimal"},"valor_credito_icms_sn":{"type":"decimal"},"base_icms_sn":{"type":"decimal"},"valor_icms_sn":{"type":"decimal"}},"description":"ICMS - Simples Nacional."},"icms":{"type":"object","properties":{"cod_sit_trib_icms":{"type":"string"},"origem_icms":{"type":"string"},"modalidade_icms":{"type":"string"},"perc_red_base_icms":{"type":"decimal"},"base_icms":{"type":"decimal"},"aliq_icms":{"type":"decimal"},"valor_icms":{"type":"decimal"},"perc_fcp_icms":{"type":"decimal","description":"Percentual do FCP - Fundo de Combate a Pobreza do ICMS."},"base_fcp_icms":{"type":"decimal","description":"Base de Cálculo do FCP - Fundo de Combate a Pobreza do ICMS."},"valor_fcp_icms":{"type":"decimal","description":"Valor do FCP - Fundo de Combate a Pobreza do ICMS."}},"description":"ICMS"},"icms_st":{"type":"object","properties":{"cod_sit_trib_icms_st":{"type":"string"},"modalidade_icms_st":{"type":"string"},"perc_red_base_icms_st":{"type":"decimal"},"base_icms_st":{"type":"decimal"},"aliq_icms_st":{"type":"decimal"},"margem_icms_st":{"type":"decimal"},"valor_icms_st":{"type":"decimal"},"aliq_icms_opprop":{"type":"decimal","description":"Alíquota de ICMS Operação Própria."},"perc_red_base_icms_op":{"type":"decimal","description":"Percentual de redução de base de cálculo de Icms Operação Própria."},"cest":{"type":"string","description":"CEST - Código Especificador da Substituíção Tributária."},"perc_fcp_icms_st":{"type":"decimal","description":"Percentual do FCP - Fundo de Combate a Pobreza do ICMS ST."},"base_fcp_icms_st":{"type":"decimal","description":"Base de Cálculo do FCP - Fundo de Combate a Pobreza do ICMS ST."},"valor_fcp_icms_st":{"type":"decimal","description":"Valor do FCP - Fundo de Combate a Pobreza do ICMS ST."}},"description":"ICMS - Substituição Tributária."},"icms_ie":{"type":"object","properties":{"base_icms_uf_destino":{"type":"decimal","description":"BC do ICMS na UF de Destino"},"aliq_icms_FCP":{"type":"decimal","description":"Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de Destino"},"aliq_interna_uf_destino":{"type":"decimal","description":"Alíquota Interna da UF de Destino"},"aliq_interestadual":{"type":"decimal","description":"Alíquota Interestadual das UFs Envolvidas"},"aliq_partilha_icms":{"type":"decimal","description":"Percentual Provisório de Partilha do ICMS Interestadual"},"valor_fcp_icms_inter":{"type":"decimal","description":"Valor do fundo de combate a pobreza."},"valor_icms_uf_dest":{"type":"decimal","description":"Valor do ICMS - UF Destino"},"valor_icms_uf_remet":{"type":"decimal","description":"Valor do ICMS - UF Remetente"}},"description":"ICMS Interestadual."},"icms_efet":{"type":"object","properties":{"cod_sit_trib_icms_efet":{"type":"string"},"origem_icms_efet":{"type":"string"},"modalidade_icms_efet":{"type":"string"},"perc_red_base_icms_efet":{"type":"decimal"},"base_icms_efet":{"type":"decimal"},"aliq_icms_efet":{"type":"decimal"},"valor_icms_efet":{"type":"decimal"}},"description":"ICMS efetivo. Não informar na Inclusão e Alteração. Utilizado somente na Consulta e Listagem"},"ipi":{"type":"object","properties":{"cod_sit_trib_ipi":{"type":"string"},"tipo_calculo_ipi":{"type":"string"},"enquadramento_ipi":{"type":"string","description":"Enquadramento do IPI"},"base_ipi":{"type":"decimal"},"aliq_ipi":{"type":"decimal"},"qtde_unid_trib_ipi":{"type":"decimal"},"valor_unid_trib_ipi":{"type":"decimal"},"valor_ipi":{"type":"decimal"}},"description":"IPI."},"pis_padrao":{"type":"object","properties":{"cod_sit_trib_pis":{"type":"string"},"tipo_calculo_pis":{"type":"string"},"base_pis":{"type":"decimal"},"aliq_pis":{"type":"decimal"},"qtde_unid_trib_pis":{"type":"decimal"},"valor_unid_trib_pis":{"type":"decimal"},"valor_pis":{"type":"decimal"}},"description":"PIS."},"pis_st":{"type":"object","properties":{"cod_sit_trib_pis_st":{"type":"string"},"tipo_calculo_pis_st":{"type":"string"},"base_pis_st":{"type":"decimal"},"aliq_pis_st":{"type":"decimal"},"qtde_unid_trib_pis_st":{"type":"decimal"},"valor_unid_trib_pis_st":{"type":"decimal"},"margem_pis_st":{"type":"decimal"},"valor_pis_st":{"type":"decimal"}},"description":"PIS - Substituíção Tributária."},"cofins_padrao":{"type":"object","properties":{"cod_sit_trib_cofins":{"type":"string"},"tipo_calculo_cofins":{"type":"string"},"base_cofins":{"type":"decimal"},"aliq_cofins":{"type":"decimal"},"qtde_unid_trib_cofins":{"type":"decimal"},"valor_unid_trib_cofins":{"type":"decimal"},"valor_cofins":{"type":"decimal"}},"description":"COFINS."},"cofins_st":{"type":"object","properties":{"cod_sit_trib_cofins_st":{"type":"string"},"tipo_calculo_cofins_st":{"type":"string"},"base_cofins_st":{"type":"decimal"},"aliq_cofins_st":{"type":"decimal"},"qtde_unid_trib_cofins_st":{"type":"decimal"},"valor_unid_trib_cofins_st":{"type":"decimal"},"margem_cofins_st":{"type":"decimal"},"valor_cofins_st":{"type":"decimal"}},"description":"COFINS - Substituição Tributária."},"inss":{"type":"object","properties":{"aliq_inss":{"type":"decimal"},"valor_inss":{"type":"decimal"}},"description":"INSS."},"csll":{"type":"object","properties":{"aliq_csll":{"type":"decimal"},"valor_csll":{"type":"decimal"}},"description":"CSLL."},"irrf":{"type":"object","properties":{"aliq_irrf":{"type":"decimal"},"valor_irrf":{"type":"decimal"}},"description":"IRRF."},"iss":{"type":"object","properties":{"base_iss":{"type":"decimal"},"aliq_iss":{"type":"decimal"},"valor_iss":{"type":"decimal"},"retem_iss":{"type":"string"}},"description":"ISS."},"ibs_cbs":{"type":"object","properties":{"cst_ibs_cbs":{"type":"string","description":"Código de Situação Tributária do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"class_trib":{"type":"string","description":"Código de Classificação Tributária do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"base_ibs_cbs":{"type":"decimal","description":"Base de cálculo do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."}}},"ibs":{"type":"object","properties":{"aliquota_ibs_uf":{"type":"decimal","description":"Alíquota do IBS de competência das UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"perc_dif_ibs_uf":{"type":"decimal","description":"Percentual do Diferimento - IBS UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"perc_red_ibs_uf":{"type":"decimal","description":"Percentual da redução de alíquota - IBS UF. Não deve ser informado na Inclusão/Alteração. Campos disponíveis apenas para consulta. Para os métodos de inclusão e alteração, esses campos serão alimentados conforme o cenário fiscal."},"valor_dif_ibs_uf":{"type":"decimal","description":"Valor do Diferimento - IBS UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_ibs_uf":{"type":"decimal","description":"Valor do IBS de competência da UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"aliquota_ibs_mu":{"type":"decimal","description":"Alíquota do IBS de competência do Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"perc_dif_ibs_mu":{"type":"decimal","description":"Percentual do diferimento - UBS Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"perc_red_ibs_mu":{"type":"decimal","description":"Percentual da redução de alíquota - IBS Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_dif_ibs_mu":{"type":"decimal","description":"Valor do Diferimento - IBS Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_ibs_mu":{"type":"decimal","description":"Valor do IBS de competência do Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_ibs":{"type":"decimal","description":"Valor total do IBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."}}},"cbs":{"type":"object","properties":{"aliquota_cbs":{"type":"decimal","description":"Alíquota da CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"perc_dif_cbs":{"type":"decimal","description":"Percentual do diferimento - CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"perc_red_cbs":{"type":"decimal","description":"Percentual da redução de alíquota - CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_dif_cbs":{"type":"decimal","description":"Valor do diferimento - CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_cbs":{"type":"decimal","description":"Valor da CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."}}},"trib_reg":{"type":"object","properties":{"cst_reg_ibs_cst":{"type":"string","description":"Código da Situação Tributária do IBS e CBS (Tributação Regular). Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"class_trib_reg":{"type":"string","description":"Código de Classificação Tributária do IBS e CBS (Tributação Regular). Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"aliquota_reg_ibs_uf":{"type":"decimal","description":"Valor da alíquota do IBS da UF na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"aliquota_reg_ibs_mu":{"type":"decimal","description":"Valor da alíquota do IBS do Município na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"aliquota_reg_cbs":{"type":"decimal","description":"Valor da alíquota da CBS na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_reg_ibs_uf":{"type":"decimal","description":"Valor do Tributo do IBS da UF na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_reg_ibs_mu":{"type":"decimal","description":"Valor do Tributo do IBS do Município na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_reg_cbs":{"type":"decimal","description":"Valor do Tributo da CBS na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."}}}},"description":"Informações referentes aos impostos do Item do Pedido de Vendas. Essa estrutura deve ser preenchida quando os dados dos impostos devem ser respeitados tais como foram enviados na API. Caso essa estrutura não seja enviada, o Omie irá identificar a regra de imposto que melhor se ajusta as condições da venda realizada. Para utilizar essa opção esteja seguro de que as regras e cenários de impostos estejam cadastrados corretamente no Omie. As infomações preenchidas serão decorrentes dos dados configurados."},"rastreabilidade":{"type":"object","properties":{"numeroLote":{"type":"string","description":"Número do Lote"},"qtdeProdutoLote":{"type":"decimal","description":"Quantidade de Produto"},"dataFabricacaoLote":{"type":"string","description":"Data de Fabricação/Produção"},"dataValidadeLote":{"type":"string","description":"Data de Validade"},"codigoAgregacaoLote":{"type":"string","description":"Código de Agregação"}},"description":"Dados da rastreabilidade do produto."},"combustivel":{"type":"object","properties":{"cCodigoANP":{"type":"string","description":"Código de Produto da ANP."},"cDescrANP":{"type":"string","description":"Descrição do Produto conforme ANP."},"cCODIF":{"type":"string","description":"Registro do CODIF."},"nPercGLP":{"type":"decimal","description":"Percentual de GLP Derivado do Petróleo."},"nPercGasNacional":{"type":"decimal","description":"Percentual de Gás Natural Nacional."},"nPercGasImportado":{"type":"decimal","description":"Percentual de Gás Natural Importado."},"nValorPartida":{"type":"decimal","description":"Valor de Partida."},"nQtdeFatTempAmb":{"type":"decimal","description":"Quantidade Faturada à Temperatura Ambiente."},"cUFConsumoComb":{"type":"string","description":"UF de Consumo."},"nBC_CIDE":{"type":"decimal","description":"Base de Cálculo (em quantidade) da CIDE."},"nAliquota_CIDE":{"type":"decimal","description":"Valor da Alíquota em Reais da CIDE."},"nValor_CIDE":{"type":"decimal","description":"Valor da CIDE."},"nBC_UFRem":{"type":"decimal","description":"Base de Cálculo da UF Remetente. Base de Cálculo do ICMS retido anteriormente por Substituição Tributária."},"nValorUFRem":{"type":"decimal","description":"Valor da UF Remetente. Alíquota do ICMS retido anteriormente por Substituição Tributária."},"nBC_UFDest":{"type":"decimal","description":"Base de Cálculo da UF Destino. Base de Cálculo do ICMS ST da UF Destino."},"nValorUFDest":{"type":"decimal","description":"Valor da UF Destino. Base de Cálculo do ICMS ST da UF Destino."}},"description":"Detalhamento específico de Combustível."},"tributavel":{"type":"object","properties":{"cUnidTrib":{"type":"string","description":"Unidade tributável do Item."},"nQuantTrib":{"type":"decimal","description":"Quantidade tributável do item."},"nValorTrib":{"type":"decimal","description":"Valor tributável do item."},"cEanTrib":{"type":"string","description":"código EAN tributável do item."}},"description":"Unidade, Quantidade, Valor e EAN tributáveis do item do pedido."},"lote_validade":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","description":"Id do Lote do produto. Obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.."},"nQtdLote":{"type":"decimal","description":"Informe aqui a quantidade do Lote para o produto. É obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações."}}},"description":"Informações referentes ao lote e validade do produto. A tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes \"manualmente\" por API."}}},"description":"Dados da Aba \"Itens da Venda\" do Pedido de Venda."},"market_place":{"type":"object","properties":{"nTaxa":{"type":"decimal","description":"Valor da taxa do Market Place."},"nEnvio":{"type":"decimal","description":"Valor do envio do Market Place."}},"description":"Dados para o Market Place."},"total_pedido":{"type":"object","properties":{"base_calculo_icms":{"type":"decimal","description":"Base de Cálculo do ICMS."},"base_calculo_st":{"type":"decimal","description":"Base de cálculo da substituição tributária."},"valor_pis":{"type":"decimal","description":"Valor do PIS."},"valor_cofins":{"type":"decimal","description":"Valor do cofins."},"valor_csll":{"type":"decimal","description":"Valor da CSLL."},"valor_icms":{"type":"decimal","description":"Valor total do ICMS."},"valor_st":{"type":"decimal","description":"Valor total da ST."},"valor_inss":{"type":"decimal","description":"Valor do INSS."},"valor_IPI":{"type":"decimal","description":"Valor do IPI."},"valor_ir":{"type":"decimal","description":"Valor do IR. .Preenchimento automático - Não informar."},"valor_iss":{"type":"decimal","description":"Valor do ISS."},"valor_deducoes":{"type":"decimal","description":"Valor das deduções."},"valor_descontos":{"type":"decimal","description":"Valor dos descontos."},"valor_mercadorias":{"type":"decimal","description":"valor das mercadorias."},"valor_total_pedido":{"type":"decimal","description":"Valor total do pedido."},"base_ibs_cbs":{"type":"decimal","description":"Valor total da base de cálculo do IBS e da CBS."},"valor_dif_ibs_uf":{"type":"decimal","description":"Valor total do diferimento do IBS UF."},"valor_ibs_uf":{"type":"decimal","description":"Valor total do IBS da UF."},"valor_dif_ibs_mu":{"type":"decimal","description":"Valor total do diferimento do IBS do município."},"valor_ibs_mu":{"type":"decimal","description":"Valor total do IBS do município."},"valor_ibs":{"type":"decimal","description":"Valor total do IBS."},"valor_dif_cbs":{"type":"decimal","description":"Valor total do diferimento da CBS."},"valor_cbs":{"type":"decimal","description":"Valor total da CBS."},"valor_tot_ibs_cbs_is":{"type":"decimal","description":"Total da NF-e com IBS/CBS/IS."}},"description":"Valores totais do pedido."},"infoCadastro":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão."},"hInc":{"type":"string","description":"Hora da Inclusão."},"uInc":{"type":"string","description":"Usuário da Inclusão."},"dAlt":{"type":"string","description":"Data da Alteração."},"hAlt":{"type":"string","description":"Hora da Alteração."},"uAlt":{"type":"string","description":"Usuário da Alteração."},"dCan":{"type":"string","description":"Data da Cancelamento."},"hCan":{"type":"string","description":"Hora da Cancelamento."},"uCan":{"type":"string","description":"Usuário da Cancelamento."},"cancelado":{"type":"string","description":"Indica se o pedido foi cancelado."},"dFat":{"type":"string","description":"Data de Faturamento."},"hFat":{"type":"string","description":"Hora de faturamento."},"uFat":{"type":"string","description":"Usuário que realizou o faturamento."},"faturado":{"type":"string","description":"Indica se o pedido está faturado."},"denegado":{"type":"string","description":"Indica se o pedido foi denegado."},"autorizado":{"type":"string","description":"Indica se o pedido foi autorizado."},"devolvido":{"type":"string","description":"Indica se o pedido foi devolvido."},"devolvido_parcial":{"type":"string","description":"Indica se o pedido foi devolvido parcialmente."},"cImpAPI":{"type":"string","description":"Importado pela API."}},"description":"Informações complementares do pedido."},"exportacao":{"type":"object","properties":{"nao_exportacao":{"type":"string","description":"O cliente é estrangeiro, mas na verdade não se trata de uma exportação"},"local_embarque":{"type":"string","description":"Local de Embarque (ou de transposição de fronteira)"},"uf_embarque":{"type":"string","description":"UF do Local de Embarque"},"local_despacho":{"type":"string","description":"Local de Despacho"}},"description":"Dados da exportacao"},"lancamentos":{"type":"array","items":{"type":"object","properties":{"nSequencia":{"type":"integer","description":"Número da Sequencia. Para os itens da NF identifica qual o item do XML se refere. Para as parcelas da NF identifica o número da parcela. Para os lançamentos no Conta Corrente indentifica o lançamento que será gerado. Permite sequencial de 1 a 999."},"cNaturezaDocumento":{"type":"string","description":"Natureza do Documento. Pode ser: P - Pagar R - Receber Obrigatório na operação \"IncluirPedido\"; não é processado nas demais operações que reutilizam esta estrutura, como \"AlterarPedidoVenda\"."},"nValorDocumento":{"type":"decimal","description":"Valor do Documento. Obrigatório na operação \"IncluirPedido\"; não é processado nas demais operações que reutilizam esta estrutura, como \"AlterarPedidoVenda\"."},"dDataDocumento":{"type":"string","description":"Data do documento. Obrigatório na operação \"IncluirPedido\"; não é processado nas demais operações que reutilizam esta estrutura, como \"AlterarPedidoVenda\"."},"cTipoDocumento":{"type":"string","description":"Tipo de Documento. Lista de tipos de documentos em: /api/v1/geral/tiposdoc Obrigatório na operação \"IncluirPedido\"; não é processado nas demais operações que reutilizam esta estrutura, como \"AlterarPedidoVenda\"."},"cCategoria":{"type":"string","description":"Código da Categoria."},"nContaCorrente":{"type":"integer","description":"Id da Conta Corrente."},"cOrigem":{"type":"string","description":"Origem da Nota Fiscal. Códigos Disponíveis: API - Importado via API. Obrigatório na operação \"IncluirPedido\"; não é processado nas demais operações que reutilizam esta estrutura, como \"AlterarPedidoVenda\"."},"cObs":{"type":"string","description":"Observações."},"nProjeto":{"type":"integer","description":"Id do projeto."},"nVendedor":{"type":"integer","description":"Id do Vendedor."}}},"description":"Lançamentos no Conta Corrente relacionados ao Pedido de Vendas taxas,entre outros)."},"agropecuario":{"type":"object","properties":{"cNumReceita":{"type":"string","description":"Número da receita ou receituário do agrotóxico/defensivo agrícola"},"cCpfResponsavel":{"type":"string","description":"CPF do responsá¡vel técnico legalmente habilitado"},"nTipoGuia":{"type":"integer","description":"Tipo da Guia 1 - Corresponde ao GTA 2 - Corresponde ao TTA 3 - Corresponde ao DTA 4 - Corresponde ao ATV 5 - Corresponde ao PTV 6 - Corresponde ao GTV 7 - Corresponde ao Guia Florestal (DOF, SisFlora - PA e MT, SIAM - MG)"},"cUFGuia":{"type":"string","description":"UF de emissão da Guia"},"cSerieGuia":{"type":"string","description":"Número de série da guia"},"nNumGuia":{"type":"integer","description":"Número da guia"}}}},"description":"Cadastro de Pedido de Venda"}},"title":"ConsultarPedido (retorno)"},"produtos_pedido_DevolverPedido":{"type":"object","title":"DevolverPedido","description":"Método para efetuar a devolução de um pedido.","required":["call","param"],"properties":{"call":{"type":"string","enum":["DevolverPedido"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_pedido":{"type":"integer","maxLength":15,"description":"ID do pedido do venda.\n\nEsse campo não é exibido na tela do Pedido de Vendas.\nÉ uma informação interna, utilizada apenas nas APIs."},"codigo_pedido_integracao":{"type":"string","maxLength":60,"description":"Código de integração do pedido de venda.\n\nPreencha esse campo com o código do pedido no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de pedidos você conseguirá ver a relação entre o id do pedido gerado no Omie e o código de pedido existente em sua aplicação."},"nIdMotivDevol":{"type":"integer","maxLength":15,"description":"ID do motivo da devolução.\n\nOpcional no registro da devolução, porém exigido no faturamento. Se não for informado aqui, o motivo terá que ser preenchido na tela antes de chamar o FaturarDevolucao.\n\nA lista de motivos disponíveis está em: /api/v1/geral/motivodevolucao/"},"itens":{"type":"object","properties":{"codigo_produto":{"type":"integer","maxLength":15,"description":"Id do produto."},"quantidade":{"type":"number","maxLength":18,"description":"Quantidade\n\nNo método de devolução de pedido:\nCaso não seja preenchida será feita a devolução integral do produto."}},"required":["codigo_produto"],"description":"Informações dos itens que serão devolvidos.\n\nCaso essa tag não seja preenchida será realizado a devolução integral de todos os itens do pedido."}}}}},"example":{"call":"DevolverPedido","param":[{"codigo_pedido":0,"codigo_pedido_integracao":"","itens":[{"codigo_produto":0,"quantidade":0}]}]}},"produtos_pedido_DevolverPedido_retorno":{"type":"object","properties":{"cCodStatus":{"type":"string"},"cDesStatus":{"type":"string"},"nIdDevolucao":{"type":"integer","description":"ID da devolução."},"cNumeroDevolucao":{"type":"string","description":"Número do documento da devolução gerada, como aparece na tela."}},"title":"DevolverPedido (retorno)"},"produtos_pedido_ExcluirPedido":{"type":"object","title":"ExcluirPedido","description":"Excluir pedido de venda de produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirPedido"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_pedido":{"type":"integer","maxLength":15,"description":"ID do pedido do venda.\nCodigo do Pedido\n\nEsse campo não é exibido na tela do Pedido de Vendas.\nÉ uma informação interna, utilizada apenas nas APIs."},"codigo_pedido_integracao":{"type":"string","maxLength":60,"description":"Código de integração do pedido de venda.\n\nPreencha esse campo com o código do pedido no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de pedidos você conseguirá ver a relação entre o id do pedido gerado no Omie e o código de pedido existente em sua aplicação."}}}}},"example":{"call":"ExcluirPedido","param":[{"codigo_pedido":0,"codigo_pedido_integracao":""}]}},"produtos_pedido_ExcluirPedido_retorno":{"type":"object","properties":{"codigo_pedido":{"type":"integer","description":"ID do pedido do venda. Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs."},"codigo_pedido_integracao":{"type":"string","description":"Código de integração do pedido de venda. Preencha esse campo com o código do pedido no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de pedidos você conseguirá ver a relação entre o id do pedido gerado no Omie e o código de pedido existente em sua aplicação."},"numero_pedido":{"type":"string","description":"Número do pedido de venda. Esse é o número do pedido de venda no Omie, que é gerado automaticamente e exibido na tela."},"codigo_status":{"type":"string","description":"Código do Status do Pedido de Venda."},"descricao_status":{"type":"string","description":"Descrição do status."}},"title":"ExcluirPedido (retorno)"},"produtos_pedido_IncluirPedido":{"type":"object","title":"IncluirPedido","description":"Inclui um pedido de venda de produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirPedido"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cabecalho":{"type":"object","properties":{"codigo_pedido":{"type":"integer","maxLength":15,"description":"ID do pedido do venda.\n\nEsse campo não é exibido na tela do Pedido de Vendas.\nÉ uma informação interna, utilizada apenas nas APIs."},"codigo_pedido_integracao":{"type":"string","maxLength":60,"description":"Código de integração do pedido de venda.\n\nPreencha esse campo com o código do pedido no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de pedidos você conseguirá ver a relação entre o id do pedido gerado no Omie e o código de pedido existente em sua aplicação."},"numero_pedido":{"type":"string","maxLength":15,"description":"Número do pedido de venda.\n\nEsse é o número do pedido de venda no Omie, que é gerado automaticamente e exibido na tela."},"sequencial":{"type":"string","maxLength":4,"description":"Número sequencial do pedido de venda parcial.\n\nEsse é o número do pedido de venda parcial no Omie, que é gerado automaticamente e exibido na tela."},"codigo_cliente":{"type":"integer","maxLength":15,"description":"Código do cliente.\n\nUtilize a tag \"codigo_cliente_omie\" do método \"ListarClientes\" da API\nhttp://app.omie.com.br/api/v1/geral/clientes/\npara obter essa informação."},"codigo_cliente_integracao":{"type":"string","maxLength":60,"description":"Código de Integração do Cliente\n\nEsse campo deve ser informado apenas se você incluiu o cliente via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag \"codigo_cliente\"."},"data_previsao":{"type":"string","maxLength":10,"description":"Data de Previsão de Faturamento.\n\nUtilize o formato \"dd/mm/aaaa\".\n\nEsse campo indica a data da previsão do faturamento do pedido e deve ser informado com uma data igual ou superior a data corrente."},"quantidade_itens":{"type":"integer","maxLength":6,"description":"Quantidade de Itens."},"etapa":{"type":"string","maxLength":2,"description":"Etapa do pedido de venda.\n\nEsse campo indica em que coluna o pedido de venda irá figurar no processo de faturamento do Omie.\n\nUtilize a tag \"codigo\" do método \"ListarEtapasFaturamento\" da API\nhttp://app.omie.com.br/api/v1/produtos/etapafat/\npara obter essa informação.\n\nOs valores são fixos, mas as descrições (funções atribuídas a cada coluna pode mudar. A API irá indicar a descrição de cada coluna.\n\nOs valores disponíveis para esse campo podem ser:\n\n\"10\" - Primeira coluna\n\"20\" - Segunda coluna\n\"30\" - Terceira coluna\n\"40\" - Quarta coluna\n\"50\" - Faturar."},"codigo_parcela":{"type":"string","maxLength":3,"description":"Código da parcela/Condição de pagamento.\n\nUtilize a tag \"nCodigo\" do método \"ListarFormasPagVendas\" da API\nhttp://app.omie.com.br/api/v1/produtos/formaspagvendas/\npara obter essa informação.\n\nO código \"999\" é o único que permite uma definição de forma de pagamento customizada. Caso você escolha essa opção, deve também informar a tag \"qtde_parcelas\" e a estrutura \"lista_parcelas\".\n\nConsultar a API de parcelas para obter código: 'api/v1/geral/parcelas/#ListarParcelas'."},"qtde_parcelas":{"type":"integer","maxLength":3,"description":"Quantidade de parcelas.\n\nValores permitidos de 1 a 999."},"origem_pedido":{"type":"string","maxLength":3,"description":"Origem do Pedido.\n\nDefault:\nAPI - Importado via API.\nMLV - Mercado Livre\n\nEsse campo será ignorado no método AlterarPedidoVenda."},"codigo_cenario_impostos":{"type":"integer","maxLength":15,"description":"Código do Cenário de Impostos.\n\nSe não informado, será assumido o cenário padrão."},"bloqueado":{"type":"string","maxLength":1,"description":"Pedido Bloqueado pela API."},"importado_api":{"type":"string","maxLength":1,"description":"Pedido de venda de produto importada pela API."},"codigo_empresa":{"deprecated":true,"type":"integer","maxLength":15,"description":"DEPRECATED"},"codigo_empresa_integracao":{"deprecated":true,"type":"string","maxLength":20,"description":"DEPRECATED"},"tipo_desconto_pedido":{"type":"string","maxLength":1,"description":"Tipo de desconto para o pedido.\n\nPode ser:\nV - Valor\nP - Percentual\n\n\nAo informar o desconto na capa do pedido o mesmo será distribuído proporcionalmente para os itens. Uma vez realizada a distribuição os valores do desconto serão exibidos apenas nos itens.\n\nIMPORTANTE:\n- Não será permitido informar desconto na capa caso já exista distribuição pelos itens.\n- Na alteração o desconto será aplicado para todos os itens do pedido."},"perc_desconto_pedido":{"type":"number","maxLength":10,"description":"Percentual do desconto do pedido.\n\n\nAo informar o desconto na capa do pedido o mesmo será distribuído proporcionalmente para os itens. Uma vez realizada a distribuição os valores do desconto serão exibidos apenas nos itens.\n\nIMPORTANTE:\n- Não será permitido informar desconto na capa caso já exista distribuição pelos itens.\n- Na alteração o desconto será aplicado para todos os itens do pedido."},"valor_desconto_pedido":{"type":"number","maxLength":18,"description":"Valor do desconto do pedido.\n\n\nAo informar o desconto na capa do pedido o mesmo será distribuído proporcionalmente para os itens. Uma vez realizada a distribuição os valores do desconto serão exibidos apenas nos itens.\n\nIMPORTANTE:\n- Não será permitido informar desconto na capa caso já exista distribuição pelos itens.\n- Na alteração o desconto será aplicado para todos os itens do pedido.\n- Se o desconto for superior ao valor do pedido ele não será aplicado."},"encerrado":{"type":"string","maxLength":1,"example":"S","description":"Indica que o pedido foi encerrado (S/N).\nTag utilizada apenas nos métodos de listagem e consulta."},"enc_motivo":{"type":"string","maxLength":100,"description":"Descrição do motivo do encerramento.\nTag utilizada apenas nos métodos de listagem e consulta."},"enc_data":{"type":"string","maxLength":10,"description":"Data de encerramento,\nTag utilizada apenas nos métodos de listagem e consulta."},"enc_hora":{"type":"string","maxLength":8,"description":"Hora de encerramento,\nTag utilizada apenas nos métodos de listagem e consulta."},"enc_user":{"type":"string","maxLength":10,"description":"Usuário do encerramento,\nTag utilizada apenas nos métodos de listagem e consulta."},"nao_gerar_boleto":{"type":"string","maxLength":1,"description":"Indica se o boleto não deve ser gerado para a(s) parcela(s) ao emitir a nota fiscal.\n\nInforme \"S\" para não gerar o boleto. O padrão é \"N\".\n\nQuando informado dentro do tag \"cabecalho\", aplica-se como valor padrão para todas as parcelas, caso não seja especificado individualmente em cada uma.\n\nQuando informado dentro da tag \"lista_parcelas\", aplica-se individualmente para cada parcela (tem prioridade sobre o valor informado no cabeçalho).\n\n\nInformação localizada na Aba \"Parcelas\" do Pedido de Venda."}},"description":"Informações do cabeçalho do pedido."},"departamentos":{"type":"array","items":{"type":"object","properties":{"cCodDepto":{"type":"string","maxLength":40,"description":"ID do Departamento.\n\nInformação localizada na Aba \"Departamentos\" do Pedido de Venda.\n\nUtilize a tag \"codigo\" do método \"ListarDepatartamentos\" da API\nhttp://app.omie.com.br/api/v1/geral/departamentos/\npara obter essa informação."},"nPerc":{"type":"number","maxLength":10,"description":"Percentual de Rateio.\n\nInformação localizada na Aba \"Departamentos\" do Pedido de Venda."},"nValor":{"type":"number","maxLength":18,"description":"Valor do Rateio.\n\nInformação localizada na Aba \"Departamentos\" do Pedido de Venda."},"nValorFixo":{"type":"string","maxLength":1,"description":"Indica que o valor foi fixado na distribuição do rateio.\n\nInformar \"S\" ou \"N\".\n\nInformação localizada na Aba \"Departamentos\" do Pedido de Venda."}}},"description":"Dados da Aba \"Departamentos\" do Pedido de Venda."},"frete":{"type":"object","properties":{"codigo_transportadora":{"type":"integer","maxLength":15,"description":"ID da transportadora.\n\nEsse campo não é exibido na tela do Pedido de Vendas.\nÉ uma informação interna, utilizada apenas nas APIs.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda.\n\nUtilize a tag \"codigo_cliente_omie\" do método \"ListarClientes\" da API\nhttp://app.omie.com.br/api/v1/geral/clientes/\npara obter essa informação.\n\nOBS: O Omie uitliza o cadastro de clientes para registrar também fornecedores e transportadoras."},"codigo_transportadora_integracao":{"type":"string","maxLength":60,"description":"Código Integração da Transportadora.\n\nEsse campo deve ser informado apenas se você incluiu o cliente (transportadora) via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag \"codigo_cliente\"."},"modalidade":{"type":"string","maxLength":1,"description":"Tipo de  Frete.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda.\n\nValores disponíveis:\n\n\"0\" - Contratação do Frete por conta do Remetente (CIF)\n\"1\" - Contratação do Frete por conta do Destinatário (FOB)\n\"2\" - Contratação do Frete por conta de Terceiros\n\"3\" - Transporte Próprio por conta do Remetente\n\"4\" - Transporte Próprio por conta do Destinatário\n\"9\" - Sem frete."},"placa":{"type":"string","maxLength":7,"description":"Placa do Veículo.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"placa_estado":{"type":"string","maxLength":2,"description":"Estado da Placa do Veículo.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"registro_transportador":{"type":"string","maxLength":20,"description":"RNTRC (ANTT) - Registro Nacional de Transportador de Cargas.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"quantidade_volumes":{"type":"integer","maxLength":15,"description":"Quantidade de Volumes.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"especie_volumes":{"type":"string","maxLength":60,"description":"Espécie dos Volumes.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"marca_volumes":{"type":"string","maxLength":60,"description":"Marca dos Volumes.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"numeracao_volumes":{"type":"string","maxLength":60,"description":"Numeração dos Volumes.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"peso_liquido":{"type":"number","maxLength":18,"description":"Peso Líquido (Kg).\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"peso_bruto":{"type":"number","maxLength":18,"description":"Peso Bruto (Kg).\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"valor_frete":{"type":"number","maxLength":18,"description":"Valor do Frete.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"valor_seguro":{"type":"number","maxLength":18,"description":"Valor do Seguro.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"numero_lacre":{"type":"string","maxLength":60,"description":"Número do Lacre.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"outras_despesas":{"type":"number","maxLength":18,"description":"Outras Despesas Acessórias.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"veiculo_proprio":{"type":"string","maxLength":1,"description":"O transporte será realizado com veículo próprio.\n\nInformar \"S\" ou \"N\".\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"previsao_entrega":{"type":"string","maxLength":10,"description":"Previsão de entrega do Pedido de Venda\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"codigo_rastreio":{"type":"string","maxLength":500,"description":"Código de Rastreio da Entrega do Pedido de Venda.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"icms_retido":{"type":"object","properties":{"vServicoTr":{"type":"number","maxLength":18,"description":"Valor de Serviço de Transporte.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"vBCRetencaoTr":{"type":"number","maxLength":18,"description":"Base de Cálculo da Retenção.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"vAliquotaRetencaoTr":{"type":"number","maxLength":10,"description":"Percentual de Alíquota de Retenção.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"vIcmsRetidoTr":{"type":"number","maxLength":18,"description":"Valor de ICMS Retido.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"cCfopTr":{"type":"string","maxLength":10,"description":"CFOP.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda.\n\nUtilize a tag \"nCodigo\" do método \"ListarCFOP\" da API\nhttp://app.omie.com.br/api/v1/produtos/cfop/\npara obter essa informação."},"cCidadeTr":{"type":"string","maxLength":40,"description":"Cidade de Ocorrência do Fato Gerador do ICMS.\n\nUtilize o formato: CIDADE (UF), como no exemplos:\n\n\"SAO PAULO (SP)\"\n\"RIO DE JANEIRO (RJ)\"\n\"FLORIANOPOLIS (SC)\"\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda.\n\nUtilize a tag \"cCod\" do método \"PesquisarCidades\" da API\nhttp://app.omie.com.br/api/v1/geral/cidades/\npara obter essa informação."}},"description":"Dados do ICMS Retido do Serviço de Transporte.\n\nInformação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"codigo_tipo_entrega":{"type":"integer","maxLength":15,"description":"Código do tipo de entrega."},"link_rastreio":{"type":"string","maxLength":300,"description":"Link de Rastreio da Entrega do Pedido de Venda.\n\nInformação interna pode ser visualizada e consultada via API '/api/v1/produtos/pedido/'."}},"description":"Dados da Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"informacoes_adicionais":{"type":"object","properties":{"codigo_categoria":{"type":"string","maxLength":20,"description":"Código da categoria.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda.\n\nUtilize a tag \"codigo\" do método \"ListarCategorias\" da API\nhttp://app.omie.com.br/api/v1/geral/categorias/\npara obter essa informação."},"codigo_conta_corrente":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda.\n\nUtilize a tag \"codigo\" do método \"PesquisarContaCorrente\" da API\nhttp://app.omie.com.br/api/v1/geral/contacorrente/\npara obter essa informação."},"numero_pedido_cliente":{"type":"string","maxLength":30,"description":"Número do pedido do cliente.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"numero_contrato":{"type":"string","maxLength":20,"description":"Número do Contrato de Venda.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"contato":{"type":"string","maxLength":100,"description":"Contato.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"dados_adicionais_nf":{"type":"string","description":"Dados adicionais para a Nota Fiscal.\n\nUtilize o caracter pipe ( | ) como separador de linha.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"consumidor_final":{"type":"string","maxLength":1,"description":"Nota Fiscal para Consumo Final.\n\nInformar \"S\" ou \"N\".\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"utilizar_emails":{"type":"string","description":"Utilizar os seguintes endereços de e-mail.\n\nInformar a lista de e-mail que receberão a Nota Fiscal.\nUtilize a virgula (,) como separador.\n\nInformação localizada na Aba \"E-mail para o Cliente\" do Pedido de Venda."},"enviar_email":{"type":"string","maxLength":1,"description":"Enviar e-mail com o boleto de cobrança gerado pelo faturamento (juntamente com o DANFE e o XML da NF-e).\n\nInformar \"S\" ou \"N\".\nDefault \"N\"\n\nInformação localizada na Aba \"E-mail para o Cliente\" do Pedido de Venda.\n\nÉ permitido somente o preenchimento de uma das tags \"enviar_pix\" ou \"enviar_email\"."},"enviar_pix":{"type":"string","maxLength":1,"description":"Enviar e-mail com o PIX de cobrança gerado pelo faturamento (juntamente com o DANFE e o XML da NF-e).\n\nInformar \"S\" ou \"N\".\nDefault \"N\"\n\nInformação localizada na Aba \"E-mail para o Cliente\" do Pedido de Venda.\n\nÉ permitido somente o preenchimento de uma das tags \"enviar_pix\" ou \"enviar_email\"."},"codVend":{"type":"integer","maxLength":15,"description":"Código do Vendedor.\n\nInformação localizada no cabeçalho do Pedido de Venda.\n\nUtilize a tag \"codigo\" do método \"ListarVendedores\" da API\nhttp://app.omie.com.br/api/v1/geral/vendedores/\npara obter essa informação."},"codProj":{"type":"integer","maxLength":15,"description":"Código do Projeto.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda.\n\nUtilize a tag \"codigo\" do método \"ListarProjetos\" da API\nhttp://app.omie.com.br/api/v1/geral/projetos/\npara obter essa informação."},"outros_detalhes":{"type":"object","properties":{"cNatOperacaoOd":{"type":"string","maxLength":60,"description":"Natureza da Operação.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cIndicadorOd":{"type":"string","maxLength":1,"description":"Indicador de Presença da Operação.\n\n1 - Operação presencial.\n2 - Operação não presencial, pela Internet.\n3 - Operação não presencial, Teleatendimento.\n4 - NFC-e em operação com entrega a domicílio.\n9 -Operação não presencial, outros.\n\n\nSe não informado, utilizaremos automaticamente o \"9 - Outros\".\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cIndicadorIntOd":{"type":"string","maxLength":1,"description":"Indicador de Intermediador.\n\n\nEsta informação deverá ser enviada quando se tratar de uma operação não presencial.\n\nOpções disponíveis:\n0=Operação sem intermediador(em site ou plataforma própria)\n1=Operação em site ou plataforma de terceiros(intermediadores/marketplace)\n\nSe não informado, utilizaremos automaticamente a opção \"0-Operação sem intermediador(em site ou plataforma própria)\".\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cCnpjIntOd":{"type":"string","maxLength":20,"description":"CNPJ do Intermediador.\n\nPreencimento obrigatório caso o Indicador de Intermediador seja igual a opção \"1-Operação em site ou plataforma de terceiros(intermediadores/marketplace)\".\n\nEste campo representa o CNPJ do Intermediador da Transação.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cIdentificadorIntOd":{"type":"string","maxLength":60,"description":"Identificação no Intermediador.\n\n\nEste identificador pode ser o nome do usuário ou identificação do perfil do vendedor no site do intermediador.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"dDataSaidaOd":{"type":"string","maxLength":10,"description":"Data de Saída.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cHoraSaidaOd":{"type":"string","maxLength":8,"description":"Hora de Saída.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cCnpjCpfOd":{"type":"string","maxLength":20,"description":"CNPJ / CPF (do recebedor).\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cNomeOd":{"type":"string","maxLength":60,"description":"Nome / Razão Social.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cInscrEstadualOd":{"type":"string","maxLength":20,"description":"Inscrição Estadual.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cEnderecoOd":{"type":"string","maxLength":60,"description":"Endereço.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cNumeroOd":{"type":"string","maxLength":10,"description":"Número do endereço.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cComplementoOd":{"type":"string","maxLength":60,"description":"Complemento do endereço.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cBairroOd":{"type":"string","maxLength":60,"description":"Bairro.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cEstadoOd":{"type":"string","maxLength":2,"description":"Estado.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cCidadeOd":{"type":"string","maxLength":40,"description":"Cidade.\n\nUtilize o padrão: CIDADE (UF), como no exemplo:\n\n\"SAO PAULO (SP)\"\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda.\n\nUtilize a tag \"cCod\" do método \"PesquisarCidades\" da API\nhttp://app.omie.com.br/api/v1/geral/cidades/\npara obter essa informação."},"cCEPOd":{"type":"string","maxLength":10,"description":"CEP.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cSepararEnderecoOd":{"type":"string","maxLength":1,"description":"Separar endereço.\nValores possível S ou N, sendo N o padrão.\nQuando igual S separa do endereço o número o e complemento, caso existirem."},"cTelefoneOd":{"type":"string","maxLength":15,"description":"Telefone.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cCnpjCpfOdRet":{"type":"string","maxLength":20,"description":"CPF/CNPJ (Local de Retirada).\n\nPreencimento opcional quando a mercadoria não está com o Emitente e deve ser retirada em outro local.\n\nEste campo representa o CPF/CNPJ do responsável pela retirada da mercadoria.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cNomeOdRet":{"type":"string","maxLength":60,"description":"Nome / Razão Social (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cInscrEstadualOdRet":{"type":"string","maxLength":20,"description":"Inscrição Estadual (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cEnderecoOdRet":{"type":"string","maxLength":60,"description":"Endereço (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cNumeroOdRet":{"type":"string","maxLength":10,"description":"Número do endereço (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cComplementoOdRet":{"type":"string","maxLength":60,"description":"Complemento do endereço (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cBairroOdRet":{"type":"string","maxLength":60,"description":"Bairro (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cEstadoOdRet":{"type":"string","maxLength":2,"description":"Estado (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cCidadeOdRet":{"type":"string","maxLength":40,"description":"Cidade (Local de Retirada).\n\nUtilize o padrão: CIDADE (UF), como no exemplo:\n\n\"SAO PAULO (SP)\"\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda.\n\nUtilize a tag \"cCod\" do método \"PesquisarCidades\" da API\nhttp://app.omie.com.br/api/v1/geral/cidades/\npara obter essa informação."},"cCEPOdRet":{"type":"string","maxLength":10,"description":"CEP (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cSepararEnderecoOdRet":{"type":"string","maxLength":1,"description":"Separar endereço.\nValores possível S ou N, sendo N o padrão.\nQuando igual S separa do endereço o número o e complemento, caso existirem."},"cTelefoneOdRet":{"type":"string","maxLength":15,"description":"Telefone (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."}},"description":"Outros detalhes da NF-e."},"impostos_embutidos":{"deprecated":true,"type":"string","maxLength":1,"description":"DEPRECATED"},"meio_pagamento":{"type":"string","maxLength":100,"description":"Meio de Pagamento - Utilizado apenas para emissão de NF-e (campo \"tPag\" do XML).\nEsse campo indica como a parcela da nota será paga.\n\n\nInformação localizada na Aba \"Parcelas\" do Pedido de Venda.\n\nCaso informado na estrutura \"informacoes_adicionais\" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura \"parcela\".\nPode ser:\n01  Dinheiro\n02  Cheque\n03  Cartão de Crédito\n04  Cartão de Débito\n05  Crédito Loja\n10  Vale Alimentação\n11  Vale Refeição\n12  Vale Presente\n13  Vale Combustível\n15  Boleto Bancário\n16  Depósito Bancário\n17  Pagamento Instantâneo (PIX)\n18  Transferência bancária, Carteira Digital\n19  Programa de fidelidade, Cashback, Crédito Virtual.\n90  Sem Pagamento\n99  Outros\n\nListagem completa disponível na API:\n/api/v1/geral/meiospagamento/"},"descr_meio_pagamento":{"type":"string","description":"Descrição do Meio de Pagamento - Utilizado apenas para emissão de NF-e (campo \"xPag\" do XML).\n\nEsse campo precisa ser informado quando a tag \"meio_pagamento\" for igual a 99 (Outros).\n\nInformação localizada na Aba \"Parcelas\" do Pedido de Venda.\n\nCaso informado na estrutura \"informacoes_adicionais\" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura \"parcela\"."},"tipo_documento":{"type":"string","maxLength":5,"description":"Tipo de Documento.\n\n\nInformação localizada na Aba \"Parcelas\" do Pedido de Venda.\n\nPode ser:\n13S   13o. Salário\n99999 Outros\nACO   Acordo\nACOB  Acordo - Boleto\nACOT  Acordo - Transferência\nADI   Adiantamento\nANT   Antecipação\nAPL   Aplicação\nAPO   Apólice\nAPOR  Aporte\nASS   Assinatura\nBIL   Bilhete\nBOL   Boleto\nBOLV  Boleto à Vista\nBONUS Bonus\nCAP   Capitalização\nCART  Carteira\nCF    Cupom Fiscal\nCHD   Cheque Devolvido\nCHP   Cheque Pré\nCHQ   Cheque\nCHT   Cheque de Terceiros\nCNT   Crédito em Conta\nCOB   Cobrança\nCOM   Comissão\nCON   Convênios\nCONC  Cobrança de Concessionária\nCOND  Condicional\nCONS  Consignado\nCONSO Consórcio\nCRC   Cartão de Crédito\nCRD   Cartão de Débito\nCRE   Crediário\nCRP   Cartão Pré-Pago\nCRT   Cartão\nCRTO  Cartório\nCTE   CT-e\nCTR   Contrato\nCUSJ  Custos Judiciais\nDACTE DACTE\nDAE   DAE\nDAJE  DAJE\nDAM   DAM\nDANFE DANFE\nDAR   DAR\nDARE  DARE\nDARJ  DARJ\nDARM  DARM\nDAS   DAS\nDDA   DDA\nDEB   Débito em Conta\nDEBA  Débito Automático\nDEP   Depósito\nDEV   Devolução\nDFE   Documento Fiscal Equivalente\nDIN   Dinheiro\nDLC   Distribuição de Lucros\nDNF   Documento não fiscal\nDNFSE DANFSE\nDOA   Doação\nDOC   DOC\nDPVAT DPVAT\nDRF   DARF\nDUA   DUA\nDUAM  DUAM\nDUP   Duplicata\nEMP   Empréstimo\nENC   Encargos\nETAR  Estorno de Tarifa\nFAT   Fatura\nFER   Férias\nFIA   Fiado\nFIN   Financiamento\nFPGT  Folha de Pagamento\nGAR   Garantia\nGARE  GARE\nGNRE  GNRE\nGPS   GPS\nGRCS  GRCS\nGRCSU GRCSU\nGRF   Guia de Recolhimento do FGTS\nGRU   GRU\nGUIA  Guia de Recolhimento\nHOL   Holerite\nIMP   Imposto\nINV   Invoice\nIPTU  IPTU\nIPVA  IPVA\nJUROS Juros Limite\nMED   Medição\nMULTA Multas\nMUTUO Mútuo\nNC    Nota de Crédito\nND    Nota de Débito\nNF    Nota Fiscal\nNF3E  Nota Fiscal de Energia Elétrica Eletrônica\nNFA   Nota Fiscal de Abastecimento\nNFC   Nota Fiscal de Consumidor\nNFCE  Nota Fiscal de Consumidor Eletrônica\nNFD   Nota Fiscal de Devolução\nNFE   Nota Fiscal Eletrônica\nNFEE  Nota Fiscal Energia Elétrica\nNFS   Nota Fiscal de Serviço\nNFST  Nota Fiscal de Telecomunicações\nNFSTM Nota Fiscal de Serviço Tomado\nPDD   PDD\nPED   Pedido\nPEN   Pensão Alimentícia\nPER   Permuta\nPIX   Pix\nPROF  Proforma Invoice\nPROL  Pro-Labore\nPROT  Protesto\nPROV  Provisão\nREC   Recibo\nREE   Reembolso\nREND  Rendimentos\nRES   Resgate\nRET   Rescisão Trabalhista\nRPA   RPA\nSAN   Sangria\nSAQ   Saque\nSUP   Suprimento\nTAR   Tarifa\nTED   TED\nTFE   Taxa de Fiscalização de Estabelecimentos\nTIC   Ticket\nTID   Título Descontado\nTRA   Transferência\nTRAV  Transferência à Vista\nTRLAV Licenciamento\nTX    Taxa\nVIST  A Vista\nVOU   Voucher\nWSITE Website\n\nListagem completa dispon\"ivel na API:\n/api/v1/ger"},"nfRelacionada":{"type":"object","properties":{"cChaveRef":{"type":"string","maxLength":44,"description":"Chave da NF-e (ou NFC-e ou SAT) Relacionada."},"nNFRef":{"type":"string","maxLength":9,"description":"Número da Nota Fiscal\n\nNota Fiscal Relacionada Modelo 1/1A"},"cSerieRef":{"type":"string","maxLength":3,"description":"Série da NF Referenciada.\n\nNota Fiscal Relacionada Modelo 1/1A"},"dtEmissaoRef":{"type":"string","maxLength":10,"description":"Data de emissão da NF Referenciada.\n\nNota Fiscal Relacionada Modelo 1/1A"},"cnpjEmitRef":{"type":"string","maxLength":20,"description":"CNPJ da Emitente da NF Referenciada.\n\nNota Fiscal Relacionada Modelo 1/1A"},"cUfRef":{"type":"string","maxLength":2,"description":"Estado do Emitente da NF Referenciada.\n\nNota Fiscal Relacionada Modelo 1/1A"},"nNfPR":{"type":"string","maxLength":9,"description":"Número da Nota Fiscal relacionada do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural"},"cSeriePR":{"type":"string","maxLength":3,"description":"Série da NF do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural"},"dtEmissaoPR":{"type":"string","maxLength":10,"description":"Data de emissão da NF do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural"},"cnpjPR":{"type":"string","maxLength":20,"description":"CNPJ/CPF do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural"},"InscrEstPR":{"type":"string","maxLength":20,"description":"Inscrição Estadual do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural"},"cUfPR":{"type":"string","maxLength":2,"description":"Estado do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural"},"nCOORef":{"type":"string","maxLength":6,"description":"Número do COO - Contador de Ordem de Operação.\n\nCupom Fiscal Relacionado"},"nECFRef":{"type":"string","maxLength":3,"description":"Número de Ordem Sequencial do ECF."},"indPresenca":{"type":"string","maxLength":1,"description":"Indicador de Presença da Operação.\n\n1 - Operação presencial.\n2 - Operação não presencial, pela Internet.\n3 - Operação não presencial, Teleatendimento.\n4 - NFC-e em operação com entrega a domicílio.\n5 - Operação presencial, fora do estabelecimento.\n9 - Operação não presencial, outros.\n\n\nSe não informado, utilizaremos automaticamente o \"9 - Outros\".\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"indIntermediario":{"type":"string","maxLength":1,"description":"Indicador de Intermediador.\n\n\nEsta informação deverá ser enviada quando se tratar de uma operação não presencial.\n\nOpções disponíveis:\n0=Operação sem intermediador(em site ou plataforma própria)\n1=Operação em site ou plataforma de terceiros(intermediadores/marketplace)\n\nSe não informado, utilizaremos automaticamente a opção \"0-Operação sem intermediador(em site ou plataforma própria)\".\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cnpjIntermediario":{"type":"string","maxLength":20,"description":"CNPJ do Intermediador.\n\nPreencimento obrigatório caso o Indicador de Intermediador seja igual a opção \"1-Operação em site ou plataforma de terceiros(intermediadores/marketplace)\".\n\nEste campo representa o CNPJ do Intermediador da Transação.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"identIntermediario":{"type":"string","maxLength":60,"description":"Identificação no Intermediador.\n\n\nEste identificador pode ser o nome do usuário ou identificação do perfil do vendedor no site do intermediador.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"nrProdutorRural":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","maxLength":1,"description":"Ação a ser realizada no item na alteração.\n\nPode ser:\n\n\"I\" - Incluir o item.\n\"E\" - Excluir o item."},"nrNumero":{"type":"string","maxLength":9,"description":"Número da NF relacionada"},"nrSerie":{"type":"string","maxLength":3,"description":"Série da NF relacionada"},"nrDtEmissao":{"type":"string","maxLength":10,"description":"Data de emissão da NF relacionada"},"nrCnpjCpf":{"type":"string","maxLength":20,"description":"CNPJ/CPF do emitente da NF relacionada"},"nrIE":{"type":"string","maxLength":20,"description":"Inscrição Estadual do emitente da NF relacionada"},"nrUF":{"type":"string","maxLength":2,"description":"Unidade federativa do emitente da NF relacionada"}}},"description":"Outras notas de produtor rural relacionadas"},"nrNF":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","maxLength":1,"description":"Ação a ser realizada no item na alteração.\n\nPode ser:\n\n\"I\" - Incluir o item.\n\"E\" - Excluir o item."},"nrChave":{"type":"string","maxLength":44,"description":"Chave da NF-e, NFC-e ou SAT relacionada"}}},"description":"Outras NF-e, NFC-e ou SAT relacionadas"},"nrCupomFiscal":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","maxLength":1,"description":"Ação a ser realizada no item na alteração.\n\nPode ser:\n\n\"I\" - Incluir o item.\n\"E\" - Excluir o item."},"nrCOO":{"type":"string","maxLength":6,"description":"Contador de Ordem de Operação (COO)"},"nrNumeroECF":{"type":"string","maxLength":3,"description":"Número do ECF"}}},"description":"Outros cupons fiscais relacionados"},"nrModelo1_1A":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","maxLength":1,"description":"Ação a ser realizada no item na alteração.\n\nPode ser:\n\n\"I\" - Incluir o item.\n\"E\" - Excluir o item."},"nrNumero":{"type":"string","maxLength":9,"description":"Número da NF relacionada"},"nrSerie":{"type":"string","maxLength":3,"description":"Série da NF relacionada"},"nrDtEmissao":{"type":"string","maxLength":10,"description":"Data de emissão da NF relacionada"},"nrCnpjCpf":{"type":"string","maxLength":20,"description":"CNPJ/CPF do emitente da NF relacionada"},"nrUF":{"type":"string","maxLength":2,"description":"Unidade federativa do emitente da NF relacionada"}}},"description":"Outras notas modelo 1/1A relacionadas"},"cSigNFRef":{"type":"string","maxLength":1,"description":"Manter o sigilo da NF-e referenciada.\n\nPreencher com \"S\" ou \"N\".\n\nDefault \"N\""}},"description":"Detalhes da NF referenciada."},"nsu":{"type":"string","maxLength":100,"description":"Número Sequencial Único NSU - Para identificar vendas por cartões ou TransactionID TID - Para identificar vendas de comercio eletrônico.\n\nCaso informado na estrutura \"informacoes_adicionais\" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura \"parcela\"."}},"description":"Dados da Aba \"Informações Adicionais\" do Pedido de Venda."},"lista_parcelas":{"type":"object","properties":{"parcela":{"type":"array","items":{"type":"object","properties":{"numero_parcela":{"type":"integer","maxLength":3,"description":"Número da Parcela.\n\nInformação localizada na Aba \"Parcelas\" do Pedido de Venda."},"valor":{"type":"number","maxLength":18,"description":"Valor da Parcela.\n\nInformação localizada na Aba \"Parcelas\" do Pedido de Venda."},"percentual":{"type":"number","maxLength":9,"description":"Percentual da Parcela.\n\nInformação localizada na Aba \"Parcelas\" do Pedido de Venda."},"data_vencimento":{"type":"string","maxLength":10,"description":"Data de Vencimento da Parcela.\n\nInformação localizada na Aba \"Parcelas\" do Pedido de Venda."},"quantidade_dias":{"type":"integer","maxLength":4,"description":"Quantidade de dias até o vencimento da parcela.\n\nInformação localizada na Aba \"Parcelas\" do Pedido de Venda."},"tipo_documento":{"type":"string","maxLength":5,"description":"Tipo de Documento.\n\n\nInformação localizada na Aba \"Parcelas\" do Pedido de Venda.\n\nPode ser:\n13S   13o. Salário\n99999 Outros\nACO   Acordo\nACOB  Acordo - Boleto\nACOT  Acordo - Transferência\nADI   Adiantamento\nANT   Antecipação\nAPL   Aplicação\nAPO   Apólice\nAPOR  Aporte\nASS   Assinatura\nBIL   Bilhete\nBOL   Boleto\nBOLV  Boleto à Vista\nBONUS Bonus\nCAP   Capitalização\nCART  Carteira\nCF    Cupom Fiscal\nCHD   Cheque Devolvido\nCHP   Cheque Pré\nCHQ   Cheque\nCHT   Cheque de Terceiros\nCNT   Crédito em Conta\nCOB   Cobrança\nCOM   Comissão\nCON   Convênios\nCONC  Cobrança de Concessionária\nCOND  Condicional\nCONS  Consignado\nCONSO Consórcio\nCRC   Cartão de Crédito\nCRD   Cartão de Débito\nCRE   Crediário\nCRP   Cartão Pré-Pago\nCRT   Cartão\nCRTO  Cartório\nCTE   CT-e\nCTR   Contrato\nCUSJ  Custos Judiciais\nDACTE DACTE\nDAE   DAE\nDAJE  DAJE\nDAM   DAM\nDANFE DANFE\nDAR   DAR\nDARE  DARE\nDARJ  DARJ\nDARM  DARM\nDAS   DAS\nDDA   DDA\nDEB   Débito em Conta\nDEBA  Débito Automático\nDEP   Depósito\nDEV   Devolução\nDFE   Documento Fiscal Equivalente\nDIN   Dinheiro\nDLC   Distribuição de Lucros\nDNF   Documento não fiscal\nDNFSE DANFSE\nDOA   Doação\nDOC   DOC\nDPVAT DPVAT\nDRF   DARF\nDUA   DUA\nDUAM  DUAM\nDUP   Duplicata\nEMP   Empréstimo\nENC   Encargos\nETAR  Estorno de Tarifa\nFAT   Fatura\nFER   Férias\nFIA   Fiado\nFIN   Financiamento\nFPGT  Folha de Pagamento\nGAR   Garantia\nGARE  GARE\nGNRE  GNRE\nGPS   GPS\nGRCS  GRCS\nGRCSU GRCSU\nGRF   Guia de Recolhimento do FGTS\nGRU   GRU\nGUIA  Guia de Recolhimento\nHOL   Holerite\nIMP   Imposto\nINV   Invoice\nIPTU  IPTU\nIPVA  IPVA\nJUROS Juros Limite\nMED   Medição\nMULTA Multas\nMUTUO Mútuo\nNC    Nota de Crédito\nND    Nota de Débito\nNF    Nota Fiscal\nNF3E  Nota Fiscal de Energia Elétrica Eletrônica\nNFA   Nota Fiscal de Abastecimento\nNFC   Nota Fiscal de Consumidor\nNFCE  Nota Fiscal de Consumidor Eletrônica\nNFD   Nota Fiscal de Devolução\nNFE   Nota Fiscal Eletrônica\nNFEE  Nota Fiscal Energia Elétrica\nNFS   Nota Fiscal de Serviço\nNFST  Nota Fiscal de Telecomunicações\nNFSTM Nota Fiscal de Serviço Tomado\nPDD   PDD\nPED   Pedido\nPEN   Pensão Alimentícia\nPER   Permuta\nPIX   Pix\nPROF  Proforma Invoice\nPROL  Pro-Labore\nPROT  Protesto\nPROV  Provisão\nREC   Recibo\nREE   Reembolso\nREND  Rendimentos\nRES   Resgate\nRET   Rescisão Trabalhista\nRPA   RPA\nSAN   Sangria\nSAQ   Saque\nSUP   Suprimento\nTAR   Tarifa\nTED   TED\nTFE   Taxa de Fiscalização de Estabelecimentos\nTIC   Ticket\nTID   Título Descontado\nTRA   Transferência\nTRAV  Transferência à Vista\nTRLAV Licenciamento\nTX    Taxa\nVIST  A Vista\nVOU   Voucher\nWSITE Website\n\nListagem completa dispon\"ivel na API:\n/api/v1/ger"},"meio_pagamento":{"type":"string","maxLength":100,"description":"Meio de Pagamento - Utilizado apenas para emissão de NF-e (campo \"tPag\" do XML).\nEsse campo indica como a parcela da nota será paga.\n\n\nInformação localizada na Aba \"Parcelas\" do Pedido de Venda.\n\nCaso informado na estrutura \"informacoes_adicionais\" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura \"parcela\".\n\nPode ser:\n01  Dinheiro\n02  Cheque\n03  Cartão de Crédito\n04  Cartão de Débito\n05  Crédito Loja\n10  Vale Alimentação\n11  Vale Refeição\n12  Vale Presente\n13  Vale Combustível\n15  Boleto Bancário\n16  Depósito Bancário\n17  Pagamento Instantâneo (PIX)\n18  Transferência bancária, Carteira Digital\n19  Programa de fidelidade, Cashback, Crédito Virtual.\n90  Sem Pagamento\n99  Outros\n\nListagem completa disponível na API:\n/api/v1/geral/meiospagamento/"},"descr_meio_pagamento":{"type":"string","description":"Descrição do Meio de Pagamento - Utilizado apenas para emissão de NF-e (campo \"xPag\" do XML).\n\nEsse campo precisa ser informado quando a tag \"meio_pagamento\" for igual a 99 (Outros).\n\nInformação localizada na Aba \"Parcelas\" do Pedido de Venda.\n\nCaso informado na estrutura \"informacoes_adicionais\" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura \"parcela\"."},"nsu":{"type":"string","maxLength":100,"description":"Número Sequencial Único NSU - Para identificar vendas por cartões ou TransactionID TID - Para identificar vendas de comercio eletrônico.\n\nCaso informado na estrutura \"informacoes_adicionais\" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura \"parcela\"."},"nao_gerar_boleto":{"type":"string","maxLength":1,"description":"Indica se o boleto não deve ser gerado para a(s) parcela(s) ao emitir a nota fiscal.\n\nInforme \"S\" para não gerar o boleto. O padrão é \"N\".\n\nQuando informado dentro do tag \"cabecalho\", aplica-se como valor padrão para todas as parcelas, caso não seja especificado individualmente em cada uma.\n\nQuando informado dentro da tag \"lista_parcelas\", aplica-se individualmente para cada parcela (tem prioridade sobre o valor informado no cabeçalho).\n\n\nInformação localizada na Aba \"Parcelas\" do Pedido de Venda."},"parcela_adiantamento":{"type":"string","maxLength":1,"description":"Está é uma parcela de Adiantamento do Cliente.\n\nInforme \"S\" para indicar que é uma parcela de adiantamento.\nO padrão é \"N\".\n\n\nInformação localizada na Aba \"Parcelas\" do Pedido de Venda."},"categoria_adiantamento":{"type":"string","maxLength":20,"description":"Código da Categoria para o Adiantamento.\nSerá utilizada na conta a receber que representa o adiantamento desta parcela.\n\n\nInformação localizada na Aba \"Parcelas\" do Pedido de Venda."},"conta_corrente_adiantamento":{"type":"integer","maxLength":15,"description":"Conta Corrente de Adiantamento.\n\n\nInformação localizada na Aba \"Parcelas\" do Pedido de Venda."},"bandeira":{"type":"string","maxLength":2,"description":"Código da Bandeira da operadora de cartão."},"cnpj_fin":{"type":"string","maxLength":20,"description":"Informar o CNPJ da instituição de pagamento, adquirente ou subadquirente."}}},"description":"Dados da parcela."}},"description":"Dados da Aba \"Parcelas\" do Pedido de Venda.\n\nPara todos os outros códigos o preenchimento é automático - Não informar essa estrutura."},"observacoes":{"type":"object","properties":{"obs_venda":{"type":"string","description":"Observações da venda (elas não serão exibidas na Nota Fiscal).\n\nInformação localizada na Aba \"Observações\" do Pedido de Venda."}},"description":"Dados da Aba \"Observações\" do Pedido de Venda."},"det":{"type":"array","items":{"type":"object","properties":{"ide":{"type":"object","properties":{"codigo_item_integracao":{"type":"string","maxLength":30,"description":"Código de Integração do Item do Pedido de Venda.\n\nInforme a identificação do Item do Pedido de Venda. Caso você não tenha essa informação no seu aplicativo, informe o número sequencial de cada item do pedido.\n\nInforma de 1 a 199."},"codigo_item":{"type":"integer","maxLength":15,"description":"ID do Item do Pedido."},"simples_nacional":{"type":"string","maxLength":1,"description":"Indica que a empresa é Optante pelo Simples Nacional.\n\nInformar \"S\" ou \"N\"."},"acao_item":{"type":"string","maxLength":1,"description":"Ação para o item.\n\nPode ser:\n\n\"E\" - para excluir um item."},"id_ordem_producao":{"type":"integer","maxLength":15,"description":"Id da Ordem de Produção.\n\nCampo disponível apenas para consulta.\n\nNão deve ser informado na Inclusão ou Alteração."},"regra_impostos":{"deprecated":true,"type":"integer","maxLength":15,"description":"DEPRECATED"}},"description":"Identificação do Item do Pedido de Vendas."},"produto":{"type":"object","properties":{"codigo_produto":{"type":"integer","maxLength":15,"description":"ID do Produto.\n\nEsse campo não é exibido na tela do Pedido de Vendas.\nÉ uma informação interna, utilizada apenas nas APIs.\n\nUtilize a tag \"codigo_produto\" do método \"ListarProdutos\" da API\nhttp://app.omie.com.br/api/v1/geral/produtos/\npara obter essa informação."},"codigo_produto_integracao":{"type":"string","maxLength":60,"description":"Código de integração do Produto.\n\nEsse campo deve ser informado apenas se você incluiu o produto via API e informou um código de integração para o produto. Do contrário, informe sempre a tag \"codigo_produto\"."},"codigo":{"type":"string","maxLength":60,"description":"Código do Produto exibido na tela do Pedido de Vendas."},"descricao":{"type":"string","maxLength":120,"description":"Descrição do Produto."},"cfop":{"type":"string","maxLength":10,"description":"CFOP - Código Fiscal de Operações e Prestações.\n\nUtilize a tag \"nCodigo\" do método \"ListarCFOP\" da API\nhttp://app.omie.com.br/api/v1/produtos/cfop/\npara obter essa informação."},"ncm":{"type":"string","maxLength":13,"description":"NCM - Nomenclatura Comum do Mercosul\n\nUtilize a tag \"cCodigo\" do método \"ListarNCM\" da API\nhttp://app.omie.com.br/api/v1/produtos/ncm/\npara obter essa informação."},"ean":{"type":"string","maxLength":14,"description":"EAN - European Article Number"},"unidade":{"type":"string","maxLength":6,"description":"Unidade.\n\nUtilize a tag \"codigo\" do método \"ListarUnidades\" da API\nhttp://app.omie.com.br/api/v1/geral/unidade/\npara obter essa informação."},"quantidade":{"type":"number","maxLength":18,"description":"Quantidade\n\nNo método de devolução de pedido:\nCaso não seja preenchida será feita a devolução integral do produto."},"valor_unitario":{"type":"number","maxLength":18,"description":"Valor Únitário"},"codigo_tabela_preco":{"type":"integer","maxLength":15,"description":"Código da tabela de preço.\n\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nDeve ser informada opcionalmente, caso a tabela de preços esteja configurada no Omie."},"valor_mercadoria":{"type":"number","maxLength":18,"description":"Valor da Mercadoria"},"tipo_desconto":{"type":"string","maxLength":1,"description":"Tipo de Desconto."},"percentual_desconto":{"type":"number","maxLength":18,"description":"Percentual de Desconto."},"valor_desconto":{"type":"number","maxLength":18,"description":"Valor do Desconto"},"valor_deducao":{"type":"number","maxLength":18,"description":"Valor da Dedução"},"valor_icms_desonerado":{"type":"number","maxLength":18,"description":"Valor do ICMS desonerado"},"motivo_icms_desonerado":{"type":"string","maxLength":2,"description":"Código do Motivo de desoneração do ICMS\n\nCódigos válidos para desoneração do ICMS\n01 Táxi\n03 Produtor Agropecuário\n04 Frotista/Locadora\n05 Diplomático/Consular\n06 Utilitários e Motocicletas da Amazônia Ocidental e Áreas de Livre Comércio (Resolução 714/88 e 790/94 ? CONTRAN e suas alterações)\n07 SUFRAMA\n08 Venda a Órgão Público\n09 Outros. (NT 2011/004)\n10 Deficiente Condutor (Convênio ICMS 38/12)\n11 Deficiente Não Condutor (Convênio ICMS 38/12)\n16 Olimpíadas Rio 2016\n90 Solicitado pelo Fisco"},"valor_total":{"type":"number","maxLength":18,"description":"Valor Total."},"indicador_escala":{"type":"string","maxLength":1,"description":"Indicador de Produção em Escala Relevante.\n\nPode ser:\n\"S\" para Produzido em Escala Relevante.\n\"N\" para Produzido em Escala NÃO Relevante."},"cnpj_fabricante":{"type":"string","maxLength":20,"description":"CNPJ do Fabricante da Mercadoria."},"kit":{"type":"string","maxLength":1,"description":"Indica se o produto é um kit"},"componente_kit":{"type":"string","maxLength":1,"description":"Indica se o produto é um componente de um kit"},"codigo_item_kit":{"type":"integer","maxLength":15,"description":"ID do Item do kit (pai) que o componente pertence"},"reservado":{"type":"string","maxLength":1,"example":"S","description":"(S/N) Indica se o estoque do produto será reservado."}},"description":"Identificação do Produto do Item do Pedido de Vendas."},"observacao":{"type":"object","properties":{"obs_item":{"type":"string","description":"Observações do item (elas não serão exibidas na Nota Fisca, mas serão impressas no pedido de vendal).\n\nInformação localizada na Aba \"Observações\" do Item do Pedido de Venda."}},"description":"Dados da aba \"Observações\" do Item do Pedido de Vendas."},"inf_adic":{"type":"object","properties":{"peso_liquido":{"type":"number","maxLength":18,"description":"Peso Líquido (Kg)."},"peso_bruto":{"type":"number","maxLength":18,"description":"Peso Bruto (Kg)."},"numero_pedido_compra":{"type":"string","maxLength":15,"description":"Número do Pedido de Compra."},"item_pedido_compra":{"type":"integer","maxLength":6,"description":"Item do Pedido de Compra."},"dados_adicionais_item":{"type":"string","description":"Informações para a Nota Fiscal."},"nao_movimentar_estoque":{"type":"string","maxLength":1,"description":"Não gerar a saída de estoque deste item ao emitir NF-e.\n\nInformar \"S\" ou \"N\".\n(informe \"S\" para ativar essa opção)."},"nao_gerar_financeiro":{"type":"string","maxLength":1,"description":"Não gerar conta a receber para este item.\n\nInformar \"S\" ou \"N\".\n(Informe \"S\" para ativar essa opção)."},"codigo_categoria_item":{"type":"string","maxLength":20,"description":"Código da Categoria do item."},"codigo_beneficio_fiscal":{"type":"string","maxLength":10,"description":"Código do Benefício Fiscal."},"numero_fci":{"type":"string","maxLength":36,"description":"Número da FCI (Ficha de Conteúdo de Importação)"},"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do Local do Estoque."},"codigo_cenario_impostos_item":{"type":"integer","maxLength":15,"description":"Código do Cenário de Impostos."},"nao_somar_total":{"type":"string","maxLength":1,"description":"Não somar este item no total da NF-e"},"numero_recopi":{"type":"string","maxLength":20,"description":"Número do registro gerado pelo sistema RECOPI Nacional (Reconhecimento e Controle das Operações com Papel Imune)."}},"description":"Dados da aba \"Informações Adicionais\" do Item do Pedido de Vendas."},"imposto":{"type":"object","properties":{"icms_sn":{"type":"object","properties":{"cod_sit_trib_icms_sn":{"type":"string","maxLength":3},"origem_icms_sn":{"type":"string","maxLength":1},"aliq_icms_sn":{"type":"number","maxLength":10},"valor_credito_icms_sn":{"type":"number","maxLength":18},"base_icms_sn":{"type":"number","maxLength":18},"valor_icms_sn":{"type":"number","maxLength":18}},"description":"ICMS - Simples Nacional."},"icms":{"type":"object","properties":{"cod_sit_trib_icms":{"type":"string","maxLength":2},"origem_icms":{"type":"string","maxLength":1},"modalidade_icms":{"type":"string","maxLength":1},"perc_red_base_icms":{"type":"number","maxLength":10},"base_icms":{"type":"number","maxLength":18},"aliq_icms":{"type":"number","maxLength":10},"valor_icms":{"type":"number","maxLength":18},"perc_fcp_icms":{"type":"number","maxLength":10,"description":"Percentual do FCP - Fundo de Combate a Pobreza do ICMS."},"base_fcp_icms":{"type":"number","maxLength":18,"description":"Base de Cálculo do FCP - Fundo de Combate a Pobreza do ICMS."},"valor_fcp_icms":{"type":"number","maxLength":18,"description":"Valor do FCP - Fundo de Combate a Pobreza do ICMS."}},"description":"ICMS"},"icms_st":{"type":"object","properties":{"cod_sit_trib_icms_st":{"type":"string","maxLength":2},"modalidade_icms_st":{"type":"string","maxLength":1},"perc_red_base_icms_st":{"type":"number","maxLength":10},"base_icms_st":{"type":"number","maxLength":18},"aliq_icms_st":{"type":"number","maxLength":10},"margem_icms_st":{"type":"number","maxLength":10},"valor_icms_st":{"type":"number","maxLength":18},"aliq_icms_opprop":{"type":"number","maxLength":10,"description":"Alíquota de ICMS Operação Própria."},"perc_red_base_icms_op":{"type":"number","maxLength":10,"description":"Percentual de redução de base de cálculo de Icms Operação Própria."},"cest":{"type":"string","maxLength":9,"description":"CEST - Código Especificador da Substituíção Tributária."},"perc_fcp_icms_st":{"type":"number","maxLength":10,"description":"Percentual do FCP - Fundo de Combate a Pobreza do ICMS ST."},"base_fcp_icms_st":{"type":"number","maxLength":18,"description":"Base de Cálculo do FCP - Fundo de Combate a Pobreza do ICMS ST."},"valor_fcp_icms_st":{"type":"number","maxLength":18,"description":"Valor do FCP - Fundo de Combate a Pobreza do ICMS ST."}},"description":"ICMS - Substituição Tributária."},"icms_ie":{"type":"object","properties":{"base_icms_uf_destino":{"type":"number","maxLength":18,"description":"BC do ICMS na UF de Destino"},"aliq_icms_FCP":{"type":"number","maxLength":10,"description":"Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de Destino"},"aliq_interna_uf_destino":{"type":"number","maxLength":10,"description":"Alíquota Interna da UF de Destino"},"aliq_interestadual":{"type":"number","maxLength":10,"description":"Alíquota Interestadual das UFs Envolvidas"},"aliq_partilha_icms":{"type":"number","maxLength":10,"description":"Percentual Provisório de Partilha do ICMS Interestadual"},"valor_fcp_icms_inter":{"type":"number","maxLength":18,"description":"Valor do fundo de combate a pobreza."},"valor_icms_uf_dest":{"type":"number","maxLength":18,"description":"Valor do ICMS - UF Destino"},"valor_icms_uf_remet":{"type":"number","maxLength":18,"description":"Valor do ICMS - UF Remetente"}},"description":"ICMS Interestadual."},"icms_efet":{"type":"object","properties":{"cod_sit_trib_icms_efet":{"type":"string","maxLength":2},"origem_icms_efet":{"type":"string","maxLength":1},"modalidade_icms_efet":{"type":"string","maxLength":1},"perc_red_base_icms_efet":{"type":"number","maxLength":10},"base_icms_efet":{"type":"number","maxLength":18},"aliq_icms_efet":{"type":"number","maxLength":10},"valor_icms_efet":{"type":"number","maxLength":18}},"description":"ICMS efetivo.\nNão informar na Inclusão e Alteração.\nUtilizado somente na Consulta e Listagem"},"ipi":{"type":"object","properties":{"cod_sit_trib_ipi":{"type":"string","maxLength":2},"tipo_calculo_ipi":{"type":"string","maxLength":1},"enquadramento_ipi":{"type":"string","description":"Enquadramento do IPI"},"base_ipi":{"type":"number","maxLength":18},"aliq_ipi":{"type":"number","maxLength":10},"qtde_unid_trib_ipi":{"type":"number","maxLength":18},"valor_unid_trib_ipi":{"type":"number","maxLength":18},"valor_ipi":{"type":"number","maxLength":18}},"description":"IPI."},"pis_padrao":{"type":"object","properties":{"cod_sit_trib_pis":{"type":"string","maxLength":2},"tipo_calculo_pis":{"type":"string","maxLength":1},"base_pis":{"type":"number","maxLength":18},"aliq_pis":{"type":"number","maxLength":10},"qtde_unid_trib_pis":{"type":"number","maxLength":18},"valor_unid_trib_pis":{"type":"number","maxLength":18},"valor_pis":{"type":"number","maxLength":18}},"description":"PIS."},"pis_st":{"type":"object","properties":{"cod_sit_trib_pis_st":{"type":"string","maxLength":2},"tipo_calculo_pis_st":{"type":"string","maxLength":1},"base_pis_st":{"type":"number","maxLength":18},"aliq_pis_st":{"type":"number","maxLength":10},"qtde_unid_trib_pis_st":{"type":"number","maxLength":18},"valor_unid_trib_pis_st":{"type":"number","maxLength":18},"margem_pis_st":{"type":"number","maxLength":10},"valor_pis_st":{"type":"number","maxLength":18}},"description":"PIS - Substituíção Tributária."},"cofins_padrao":{"type":"object","properties":{"cod_sit_trib_cofins":{"type":"string","maxLength":2},"tipo_calculo_cofins":{"type":"string","maxLength":1},"base_cofins":{"type":"number","maxLength":18},"aliq_cofins":{"type":"number","maxLength":10},"qtde_unid_trib_cofins":{"type":"number","maxLength":18},"valor_unid_trib_cofins":{"type":"number","maxLength":18},"valor_cofins":{"type":"number","maxLength":18}},"description":"COFINS."},"cofins_st":{"type":"object","properties":{"cod_sit_trib_cofins_st":{"type":"string","maxLength":2},"tipo_calculo_cofins_st":{"type":"string","maxLength":1},"base_cofins_st":{"type":"number","maxLength":18},"aliq_cofins_st":{"type":"number","maxLength":10},"qtde_unid_trib_cofins_st":{"type":"number","maxLength":18},"valor_unid_trib_cofins_st":{"type":"number","maxLength":18},"margem_cofins_st":{"type":"number","maxLength":10},"valor_cofins_st":{"type":"number","maxLength":18}},"description":"COFINS - Substituição Tributária."},"inss":{"type":"object","properties":{"aliq_inss":{"type":"number","maxLength":10},"valor_inss":{"type":"number","maxLength":18}},"description":"INSS."},"csll":{"type":"object","properties":{"aliq_csll":{"type":"number","maxLength":10},"valor_csll":{"type":"number","maxLength":18}},"description":"CSLL."},"irrf":{"type":"object","properties":{"aliq_irrf":{"type":"number","maxLength":10},"valor_irrf":{"type":"number","maxLength":18}},"description":"IRRF."},"iss":{"type":"object","properties":{"base_iss":{"type":"number","maxLength":18},"aliq_iss":{"type":"number","maxLength":10},"valor_iss":{"type":"number","maxLength":18},"retem_iss":{"type":"string","maxLength":1}},"description":"ISS."},"ibs_cbs":{"type":"object","properties":{"cst_ibs_cbs":{"type":"string","maxLength":3,"description":"Código de Situação Tributária do IBS e CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"class_trib":{"type":"string","maxLength":6,"description":"Código de Classificação Tributária do IBS e CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"base_ibs_cbs":{"type":"number","maxLength":15,"description":"Base de cálculo do IBS e CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."}}},"ibs":{"type":"object","properties":{"aliquota_ibs_uf":{"type":"number","maxLength":7,"description":"Alíquota do IBS de competência das UF.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"perc_dif_ibs_uf":{"type":"number","maxLength":7,"description":"Percentual do Diferimento - IBS UF.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"perc_red_ibs_uf":{"type":"number","maxLength":7,"description":"Percentual da redução de alíquota - IBS UF.\n\nNão deve ser informado na Inclusão/Alteração. Campos disponíveis apenas para consulta.\n\nPara os métodos de inclusão e alteração, esses campos serão alimentados conforme o cenário fiscal."},"valor_dif_ibs_uf":{"type":"number","maxLength":15,"description":"Valor do Diferimento - IBS UF.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_ibs_uf":{"type":"number","maxLength":15,"description":"Valor do IBS de competência da UF.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"aliquota_ibs_mu":{"type":"number","maxLength":7,"description":"Alíquota do IBS de competência do Município.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"perc_dif_ibs_mu":{"type":"number","maxLength":7,"description":"Percentual do diferimento - UBS Município.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"perc_red_ibs_mu":{"type":"number","maxLength":7,"description":"Percentual da redução de alíquota - IBS Município.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_dif_ibs_mu":{"type":"number","maxLength":15,"description":"Valor do Diferimento - IBS Município.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_ibs_mu":{"type":"number","maxLength":15,"description":"Valor do IBS de competência do Município.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_ibs":{"type":"number","maxLength":15,"description":"Valor total do IBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."}}},"cbs":{"type":"object","properties":{"aliquota_cbs":{"type":"number","maxLength":7,"description":"Alíquota da CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"perc_dif_cbs":{"type":"number","maxLength":7,"description":"Percentual do diferimento - CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"perc_red_cbs":{"type":"number","maxLength":7,"description":"Percentual da redução de alíquota - CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_dif_cbs":{"type":"number","maxLength":15,"description":"Valor do diferimento - CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_cbs":{"type":"number","maxLength":15,"description":"Valor da CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."}}},"trib_reg":{"type":"object","properties":{"cst_reg_ibs_cst":{"type":"string","maxLength":3,"description":"Código da Situação Tributária do IBS e CBS (Tributação Regular).\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"class_trib_reg":{"type":"string","maxLength":6,"description":"Código de Classificação Tributária do IBS e CBS (Tributação Regular).\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"aliquota_reg_ibs_uf":{"type":"number","maxLength":7,"description":"Valor da alíquota do IBS da UF na tributação regular.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"aliquota_reg_ibs_mu":{"type":"number","maxLength":7,"description":"Valor da alíquota do IBS do Município na tributação regular.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"aliquota_reg_cbs":{"type":"number","maxLength":7,"description":"Valor da alíquota da CBS na tributação regular.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_reg_ibs_uf":{"type":"number","maxLength":15,"description":"Valor do Tributo do IBS da UF na tributação regular.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_reg_ibs_mu":{"type":"number","maxLength":15,"description":"Valor do Tributo do IBS do Município na tributação regular.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_reg_cbs":{"type":"number","maxLength":15,"description":"Valor do Tributo da CBS na tributação regular.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."}}}},"description":"Informações referentes aos impostos do Item do Pedido de Vendas.\n\nEssa estrutura deve ser preenchida quando os dados dos impostos devem ser respeitados tais como foram enviados na API.\n\nCaso essa estrutura não seja enviada, o Omie irá identificar a regra de imposto que melhor se ajusta as condições da venda realizada.\nPara utilizar essa opção esteja seguro de que as regras e cenários de impostos estejam cadastrados corretamente no Omie. As infomações preenchidas serão decorrentes dos dados configurados."},"rastreabilidade":{"type":"object","properties":{"numeroLote":{"type":"string","maxLength":20,"description":"Número do Lote"},"qtdeProdutoLote":{"type":"number","maxLength":12,"description":"Quantidade de Produto"},"dataFabricacaoLote":{"type":"string","maxLength":10,"description":"Data de Fabricação/Produção"},"dataValidadeLote":{"type":"string","maxLength":10,"description":"Data de Validade"},"codigoAgregacaoLote":{"type":"string","maxLength":20,"description":"Código de Agregação"}},"description":"Dados da rastreabilidade do produto."},"combustivel":{"type":"object","properties":{"cCodigoANP":{"type":"string","maxLength":9,"description":"Código de Produto da ANP."},"cDescrANP":{"type":"string","maxLength":95,"description":"Descrição do Produto conforme ANP."},"cCODIF":{"type":"string","maxLength":21,"description":"Registro do CODIF."},"nPercGLP":{"type":"number","maxLength":8,"description":"Percentual de GLP Derivado do Petróleo."},"nPercGasNacional":{"type":"number","maxLength":8,"description":"Percentual de Gás Natural Nacional."},"nPercGasImportado":{"type":"number","maxLength":8,"description":"Percentual de Gás Natural Importado."},"nValorPartida":{"type":"number","maxLength":16,"description":"Valor de Partida."},"nQtdeFatTempAmb":{"type":"number","maxLength":16,"description":"Quantidade Faturada à Temperatura Ambiente."},"cUFConsumoComb":{"type":"string","maxLength":2,"description":"UF de Consumo."},"nBC_CIDE":{"type":"number","maxLength":18,"description":"Base de Cálculo (em quantidade)  da CIDE."},"nAliquota_CIDE":{"type":"number","maxLength":10,"description":"Valor da Alíquota em Reais da CIDE."},"nValor_CIDE":{"type":"number","maxLength":18,"description":"Valor da CIDE."},"nBC_UFRem":{"type":"number","maxLength":18,"description":"Base de Cálculo da UF Remetente.\n\nBase de Cálculo do ICMS retido anteriormente por Substituição Tributária."},"nValorUFRem":{"type":"number","maxLength":10,"description":"Valor da UF Remetente.\n\nAlíquota do ICMS retido anteriormente por Substituição Tributária."},"nBC_UFDest":{"type":"number","maxLength":18,"description":"Base de Cálculo da UF Destino.\n\nBase de Cálculo do ICMS ST da UF Destino."},"nValorUFDest":{"type":"number","maxLength":18,"description":"Valor da UF Destino.\n\nBase de Cálculo do ICMS ST da UF Destino."}},"description":"Detalhamento específico de Combustível."},"tributavel":{"type":"object","properties":{"cUnidTrib":{"type":"string","maxLength":6,"description":"Unidade tributável do Item."},"nQuantTrib":{"type":"number","maxLength":19,"description":"Quantidade tributável do item."},"nValorTrib":{"type":"number","maxLength":18,"description":"Valor tributável do item."},"cEanTrib":{"type":"string","maxLength":14,"description":"código EAN tributável do item."}},"description":"Unidade, Quantidade, Valor e EAN tributáveis do item do pedido."},"lote_validade":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","maxLength":15,"description":"Id do Lote do produto.\n\nObrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.."},"nQtdLote":{"type":"number","maxLength":18,"description":"Informe aqui a quantidade do Lote para o produto.\n\nÉ obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações."}},"required":["nQtdLote"]},"description":"Informações referentes ao lote e validade do produto.\n\nA tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes \"manualmente\" por API."}}},"description":"Dados da Aba \"Itens da Venda\" do Pedido de Venda."},"market_place":{"type":"object","properties":{"nTaxa":{"type":"number","maxLength":18,"description":"Valor da taxa do Market Place."},"nEnvio":{"type":"number","maxLength":18,"description":"Valor do envio do Market Place."}},"description":"Dados para o Market Place."},"total_pedido":{"type":"object","properties":{"base_calculo_icms":{"type":"number","maxLength":18,"description":"Base de Cálculo do ICMS."},"base_calculo_st":{"type":"number","maxLength":18,"description":"Base de cálculo da substituição tributária."},"valor_pis":{"type":"number","maxLength":18,"description":"Valor do PIS."},"valor_cofins":{"type":"number","maxLength":18,"description":"Valor do cofins."},"valor_csll":{"type":"number","maxLength":18,"description":"Valor da CSLL."},"valor_icms":{"type":"number","maxLength":18,"description":"Valor total do ICMS."},"valor_st":{"type":"number","maxLength":18,"description":"Valor total da ST."},"valor_inss":{"type":"number","maxLength":18,"description":"Valor do INSS."},"valor_IPI":{"type":"number","maxLength":18,"description":"Valor do IPI."},"valor_ir":{"type":"number","maxLength":18,"description":"Valor do IR.\n.Preenchimento automático - Não informar."},"valor_iss":{"type":"number","maxLength":18,"description":"Valor do ISS."},"valor_deducoes":{"type":"number","maxLength":28,"description":"Valor das deduções."},"valor_descontos":{"type":"number","maxLength":18,"description":"Valor dos descontos."},"valor_mercadorias":{"type":"number","maxLength":18,"description":"valor das mercadorias."},"valor_total_pedido":{"type":"number","maxLength":18,"description":"Valor total do pedido."},"base_ibs_cbs":{"type":"number","maxLength":15,"description":"Valor total da base de cálculo do IBS e da CBS."},"valor_dif_ibs_uf":{"type":"number","maxLength":15,"description":"Valor total do diferimento do IBS UF."},"valor_ibs_uf":{"type":"number","maxLength":15,"description":"Valor total do IBS da UF."},"valor_dif_ibs_mu":{"type":"number","maxLength":15,"description":"Valor total do diferimento do IBS do município."},"valor_ibs_mu":{"type":"number","maxLength":15,"description":"Valor total do IBS do município."},"valor_ibs":{"type":"number","maxLength":15,"description":"Valor total do IBS."},"valor_dif_cbs":{"type":"number","maxLength":15,"description":"Valor total do diferimento da CBS."},"valor_cbs":{"type":"number","maxLength":15,"description":"Valor total da CBS."},"valor_tot_ibs_cbs_is":{"type":"number","maxLength":15,"description":"Total da NF-e com IBS/CBS/IS."}},"description":"Valores totais do pedido."},"infoCadastro":{"type":"object","properties":{"dInc":{"type":"string","maxLength":10,"description":"Data da Inclusão."},"hInc":{"type":"string","maxLength":8,"description":"Hora da Inclusão."},"uInc":{"type":"string","maxLength":10,"description":"Usuário da Inclusão."},"dAlt":{"type":"string","maxLength":10,"description":"Data da Alteração."},"hAlt":{"type":"string","maxLength":8,"description":"Hora da Alteração."},"uAlt":{"type":"string","maxLength":10,"description":"Usuário da Alteração."},"dCan":{"type":"string","maxLength":10,"description":"Data da Cancelamento."},"hCan":{"type":"string","maxLength":8,"description":"Hora da Cancelamento."},"uCan":{"type":"string","maxLength":10,"description":"Usuário da Cancelamento."},"cancelado":{"type":"string","maxLength":1,"description":"Indica se o pedido foi cancelado."},"dFat":{"type":"string","maxLength":10,"description":"Data de Faturamento."},"hFat":{"type":"string","maxLength":8,"description":"Hora de faturamento."},"uFat":{"type":"string","maxLength":10,"description":"Usuário que realizou o faturamento."},"faturado":{"type":"string","maxLength":1,"description":"Indica se o pedido está faturado."},"denegado":{"type":"string","maxLength":1,"description":"Indica se o pedido foi denegado."},"autorizado":{"type":"string","maxLength":1,"description":"Indica se o pedido foi autorizado."},"devolvido":{"type":"string","maxLength":1,"description":"Indica se o pedido foi devolvido."},"devolvido_parcial":{"type":"string","maxLength":1,"description":"Indica se o pedido foi devolvido parcialmente."},"cImpAPI":{"type":"string","maxLength":1,"description":"Importado pela API."}},"description":"Informações complementares do pedido."},"exportacao":{"type":"object","properties":{"nao_exportacao":{"type":"string","maxLength":1,"description":"O cliente é estrangeiro, mas na verdade não se trata de uma exportação"},"local_embarque":{"type":"string","maxLength":60,"description":"Local de Embarque (ou de transposição de fronteira)"},"uf_embarque":{"type":"string","maxLength":2,"description":"UF do Local de Embarque"},"local_despacho":{"type":"string","maxLength":60,"description":"Local de Despacho"}},"description":"Dados da exportacao"},"lancamentos":{"type":"array","items":{"type":"object","properties":{"nSequencia":{"type":"integer","maxLength":5,"description":"Número da Sequencia.\n\n\nPara os itens da NF identifica qual o item do XML se refere.\n\nPara as parcelas da NF identifica o número da parcela.\n\nPara os lançamentos no Conta Corrente indentifica o lançamento que será gerado.\n\nPermite sequencial de 1 a 999."},"cNaturezaDocumento":{"type":"string","maxLength":1,"description":"Natureza do Documento.\n\n\nPode ser:\nP - Pagar\nR - Receber\n\nObrigatório na operação \"IncluirPedido\"; não é processado nas demais operações que\nreutilizam esta estrutura, como \"AlterarPedidoVenda\"."},"nValorDocumento":{"type":"number","maxLength":18,"description":"Valor do Documento.\n\nObrigatório na operação \"IncluirPedido\"; não é processado nas demais operações que\nreutilizam esta estrutura, como \"AlterarPedidoVenda\"."},"dDataDocumento":{"type":"string","maxLength":10,"description":"Data do documento.\n\nObrigatório na operação \"IncluirPedido\"; não é processado nas demais operações que\nreutilizam esta estrutura, como \"AlterarPedidoVenda\"."},"cTipoDocumento":{"type":"string","maxLength":5,"description":"Tipo de Documento.\n\n\nLista de tipos de documentos em:\n/api/v1/geral/tiposdoc\n\nObrigatório na operação \"IncluirPedido\"; não é processado nas demais operações que\nreutilizam esta estrutura, como \"AlterarPedidoVenda\"."},"cCategoria":{"type":"string","maxLength":20,"description":"Código da Categoria."},"nContaCorrente":{"type":"integer","maxLength":15,"description":"Id da Conta Corrente."},"cOrigem":{"type":"string","maxLength":3,"description":"Origem da Nota Fiscal.\n\n\nCódigos Disponíveis:\n\nAPI - Importado via API.\n\nObrigatório na operação \"IncluirPedido\"; não é processado nas demais operações que\nreutilizam esta estrutura, como \"AlterarPedidoVenda\"."},"cObs":{"type":"string","description":"Observações."},"nProjeto":{"type":"integer","maxLength":15,"description":"Id do projeto."},"nVendedor":{"type":"integer","maxLength":15,"description":"Id do Vendedor."}}},"description":"Lançamentos no Conta Corrente relacionados ao Pedido de Vendas taxas,entre outros)."},"agropecuario":{"type":"object","properties":{"cNumReceita":{"type":"string","maxLength":20,"description":"Número da receita ou receituário do agrotóxico/defensivo agrícola"},"cCpfResponsavel":{"type":"string","maxLength":14,"description":"CPF do responsá¡vel técnico legalmente habilitado"},"nTipoGuia":{"type":"integer","maxLength":1,"description":"Tipo da Guia\n\n1 - Corresponde ao GTA\n2 - Corresponde ao TTA\n3 - Corresponde ao DTA\n4 - Corresponde ao ATV\n5 - Corresponde ao PTV\n6 - Corresponde ao GTV\n7 - Corresponde ao Guia Florestal (DOF, SisFlora - PA e MT, SIAM - MG)"},"cUFGuia":{"type":"string","maxLength":2,"description":"UF de emissão da Guia"},"cSerieGuia":{"type":"string","maxLength":9,"description":"Número de série da guia"},"nNumGuia":{"type":"integer","maxLength":9,"description":"Número da guia"}}}}}}},"example":{"call":"IncluirPedido","param":[{"cabecalho":{"codigo_cliente":3792227,"codigo_pedido_integracao":"1790776577","data_previsao":"30/09/2026","etapa":"10","numero_pedido":"40451","codigo_parcela":"999","quantidade_itens":2},"det":[{"ide":{"codigo_item_integracao":"4422421"},"inf_adic":{"peso_bruto":150,"peso_liquido":150},"produto":{"cfop":"5.102","codigo_produto":"4422421","descricao":"Telefone Celular X","ncm":"9403.30.00","quantidade":1,"tipo_desconto":"V","unidade":"UN","valor_desconto":0,"valor_unitario":200}}],"frete":{"modalidade":"9"},"informacoes_adicionais":{"codigo_categoria":"1.01.03","codigo_conta_corrente":11850365,"consumidor_final":"S","enviar_email":"N"},"agropecuario":{"cNumReceita":"","cCpfResponsavel":"","nTipoGuia":1,"cUFGuia":"","cSerieGuia":"","nNumGuia":1},"lista_parcelas":{"parcela":[{"data_vencimento":"01/10/2026","numero_parcela":1,"percentual":50,"valor":100},{"data_vencimento":"04/03/2027","numero_parcela":2,"percentual":50,"valor":100}]}}]}},"produtos_pedido_IncluirPedido_retorno":{"type":"object","properties":{"codigo_pedido":{"type":"integer","description":"Código do Pedido de Venda de Produto"},"codigo_pedido_integracao":{"type":"string","description":"Código de Integração do Pedido de Venda de Produto"},"codigo_status":{"type":"string","description":"Código do Status do Pedido de Venda."},"descricao_status":{"type":"string","description":"Descrição do status."},"numero_pedido":{"type":"string","description":"Número do pedido - Visualizado pelo cliente."}},"title":"IncluirPedido (retorno)"},"produtos_pedido_ListarPedidos":{"type":"object","title":"ListarPedidos","description":"Listar os pedidos de venda de produto","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarPedidos"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15},"registros_por_pagina":{"type":"integer","maxLength":15},"apenas_importado_api":{"type":"string","maxLength":1},"ordenar_por":{"type":"string","maxLength":100,"description":"Ordem de exibição dos dados. Padrão: Código."},"filtrar_por_data_de":{"type":"string","maxLength":10},"filtrar_por_data_ate":{"type":"string","maxLength":10},"filtrar_por_hora_de":{"type":"string","maxLength":8,"description":"Filtra os registros a partir da hora específicada."},"filtrar_por_hora_ate":{"type":"string","maxLength":8,"description":"Filtra os registros até a hora específicada."},"filtrar_apenas_inclusao":{"type":"string","maxLength":1},"filtrar_apenas_alteracao":{"type":"string","maxLength":1},"filtrar_por_cliente":{"type":"integer","maxLength":15,"description":"Filtra os registros do cliente específicado."},"filtrar_por_vendedor":{"type":"integer","maxLength":15,"description":"Filtra os registros do vendedor específicado."},"filtrar_por_projeto":{"type":"integer","maxLength":15,"description":"Filtra os registros do projeto específicado."},"etapa":{"type":"string","maxLength":2,"description":"Etapa do pedido de venda.\n\nEsse campo indica em que coluna o pedido de venda irá figurar no processo de faturamento do Omie.\n\nUtilize a tag \"codigo\" do método \"ListarEtapasFaturamento\" da API\nhttp://app.omie.com.br/api/v1/produtos/etapafat/\npara obter essa informação.\n\nOs valores são fixos, mas as descrições (funções atribuídas a cada coluna pode mudar. A API irá indicar a descrição de cada coluna.\n\nOs valores disponíveis para esse campo podem ser:\n\n\"10\" - Primeira coluna\n\"20\" - Segunda coluna\n\"30\" - Terceira coluna\n\"40\" - Quarta coluna\n\"50\" - Faturar."},"numero_pedido_de":{"type":"integer","maxLength":15,"description":"Filtra os registros a partir do número do pedido específicado."},"numero_pedido_ate":{"type":"integer","maxLength":15,"description":"Filtra os registros até o número do pedido específicado."},"apenas_resumo":{"type":"string","maxLength":1,"description":"Exibir apenas o resumo do pedido de vendas.\n\nPreencher com \"S\" ou \"N\"."},"data_previsao_de":{"type":"string","maxLength":10,"description":"Data de Previsão do faturamento inicio."},"data_previsao_ate":{"type":"string","maxLength":10,"description":"Data de Previsão do faturamento final."},"data_faturamento_de":{"type":"string","maxLength":10,"description":"Data de Faturamento inicial."},"data_faturamento_ate":{"type":"string","maxLength":10,"description":"Data de Faturamento final."},"data_emissao_de":{"deprecated":true,"type":"string","maxLength":10,"description":"DEPRECATED"},"data_emissao_ate":{"deprecated":true,"type":"string","maxLength":10,"description":"DEPRECATED"},"data_cancelamento_de":{"type":"string","maxLength":10,"description":"Data de Cancelamento inicial."},"data_cancelamento_ate":{"type":"string","maxLength":10,"description":"Data de Cancelamento final."},"status_pedido":{"type":"string","maxLength":100,"description":"Status do Pedido.\n\nFATURADO\nCANCELADO\nAUTORIZADO\nDENEGADO\nDEVOLVIDO"},"ordem_descrescente":{"deprecated":true,"type":"string","maxLength":1,"description":"DEPRECATED"}}}}},"example":{"call":"ListarPedidos","param":[{"pagina":1,"registros_por_pagina":100,"apenas_importado_api":"N"}]}},"produtos_pedido_ListarPedidos_retorno":{"type":"object","properties":{"pagina":{"type":"integer"},"total_de_paginas":{"type":"integer"},"registros":{"type":"integer"},"total_de_registros":{"type":"integer"},"pedido_venda_produto":{"type":"array","items":{"type":"object","properties":{"cabecalho":{"type":"object","properties":{"codigo_pedido":{"type":"integer","description":"ID do pedido do venda. Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs."},"codigo_pedido_integracao":{"type":"string","description":"Código de integração do pedido de venda. Preencha esse campo com o código do pedido no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de pedidos você conseguirá ver a relação entre o id do pedido gerado no Omie e o código de pedido existente em sua aplicação."},"numero_pedido":{"type":"string","description":"Número do pedido de venda. Esse é o número do pedido de venda no Omie, que é gerado automaticamente e exibido na tela."},"sequencial":{"type":"string","description":"Número sequencial do pedido de venda parcial. Esse é o número do pedido de venda parcial no Omie, que é gerado automaticamente e exibido na tela."},"codigo_cliente":{"type":"integer","description":"Código do cliente. Utilize a tag \"codigo_cliente_omie\" do método \"ListarClientes\" da API http://app.omie.com.br/api/v1/geral/clientes/ para obter essa informação."},"codigo_cliente_integracao":{"type":"string","description":"Código de Integração do Cliente Esse campo deve ser informado apenas se você incluiu o cliente via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag \"codigo_cliente\"."},"data_previsao":{"type":"string","description":"Data de Previsão de Faturamento. Utilize o formato \"dd/mm/aaaa\". Esse campo indica a data da previsão do faturamento do pedido e deve ser informado com uma data igual ou superior a data corrente."},"quantidade_itens":{"type":"integer","description":"Quantidade de Itens."},"etapa":{"type":"string","description":"Etapa do pedido de venda. Esse campo indica em que coluna o pedido de venda irá figurar no processo de faturamento do Omie. Utilize a tag \"codigo\" do método \"ListarEtapasFaturamento\" da API http://app.omie.com.br/api/v1/produtos/etapafat/ para obter essa informação. Os valores são fixos, mas as descrições (funções atribuídas a cada coluna pode mudar. A API irá indicar a descrição de cada coluna. Os valores disponíveis para esse campo podem ser: \"10\" - Primeira coluna \"20\" - Segunda coluna \"30\" - Terceira coluna \"40\" - Quarta coluna \"50\" - Faturar."},"codigo_parcela":{"type":"string","description":"Código da parcela/Condição de pagamento. Utilize a tag \"nCodigo\" do método \"ListarFormasPagVendas\" da API http://app.omie.com.br/api/v1/produtos/formaspagvendas/ para obter essa informação. O código \"999\" é o único que permite uma definição de forma de pagamento customizada. Caso você escolha essa opção, deve também informar a tag \"qtde_parcelas\" e a estrutura \"lista_parcelas\". Consultar a API de parcelas para obter código: 'api/v1/geral/parcelas/#ListarParcelas'."},"qtde_parcelas":{"type":"integer","description":"Quantidade de parcelas. Valores permitidos de 1 a 999."},"origem_pedido":{"type":"string","description":"Origem do Pedido. Default: API - Importado via API. MLV - Mercado Livre Esse campo será ignorado no método AlterarPedidoVenda."},"codigo_cenario_impostos":{"type":"integer","description":"Código do Cenário de Impostos. Se não informado, será assumido o cenário padrão."},"bloqueado":{"type":"string","description":"Pedido Bloqueado pela API."},"importado_api":{"type":"string","description":"Pedido de venda de produto importada pela API."},"codigo_empresa":{"type":"integer","description":"DEPRECATED"},"codigo_empresa_integracao":{"type":"string","description":"DEPRECATED"},"tipo_desconto_pedido":{"type":"string","description":"Tipo de desconto para o pedido. Pode ser: V - Valor P - Percentual Ao informar o desconto na capa do pedido o mesmo será distribuído proporcionalmente para os itens. Uma vez realizada a distribuição os valores do desconto serão exibidos apenas nos itens. IMPORTANTE: - Não será permitido informar desconto na capa caso já exista distribuição pelos itens. - Na alteração o desconto será aplicado para todos os itens do pedido."},"perc_desconto_pedido":{"type":"decimal","description":"Percentual do desconto do pedido. Ao informar o desconto na capa do pedido o mesmo será distribuído proporcionalmente para os itens. Uma vez realizada a distribuição os valores do desconto serão exibidos apenas nos itens. IMPORTANTE: - Não será permitido informar desconto na capa caso já exista distribuição pelos itens. - Na alteração o desconto será aplicado para todos os itens do pedido."},"valor_desconto_pedido":{"type":"decimal","description":"Valor do desconto do pedido. Ao informar o desconto na capa do pedido o mesmo será distribuído proporcionalmente para os itens. Uma vez realizada a distribuição os valores do desconto serão exibidos apenas nos itens. IMPORTANTE: - Não será permitido informar desconto na capa caso já exista distribuição pelos itens. - Na alteração o desconto será aplicado para todos os itens do pedido. - Se o desconto for superior ao valor do pedido ele não será aplicado."},"encerrado":{"type":"string","description":"Indica que o pedido foi encerrado (S/N). Tag utilizada apenas nos métodos de listagem e consulta."},"enc_motivo":{"type":"string","description":"Descrição do motivo do encerramento. Tag utilizada apenas nos métodos de listagem e consulta."},"enc_data":{"type":"string","description":"Data de encerramento, Tag utilizada apenas nos métodos de listagem e consulta."},"enc_hora":{"type":"string","description":"Hora de encerramento, Tag utilizada apenas nos métodos de listagem e consulta."},"enc_user":{"type":"string","description":"Usuário do encerramento, Tag utilizada apenas nos métodos de listagem e consulta."},"nao_gerar_boleto":{"type":"string","description":"Indica se o boleto não deve ser gerado para a(s) parcela(s) ao emitir a nota fiscal. Informe \"S\" para não gerar o boleto. O padrão é \"N\". Quando informado dentro do tag \"cabecalho\", aplica-se como valor padrão para todas as parcelas, caso não seja especificado individualmente em cada uma. Quando informado dentro da tag \"lista_parcelas\", aplica-se individualmente para cada parcela (tem prioridade sobre o valor informado no cabeçalho). Informação localizada na Aba \"Parcelas\" do Pedido de Venda."}},"description":"Informações do cabeçalho do pedido."},"departamentos":{"type":"array","items":{"type":"object","properties":{"cCodDepto":{"type":"string","description":"ID do Departamento. Informação localizada na Aba \"Departamentos\" do Pedido de Venda. Utilize a tag \"codigo\" do método \"ListarDepatartamentos\" da API http://app.omie.com.br/api/v1/geral/departamentos/ para obter essa informação."},"nPerc":{"type":"decimal","description":"Percentual de Rateio. Informação localizada na Aba \"Departamentos\" do Pedido de Venda."},"nValor":{"type":"decimal","description":"Valor do Rateio. Informação localizada na Aba \"Departamentos\" do Pedido de Venda."},"nValorFixo":{"type":"string","description":"Indica que o valor foi fixado na distribuição do rateio. Informar \"S\" ou \"N\". Informação localizada na Aba \"Departamentos\" do Pedido de Venda."}}},"description":"Dados da Aba \"Departamentos\" do Pedido de Venda."},"frete":{"type":"object","properties":{"codigo_transportadora":{"type":"integer","description":"ID da transportadora. Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda. Utilize a tag \"codigo_cliente_omie\" do método \"ListarClientes\" da API http://app.omie.com.br/api/v1/geral/clientes/ para obter essa informação. OBS: O Omie uitliza o cadastro de clientes para registrar também fornecedores e transportadoras."},"codigo_transportadora_integracao":{"type":"string","description":"Código Integração da Transportadora. Esse campo deve ser informado apenas se você incluiu o cliente (transportadora) via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag \"codigo_cliente\"."},"modalidade":{"type":"string","description":"Tipo de Frete. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda. Valores disponíveis: \"0\" - Contratação do Frete por conta do Remetente (CIF) \"1\" - Contratação do Frete por conta do Destinatário (FOB) \"2\" - Contratação do Frete por conta de Terceiros \"3\" - Transporte Próprio por conta do Remetente \"4\" - Transporte Próprio por conta do Destinatário \"9\" - Sem frete."},"placa":{"type":"string","description":"Placa do Veículo. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"placa_estado":{"type":"string","description":"Estado da Placa do Veículo. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"registro_transportador":{"type":"string","description":"RNTRC (ANTT) - Registro Nacional de Transportador de Cargas. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"quantidade_volumes":{"type":"integer","description":"Quantidade de Volumes. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"especie_volumes":{"type":"string","description":"Espécie dos Volumes. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"marca_volumes":{"type":"string","description":"Marca dos Volumes. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"numeracao_volumes":{"type":"string","description":"Numeração dos Volumes. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"peso_liquido":{"type":"decimal","description":"Peso Líquido (Kg). Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"peso_bruto":{"type":"decimal","description":"Peso Bruto (Kg). Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"valor_frete":{"type":"decimal","description":"Valor do Frete. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"valor_seguro":{"type":"decimal","description":"Valor do Seguro. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"numero_lacre":{"type":"string","description":"Número do Lacre. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"outras_despesas":{"type":"decimal","description":"Outras Despesas Acessórias. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"veiculo_proprio":{"type":"string","description":"O transporte será realizado com veículo próprio. Informar \"S\" ou \"N\". Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"previsao_entrega":{"type":"string","description":"Previsão de entrega do Pedido de Venda Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"codigo_rastreio":{"type":"string","description":"Código de Rastreio da Entrega do Pedido de Venda. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"icms_retido":{"type":"object","properties":{"vServicoTr":{"type":"decimal","description":"Valor de Serviço de Transporte. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"vBCRetencaoTr":{"type":"decimal","description":"Base de Cálculo da Retenção. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"vAliquotaRetencaoTr":{"type":"decimal","description":"Percentual de Alíquota de Retenção. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"vIcmsRetidoTr":{"type":"decimal","description":"Valor de ICMS Retido. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"cCfopTr":{"type":"string","description":"CFOP. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda. Utilize a tag \"nCodigo\" do método \"ListarCFOP\" da API http://app.omie.com.br/api/v1/produtos/cfop/ para obter essa informação."},"cCidadeTr":{"type":"string","description":"Cidade de Ocorrência do Fato Gerador do ICMS. Utilize o formato: CIDADE (UF), como no exemplos: \"SAO PAULO (SP)\" \"RIO DE JANEIRO (RJ)\" \"FLORIANOPOLIS (SC)\" Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda. Utilize a tag \"cCod\" do método \"PesquisarCidades\" da API http://app.omie.com.br/api/v1/geral/cidades/ para obter essa informação."}},"description":"Dados do ICMS Retido do Serviço de Transporte. Informação localizada na Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"codigo_tipo_entrega":{"type":"integer","description":"Código do tipo de entrega."},"link_rastreio":{"type":"string","description":"Link de Rastreio da Entrega do Pedido de Venda. Informação interna pode ser visualizada e consultada via API '/api/v1/produtos/pedido/'."}},"description":"Dados da Aba \"Frete e Outras Despesas\" do Pedido de Venda."},"informacoes_adicionais":{"type":"object","properties":{"codigo_categoria":{"type":"string","description":"Código da categoria. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda. Utilize a tag \"codigo\" do método \"ListarCategorias\" da API http://app.omie.com.br/api/v1/geral/categorias/ para obter essa informação."},"codigo_conta_corrente":{"type":"integer","description":"Código da Conta Corrente. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda. Utilize a tag \"codigo\" do método \"PesquisarContaCorrente\" da API http://app.omie.com.br/api/v1/geral/contacorrente/ para obter essa informação."},"numero_pedido_cliente":{"type":"string","description":"Número do pedido do cliente. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"numero_contrato":{"type":"string","description":"Número do Contrato de Venda. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"contato":{"type":"string","description":"Contato. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"dados_adicionais_nf":{"type":"string","description":"Dados adicionais para a Nota Fiscal. Utilize o caracter pipe ( | ) como separador de linha. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"consumidor_final":{"type":"string","description":"Nota Fiscal para Consumo Final. Informar \"S\" ou \"N\". Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"utilizar_emails":{"type":"string","description":"Utilizar os seguintes endereços de e-mail. Informar a lista de e-mail que receberão a Nota Fiscal. Utilize a virgula (,) como separador. Informação localizada na Aba \"E-mail para o Cliente\" do Pedido de Venda."},"enviar_email":{"type":"string","description":"Enviar e-mail com o boleto de cobrança gerado pelo faturamento (juntamente com o DANFE e o XML da NF-e). Informar \"S\" ou \"N\". Default \"N\" Informação localizada na Aba \"E-mail para o Cliente\" do Pedido de Venda. É permitido somente o preenchimento de uma das tags \"enviar_pix\" ou \"enviar_email\"."},"enviar_pix":{"type":"string","description":"Enviar e-mail com o PIX de cobrança gerado pelo faturamento (juntamente com o DANFE e o XML da NF-e). Informar \"S\" ou \"N\". Default \"N\" Informação localizada na Aba \"E-mail para o Cliente\" do Pedido de Venda. É permitido somente o preenchimento de uma das tags \"enviar_pix\" ou \"enviar_email\"."},"codVend":{"type":"integer","description":"Código do Vendedor. Informação localizada no cabeçalho do Pedido de Venda. Utilize a tag \"codigo\" do método \"ListarVendedores\" da API http://app.omie.com.br/api/v1/geral/vendedores/ para obter essa informação."},"codProj":{"type":"integer","description":"Código do Projeto. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda. Utilize a tag \"codigo\" do método \"ListarProjetos\" da API http://app.omie.com.br/api/v1/geral/projetos/ para obter essa informação."},"outros_detalhes":{"type":"object","properties":{"cNatOperacaoOd":{"type":"string","description":"Natureza da Operação. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cIndicadorOd":{"type":"string","description":"Indicador de Presença da Operação. 1 - Operação presencial. 2 - Operação não presencial, pela Internet. 3 - Operação não presencial, Teleatendimento. 4 - NFC-e em operação com entrega a domicílio. 9 -Operação não presencial, outros. Se não informado, utilizaremos automaticamente o \"9 - Outros\". Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cIndicadorIntOd":{"type":"string","description":"Indicador de Intermediador. Esta informação deverá ser enviada quando se tratar de uma operação não presencial. Opções disponíveis: 0=Operação sem intermediador(em site ou plataforma própria) 1=Operação em site ou plataforma de terceiros(intermediadores/marketplace) Se não informado, utilizaremos automaticamente a opção \"0-Operação sem intermediador(em site ou plataforma própria)\". Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cCnpjIntOd":{"type":"string","description":"CNPJ do Intermediador. Preencimento obrigatório caso o Indicador de Intermediador seja igual a opção \"1-Operação em site ou plataforma de terceiros(intermediadores/marketplace)\". Este campo representa o CNPJ do Intermediador da Transação. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cIdentificadorIntOd":{"type":"string","description":"Identificação no Intermediador. Este identificador pode ser o nome do usuário ou identificação do perfil do vendedor no site do intermediador. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"dDataSaidaOd":{"type":"string","description":"Data de Saída. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cHoraSaidaOd":{"type":"string","description":"Hora de Saída. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cCnpjCpfOd":{"type":"string","description":"CNPJ / CPF (do recebedor). Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cNomeOd":{"type":"string","description":"Nome / Razão Social. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cInscrEstadualOd":{"type":"string","description":"Inscrição Estadual. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cEnderecoOd":{"type":"string","description":"Endereço. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cNumeroOd":{"type":"string","description":"Número do endereço. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cComplementoOd":{"type":"string","description":"Complemento do endereço. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cBairroOd":{"type":"string","description":"Bairro. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cEstadoOd":{"type":"string","description":"Estado. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cCidadeOd":{"type":"string","description":"Cidade. Utilize o padrão: CIDADE (UF), como no exemplo: \"SAO PAULO (SP)\" Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda. Utilize a tag \"cCod\" do método \"PesquisarCidades\" da API http://app.omie.com.br/api/v1/geral/cidades/ para obter essa informação."},"cCEPOd":{"type":"string","description":"CEP. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cSepararEnderecoOd":{"type":"string","description":"Separar endereço. Valores possível S ou N, sendo N o padrão. Quando igual S separa do endereço o número o e complemento, caso existirem."},"cTelefoneOd":{"type":"string","description":"Telefone. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cCnpjCpfOdRet":{"type":"string","description":"CPF/CNPJ (Local de Retirada). Preencimento opcional quando a mercadoria não está com o Emitente e deve ser retirada em outro local. Este campo representa o CPF/CNPJ do responsável pela retirada da mercadoria. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cNomeOdRet":{"type":"string","description":"Nome / Razão Social (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cInscrEstadualOdRet":{"type":"string","description":"Inscrição Estadual (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cEnderecoOdRet":{"type":"string","description":"Endereço (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cNumeroOdRet":{"type":"string","description":"Número do endereço (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cComplementoOdRet":{"type":"string","description":"Complemento do endereço (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cBairroOdRet":{"type":"string","description":"Bairro (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cEstadoOdRet":{"type":"string","description":"Estado (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cCidadeOdRet":{"type":"string","description":"Cidade (Local de Retirada). Utilize o padrão: CIDADE (UF), como no exemplo: \"SAO PAULO (SP)\" Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda. Utilize a tag \"cCod\" do método \"PesquisarCidades\" da API http://app.omie.com.br/api/v1/geral/cidades/ para obter essa informação."},"cCEPOdRet":{"type":"string","description":"CEP (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cSepararEnderecoOdRet":{"type":"string","description":"Separar endereço. Valores possível S ou N, sendo N o padrão. Quando igual S separa do endereço o número o e complemento, caso existirem."},"cTelefoneOdRet":{"type":"string","description":"Telefone (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."}},"description":"Outros detalhes da NF-e."},"impostos_embutidos":{"type":"string","description":"DEPRECATED"},"meio_pagamento":{"type":"string","description":"Meio de Pagamento - Utilizado apenas para emissão de NF-e (campo \"tPag\" do XML). Esse campo indica como a parcela da nota será paga. Informação localizada na Aba \"Parcelas\" do Pedido de Venda. Caso informado na estrutura \"informacoes_adicionais\" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura \"parcela\". Pode ser: 01 Dinheiro 02 Cheque 03 Cartão de Crédito 04 Cartão de Débito 05 Crédito Loja 10 Vale Alimentação 11 Vale Refeição 12 Vale Presente 13 Vale Combustível 15 Boleto Bancário 16 Depósito Bancário 17 Pagamento Instantâneo (PIX) 18 Transferência bancária, Carteira Digital 19 Programa de fidelidade, Cashback, Crédito Virtual. 90 Sem Pagamento 99 Outros Listagem completa disponível na API: /api/v1/geral/meiospagamento/"},"descr_meio_pagamento":{"type":"string","description":"Descrição do Meio de Pagamento - Utilizado apenas para emissão de NF-e (campo \"xPag\" do XML). Esse campo precisa ser informado quando a tag \"meio_pagamento\" for igual a 99 (Outros). Informação localizada na Aba \"Parcelas\" do Pedido de Venda. Caso informado na estrutura \"informacoes_adicionais\" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura \"parcela\"."},"tipo_documento":{"type":"string","description":"Tipo de Documento. Informação localizada na Aba \"Parcelas\" do Pedido de Venda. Pode ser: 13S 13o. Salário 99999 Outros ACO Acordo ACOB Acordo - Boleto ACOT Acordo - Transferência ADI Adiantamento ANT Antecipação APL Aplicação APO Apólice APOR Aporte ASS Assinatura BIL Bilhete BOL Boleto BOLV Boleto à Vista BONUS Bonus CAP Capitalização CART Carteira CF Cupom Fiscal CHD Cheque Devolvido CHP Cheque Pré CHQ Cheque CHT Cheque de Terceiros CNT Crédito em Conta COB Cobrança COM Comissão CON Convênios CONC Cobrança de Concessionária COND Condicional CONS Consignado CONSO Consórcio CRC Cartão de Crédito CRD Cartão de Débito CRE Crediário CRP Cartão Pré-Pago CRT Cartão CRTO Cartório CTE CT-e CTR Contrato CUSJ Custos Judiciais DACTE DACTE DAE DAE DAJE DAJE DAM DAM DANFE DANFE DAR DAR DARE DARE DARJ DARJ DARM DARM DAS DAS DDA DDA DEB Débito em Conta DEBA Débito Automático DEP Depósito DEV Devolução DFE Documento Fiscal Equivalente DIN Dinheiro DLC Distribuição de Lucros DNF Documento não fiscal DNFSE DANFSE DOA Doação DOC DOC DPVAT DPVAT DRF DARF DUA DUA DUAM DUAM DUP Duplicata EMP Empréstimo ENC Encargos ETAR Estorno de Tarifa FAT Fatura FER Férias FIA Fiado FIN Financiamento FPGT Folha de Pagamento GAR Garantia GARE GARE GNRE GNRE GPS GPS GRCS GRCS GRCSU GRCSU GRF Guia de Recolhimento do FGTS GRU GRU GUIA Guia de Recolhimento HOL Holerite IMP Imposto INV Invoice IPTU IPTU IPVA IPVA JUROS Juros Limite MED Medição MULTA Multas MUTUO Mútuo NC Nota de Crédito ND Nota de Débito NF Nota Fiscal NF3E Nota Fiscal de Energia Elétrica Eletrônica NFA Nota Fiscal de Abastecimento NFC Nota Fiscal de Consumidor NFCE Nota Fiscal de Consumidor Eletrônica NFD Nota Fiscal de Devolução NFE Nota Fiscal Eletrônica NFEE Nota Fiscal Energia Elétrica NFS Nota Fiscal de Serviço NFST Nota Fiscal de Telecomunicações NFSTM Nota Fiscal de Serviço Tomado PDD PDD PED Pedido PEN Pensão Alimentícia PER Permuta PIX Pix PROF Proforma Invoice PROL Pro-Labore PROT Protesto PROV Provisão REC Recibo REE Reembolso REND Rendimentos RES Resgate RET Rescisão Trabalhista RPA RPA SAN Sangria SAQ Saque SUP Suprimento TAR Tarifa TED TED TFE Taxa de Fiscalização de Estabelecimentos TIC Ticket TID Título Descontado TRA Transferência TRAV Transferência à Vista TRLAV Licenciamento TX Taxa VIST A Vista VOU Voucher WSITE Website Listagem completa dispon\"ivel na API: /api/v1/ger"},"nfRelacionada":{"type":"object","properties":{"cChaveRef":{"type":"string","description":"Chave da NF-e (ou NFC-e ou SAT) Relacionada."},"nNFRef":{"type":"string","description":"Número da Nota Fiscal Nota Fiscal Relacionada Modelo 1/1A"},"cSerieRef":{"type":"string","description":"Série da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A"},"dtEmissaoRef":{"type":"string","description":"Data de emissão da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A"},"cnpjEmitRef":{"type":"string","description":"CNPJ da Emitente da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A"},"cUfRef":{"type":"string","description":"Estado do Emitente da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A"},"nNfPR":{"type":"string","description":"Número da Nota Fiscal relacionada do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural"},"cSeriePR":{"type":"string","description":"Série da NF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural"},"dtEmissaoPR":{"type":"string","description":"Data de emissão da NF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural"},"cnpjPR":{"type":"string","description":"CNPJ/CPF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural"},"InscrEstPR":{"type":"string","description":"Inscrição Estadual do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural"},"cUfPR":{"type":"string","description":"Estado do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural"},"nCOORef":{"type":"string","description":"Número do COO - Contador de Ordem de Operação. Cupom Fiscal Relacionado"},"nECFRef":{"type":"string","description":"Número de Ordem Sequencial do ECF."},"indPresenca":{"type":"string","description":"Indicador de Presença da Operação. 1 - Operação presencial. 2 - Operação não presencial, pela Internet. 3 - Operação não presencial, Teleatendimento. 4 - NFC-e em operação com entrega a domicílio. 5 - Operação presencial, fora do estabelecimento. 9 - Operação não presencial, outros. Se não informado, utilizaremos automaticamente o \"9 - Outros\". Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"indIntermediario":{"type":"string","description":"Indicador de Intermediador. Esta informação deverá ser enviada quando se tratar de uma operação não presencial. Opções disponíveis: 0=Operação sem intermediador(em site ou plataforma própria) 1=Operação em site ou plataforma de terceiros(intermediadores/marketplace) Se não informado, utilizaremos automaticamente a opção \"0-Operação sem intermediador(em site ou plataforma própria)\". Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cnpjIntermediario":{"type":"string","description":"CNPJ do Intermediador. Preencimento obrigatório caso o Indicador de Intermediador seja igual a opção \"1-Operação em site ou plataforma de terceiros(intermediadores/marketplace)\". Este campo representa o CNPJ do Intermediador da Transação. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"identIntermediario":{"type":"string","description":"Identificação no Intermediador. Este identificador pode ser o nome do usuário ou identificação do perfil do vendedor no site do intermediador. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"nrProdutorRural":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","description":"Ação a ser realizada no item na alteração. Pode ser: \"I\" - Incluir o item. \"E\" - Excluir o item."},"nrNumero":{"type":"string","description":"Número da NF relacionada"},"nrSerie":{"type":"string","description":"Série da NF relacionada"},"nrDtEmissao":{"type":"string","description":"Data de emissão da NF relacionada"},"nrCnpjCpf":{"type":"string","description":"CNPJ/CPF do emitente da NF relacionada"},"nrIE":{"type":"string","description":"Inscrição Estadual do emitente da NF relacionada"},"nrUF":{"type":"string","description":"Unidade federativa do emitente da NF relacionada"}}},"description":"Outras notas de produtor rural relacionadas"},"nrNF":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","description":"Ação a ser realizada no item na alteração. Pode ser: \"I\" - Incluir o item. \"E\" - Excluir o item."},"nrChave":{"type":"string","description":"Chave da NF-e, NFC-e ou SAT relacionada"}}},"description":"Outras NF-e, NFC-e ou SAT relacionadas"},"nrCupomFiscal":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","description":"Ação a ser realizada no item na alteração. Pode ser: \"I\" - Incluir o item. \"E\" - Excluir o item."},"nrCOO":{"type":"string","description":"Contador de Ordem de Operação (COO)"},"nrNumeroECF":{"type":"string","description":"Número do ECF"}}},"description":"Outros cupons fiscais relacionados"},"nrModelo1_1A":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","description":"Ação a ser realizada no item na alteração. Pode ser: \"I\" - Incluir o item. \"E\" - Excluir o item."},"nrNumero":{"type":"string","description":"Número da NF relacionada"},"nrSerie":{"type":"string","description":"Série da NF relacionada"},"nrDtEmissao":{"type":"string","description":"Data de emissão da NF relacionada"},"nrCnpjCpf":{"type":"string","description":"CNPJ/CPF do emitente da NF relacionada"},"nrUF":{"type":"string","description":"Unidade federativa do emitente da NF relacionada"}}},"description":"Outras notas modelo 1/1A relacionadas"},"cSigNFRef":{"type":"string","description":"Manter o sigilo da NF-e referenciada. Preencher com \"S\" ou \"N\". Default \"N\""}},"description":"Detalhes da NF referenciada."},"nsu":{"type":"string","description":"Número Sequencial Único NSU - Para identificar vendas por cartões ou TransactionID TID - Para identificar vendas de comercio eletrônico. Caso informado na estrutura \"informacoes_adicionais\" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura \"parcela\"."}},"description":"Dados da Aba \"Informações Adicionais\" do Pedido de Venda."},"lista_parcelas":{"type":"object","properties":{"parcela":{"type":"array","items":{"type":"object","properties":{"numero_parcela":{"type":"integer","description":"Número da Parcela. Informação localizada na Aba \"Parcelas\" do Pedido de Venda."},"valor":{"type":"decimal","description":"Valor da Parcela. Informação localizada na Aba \"Parcelas\" do Pedido de Venda."},"percentual":{"type":"decimal","description":"Percentual da Parcela. Informação localizada na Aba \"Parcelas\" do Pedido de Venda."},"data_vencimento":{"type":"string","description":"Data de Vencimento da Parcela. Informação localizada na Aba \"Parcelas\" do Pedido de Venda."},"quantidade_dias":{"type":"integer","description":"Quantidade de dias até o vencimento da parcela. Informação localizada na Aba \"Parcelas\" do Pedido de Venda."},"tipo_documento":{"type":"string","description":"Tipo de Documento. Informação localizada na Aba \"Parcelas\" do Pedido de Venda. Pode ser: 13S 13o. Salário 99999 Outros ACO Acordo ACOB Acordo - Boleto ACOT Acordo - Transferência ADI Adiantamento ANT Antecipação APL Aplicação APO Apólice APOR Aporte ASS Assinatura BIL Bilhete BOL Boleto BOLV Boleto à Vista BONUS Bonus CAP Capitalização CART Carteira CF Cupom Fiscal CHD Cheque Devolvido CHP Cheque Pré CHQ Cheque CHT Cheque de Terceiros CNT Crédito em Conta COB Cobrança COM Comissão CON Convênios CONC Cobrança de Concessionária COND Condicional CONS Consignado CONSO Consórcio CRC Cartão de Crédito CRD Cartão de Débito CRE Crediário CRP Cartão Pré-Pago CRT Cartão CRTO Cartório CTE CT-e CTR Contrato CUSJ Custos Judiciais DACTE DACTE DAE DAE DAJE DAJE DAM DAM DANFE DANFE DAR DAR DARE DARE DARJ DARJ DARM DARM DAS DAS DDA DDA DEB Débito em Conta DEBA Débito Automático DEP Depósito DEV Devolução DFE Documento Fiscal Equivalente DIN Dinheiro DLC Distribuição de Lucros DNF Documento não fiscal DNFSE DANFSE DOA Doação DOC DOC DPVAT DPVAT DRF DARF DUA DUA DUAM DUAM DUP Duplicata EMP Empréstimo ENC Encargos ETAR Estorno de Tarifa FAT Fatura FER Férias FIA Fiado FIN Financiamento FPGT Folha de Pagamento GAR Garantia GARE GARE GNRE GNRE GPS GPS GRCS GRCS GRCSU GRCSU GRF Guia de Recolhimento do FGTS GRU GRU GUIA Guia de Recolhimento HOL Holerite IMP Imposto INV Invoice IPTU IPTU IPVA IPVA JUROS Juros Limite MED Medição MULTA Multas MUTUO Mútuo NC Nota de Crédito ND Nota de Débito NF Nota Fiscal NF3E Nota Fiscal de Energia Elétrica Eletrônica NFA Nota Fiscal de Abastecimento NFC Nota Fiscal de Consumidor NFCE Nota Fiscal de Consumidor Eletrônica NFD Nota Fiscal de Devolução NFE Nota Fiscal Eletrônica NFEE Nota Fiscal Energia Elétrica NFS Nota Fiscal de Serviço NFST Nota Fiscal de Telecomunicações NFSTM Nota Fiscal de Serviço Tomado PDD PDD PED Pedido PEN Pensão Alimentícia PER Permuta PIX Pix PROF Proforma Invoice PROL Pro-Labore PROT Protesto PROV Provisão REC Recibo REE Reembolso REND Rendimentos RES Resgate RET Rescisão Trabalhista RPA RPA SAN Sangria SAQ Saque SUP Suprimento TAR Tarifa TED TED TFE Taxa de Fiscalização de Estabelecimentos TIC Ticket TID Título Descontado TRA Transferência TRAV Transferência à Vista TRLAV Licenciamento TX Taxa VIST A Vista VOU Voucher WSITE Website Listagem completa dispon\"ivel na API: /api/v1/ger"},"meio_pagamento":{"type":"string","description":"Meio de Pagamento - Utilizado apenas para emissão de NF-e (campo \"tPag\" do XML). Esse campo indica como a parcela da nota será paga. Informação localizada na Aba \"Parcelas\" do Pedido de Venda. Caso informado na estrutura \"informacoes_adicionais\" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura \"parcela\". Pode ser: 01 Dinheiro 02 Cheque 03 Cartão de Crédito 04 Cartão de Débito 05 Crédito Loja 10 Vale Alimentação 11 Vale Refeição 12 Vale Presente 13 Vale Combustível 15 Boleto Bancário 16 Depósito Bancário 17 Pagamento Instantâneo (PIX) 18 Transferência bancária, Carteira Digital 19 Programa de fidelidade, Cashback, Crédito Virtual. 90 Sem Pagamento 99 Outros Listagem completa disponível na API: /api/v1/geral/meiospagamento/"},"descr_meio_pagamento":{"type":"string","description":"Descrição do Meio de Pagamento - Utilizado apenas para emissão de NF-e (campo \"xPag\" do XML). Esse campo precisa ser informado quando a tag \"meio_pagamento\" for igual a 99 (Outros). Informação localizada na Aba \"Parcelas\" do Pedido de Venda. Caso informado na estrutura \"informacoes_adicionais\" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura \"parcela\"."},"nsu":{"type":"string","description":"Número Sequencial Único NSU - Para identificar vendas por cartões ou TransactionID TID - Para identificar vendas de comercio eletrônico. Caso informado na estrutura \"informacoes_adicionais\" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura \"parcela\"."},"nao_gerar_boleto":{"type":"string","description":"Indica se o boleto não deve ser gerado para a(s) parcela(s) ao emitir a nota fiscal. Informe \"S\" para não gerar o boleto. O padrão é \"N\". Quando informado dentro do tag \"cabecalho\", aplica-se como valor padrão para todas as parcelas, caso não seja especificado individualmente em cada uma. Quando informado dentro da tag \"lista_parcelas\", aplica-se individualmente para cada parcela (tem prioridade sobre o valor informado no cabeçalho). Informação localizada na Aba \"Parcelas\" do Pedido de Venda."},"parcela_adiantamento":{"type":"string","description":"Está é uma parcela de Adiantamento do Cliente. Informe \"S\" para indicar que é uma parcela de adiantamento. O padrão é \"N\". Informação localizada na Aba \"Parcelas\" do Pedido de Venda."},"categoria_adiantamento":{"type":"string","description":"Código da Categoria para o Adiantamento. Será utilizada na conta a receber que representa o adiantamento desta parcela. Informação localizada na Aba \"Parcelas\" do Pedido de Venda."},"conta_corrente_adiantamento":{"type":"integer","description":"Conta Corrente de Adiantamento. Informação localizada na Aba \"Parcelas\" do Pedido de Venda."},"bandeira":{"type":"string","description":"Código da Bandeira da operadora de cartão."},"cnpj_fin":{"type":"string","description":"Informar o CNPJ da instituição de pagamento, adquirente ou subadquirente."}}},"description":"Dados da parcela."}},"description":"Dados da Aba \"Parcelas\" do Pedido de Venda. Para todos os outros códigos o preenchimento é automático - Não informar essa estrutura."},"observacoes":{"type":"object","properties":{"obs_venda":{"type":"string","description":"Observações da venda (elas não serão exibidas na Nota Fiscal). Informação localizada na Aba \"Observações\" do Pedido de Venda."}},"description":"Dados da Aba \"Observações\" do Pedido de Venda."},"det":{"type":"array","items":{"type":"object","properties":{"ide":{"type":"object","properties":{"codigo_item_integracao":{"type":"string","description":"Código de Integração do Item do Pedido de Venda. Informe a identificação do Item do Pedido de Venda. Caso você não tenha essa informação no seu aplicativo, informe o número sequencial de cada item do pedido. Informa de 1 a 199."},"codigo_item":{"type":"integer","description":"ID do Item do Pedido."},"simples_nacional":{"type":"string","description":"Indica que a empresa é Optante pelo Simples Nacional. Informar \"S\" ou \"N\"."},"acao_item":{"type":"string","description":"Ação para o item. Pode ser: \"E\" - para excluir um item."},"id_ordem_producao":{"type":"integer","description":"Id da Ordem de Produção. Campo disponível apenas para consulta. Não deve ser informado na Inclusão ou Alteração."},"regra_impostos":{"type":"integer","description":"DEPRECATED"}},"description":"Identificação do Item do Pedido de Vendas."},"produto":{"type":"object","properties":{"codigo_produto":{"type":"integer","description":"ID do Produto. Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs. Utilize a tag \"codigo_produto\" do método \"ListarProdutos\" da API http://app.omie.com.br/api/v1/geral/produtos/ para obter essa informação."},"codigo_produto_integracao":{"type":"string","description":"Código de integração do Produto. Esse campo deve ser informado apenas se você incluiu o produto via API e informou um código de integração para o produto. Do contrário, informe sempre a tag \"codigo_produto\"."},"codigo":{"type":"string","description":"Código do Produto exibido na tela do Pedido de Vendas."},"descricao":{"type":"string","description":"Descrição do Produto."},"cfop":{"type":"string","description":"CFOP - Código Fiscal de Operações e Prestações. Utilize a tag \"nCodigo\" do método \"ListarCFOP\" da API http://app.omie.com.br/api/v1/produtos/cfop/ para obter essa informação."},"ncm":{"type":"string","description":"NCM - Nomenclatura Comum do Mercosul Utilize a tag \"cCodigo\" do método \"ListarNCM\" da API http://app.omie.com.br/api/v1/produtos/ncm/ para obter essa informação."},"ean":{"type":"string","description":"EAN - European Article Number"},"unidade":{"type":"string","description":"Unidade. Utilize a tag \"codigo\" do método \"ListarUnidades\" da API http://app.omie.com.br/api/v1/geral/unidade/ para obter essa informação."},"quantidade":{"type":"decimal","description":"Quantidade No método de devolução de pedido: Caso não seja preenchida será feita a devolução integral do produto."},"valor_unitario":{"type":"decimal","description":"Valor Únitário"},"codigo_tabela_preco":{"type":"integer","description":"Código da tabela de preço. (Interno, utilizado apenas na integração via API, não é exibido na tela). Deve ser informada opcionalmente, caso a tabela de preços esteja configurada no Omie."},"valor_mercadoria":{"type":"decimal","description":"Valor da Mercadoria"},"tipo_desconto":{"type":"string","description":"Tipo de Desconto."},"percentual_desconto":{"type":"decimal","description":"Percentual de Desconto."},"valor_desconto":{"type":"decimal","description":"Valor do Desconto"},"valor_deducao":{"type":"decimal","description":"Valor da Dedução"},"valor_icms_desonerado":{"type":"decimal","description":"Valor do ICMS desonerado"},"motivo_icms_desonerado":{"type":"string","description":"Código do Motivo de desoneração do ICMS Códigos válidos para desoneração do ICMS 01 Táxi 03 Produtor Agropecuário 04 Frotista/Locadora 05 Diplomático/Consular 06 Utilitários e Motocicletas da Amazônia Ocidental e Áreas de Livre Comércio (Resolução 714/88 e 790/94 ? CONTRAN e suas alterações) 07 SUFRAMA 08 Venda a Órgão Público 09 Outros. (NT 2011/004) 10 Deficiente Condutor (Convênio ICMS 38/12) 11 Deficiente Não Condutor (Convênio ICMS 38/12) 16 Olimpíadas Rio 2016 90 Solicitado pelo Fisco"},"valor_total":{"type":"decimal","description":"Valor Total."},"indicador_escala":{"type":"string","description":"Indicador de Produção em Escala Relevante. Pode ser: \"S\" para Produzido em Escala Relevante. \"N\" para Produzido em Escala NÃO Relevante."},"cnpj_fabricante":{"type":"string","description":"CNPJ do Fabricante da Mercadoria."},"kit":{"type":"string","description":"Indica se o produto é um kit"},"componente_kit":{"type":"string","description":"Indica se o produto é um componente de um kit"},"codigo_item_kit":{"type":"integer","description":"ID do Item do kit (pai) que o componente pertence"},"reservado":{"type":"string","description":"(S/N) Indica se o estoque do produto será reservado."}},"description":"Identificação do Produto do Item do Pedido de Vendas."},"observacao":{"type":"object","properties":{"obs_item":{"type":"string","description":"Observações do item (elas não serão exibidas na Nota Fisca, mas serão impressas no pedido de vendal). Informação localizada na Aba \"Observações\" do Item do Pedido de Venda."}},"description":"Dados da aba \"Observações\" do Item do Pedido de Vendas."},"inf_adic":{"type":"object","properties":{"peso_liquido":{"type":"decimal","description":"Peso Líquido (Kg)."},"peso_bruto":{"type":"decimal","description":"Peso Bruto (Kg)."},"numero_pedido_compra":{"type":"string","description":"Número do Pedido de Compra."},"item_pedido_compra":{"type":"integer","description":"Item do Pedido de Compra."},"dados_adicionais_item":{"type":"string","description":"Informações para a Nota Fiscal."},"nao_movimentar_estoque":{"type":"string","description":"Não gerar a saída de estoque deste item ao emitir NF-e. Informar \"S\" ou \"N\". (informe \"S\" para ativar essa opção)."},"nao_gerar_financeiro":{"type":"string","description":"Não gerar conta a receber para este item. Informar \"S\" ou \"N\". (Informe \"S\" para ativar essa opção)."},"codigo_categoria_item":{"type":"string","description":"Código da Categoria do item."},"codigo_beneficio_fiscal":{"type":"string","description":"Código do Benefício Fiscal."},"numero_fci":{"type":"string","description":"Número da FCI (Ficha de Conteúdo de Importação)"},"codigo_local_estoque":{"type":"integer","description":"Código do Local do Estoque."},"codigo_cenario_impostos_item":{"type":"integer","description":"Código do Cenário de Impostos."},"nao_somar_total":{"type":"string","description":"Não somar este item no total da NF-e"},"numero_recopi":{"type":"string","description":"Número do registro gerado pelo sistema RECOPI Nacional (Reconhecimento e Controle das Operações com Papel Imune)."}},"description":"Dados da aba \"Informações Adicionais\" do Item do Pedido de Vendas."},"imposto":{"type":"object","properties":{"icms_sn":{"type":"object","properties":{"cod_sit_trib_icms_sn":{"type":"string"},"origem_icms_sn":{"type":"string"},"aliq_icms_sn":{"type":"decimal"},"valor_credito_icms_sn":{"type":"decimal"},"base_icms_sn":{"type":"decimal"},"valor_icms_sn":{"type":"decimal"}},"description":"ICMS - Simples Nacional."},"icms":{"type":"object","properties":{"cod_sit_trib_icms":{"type":"string"},"origem_icms":{"type":"string"},"modalidade_icms":{"type":"string"},"perc_red_base_icms":{"type":"decimal"},"base_icms":{"type":"decimal"},"aliq_icms":{"type":"decimal"},"valor_icms":{"type":"decimal"},"perc_fcp_icms":{"type":"decimal","description":"Percentual do FCP - Fundo de Combate a Pobreza do ICMS."},"base_fcp_icms":{"type":"decimal","description":"Base de Cálculo do FCP - Fundo de Combate a Pobreza do ICMS."},"valor_fcp_icms":{"type":"decimal","description":"Valor do FCP - Fundo de Combate a Pobreza do ICMS."}},"description":"ICMS"},"icms_st":{"type":"object","properties":{"cod_sit_trib_icms_st":{"type":"string"},"modalidade_icms_st":{"type":"string"},"perc_red_base_icms_st":{"type":"decimal"},"base_icms_st":{"type":"decimal"},"aliq_icms_st":{"type":"decimal"},"margem_icms_st":{"type":"decimal"},"valor_icms_st":{"type":"decimal"},"aliq_icms_opprop":{"type":"decimal","description":"Alíquota de ICMS Operação Própria."},"perc_red_base_icms_op":{"type":"decimal","description":"Percentual de redução de base de cálculo de Icms Operação Própria."},"cest":{"type":"string","description":"CEST - Código Especificador da Substituíção Tributária."},"perc_fcp_icms_st":{"type":"decimal","description":"Percentual do FCP - Fundo de Combate a Pobreza do ICMS ST."},"base_fcp_icms_st":{"type":"decimal","description":"Base de Cálculo do FCP - Fundo de Combate a Pobreza do ICMS ST."},"valor_fcp_icms_st":{"type":"decimal","description":"Valor do FCP - Fundo de Combate a Pobreza do ICMS ST."}},"description":"ICMS - Substituição Tributária."},"icms_ie":{"type":"object","properties":{"base_icms_uf_destino":{"type":"decimal","description":"BC do ICMS na UF de Destino"},"aliq_icms_FCP":{"type":"decimal","description":"Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de Destino"},"aliq_interna_uf_destino":{"type":"decimal","description":"Alíquota Interna da UF de Destino"},"aliq_interestadual":{"type":"decimal","description":"Alíquota Interestadual das UFs Envolvidas"},"aliq_partilha_icms":{"type":"decimal","description":"Percentual Provisório de Partilha do ICMS Interestadual"},"valor_fcp_icms_inter":{"type":"decimal","description":"Valor do fundo de combate a pobreza."},"valor_icms_uf_dest":{"type":"decimal","description":"Valor do ICMS - UF Destino"},"valor_icms_uf_remet":{"type":"decimal","description":"Valor do ICMS - UF Remetente"}},"description":"ICMS Interestadual."},"icms_efet":{"type":"object","properties":{"cod_sit_trib_icms_efet":{"type":"string"},"origem_icms_efet":{"type":"string"},"modalidade_icms_efet":{"type":"string"},"perc_red_base_icms_efet":{"type":"decimal"},"base_icms_efet":{"type":"decimal"},"aliq_icms_efet":{"type":"decimal"},"valor_icms_efet":{"type":"decimal"}},"description":"ICMS efetivo. Não informar na Inclusão e Alteração. Utilizado somente na Consulta e Listagem"},"ipi":{"type":"object","properties":{"cod_sit_trib_ipi":{"type":"string"},"tipo_calculo_ipi":{"type":"string"},"enquadramento_ipi":{"type":"string","description":"Enquadramento do IPI"},"base_ipi":{"type":"decimal"},"aliq_ipi":{"type":"decimal"},"qtde_unid_trib_ipi":{"type":"decimal"},"valor_unid_trib_ipi":{"type":"decimal"},"valor_ipi":{"type":"decimal"}},"description":"IPI."},"pis_padrao":{"type":"object","properties":{"cod_sit_trib_pis":{"type":"string"},"tipo_calculo_pis":{"type":"string"},"base_pis":{"type":"decimal"},"aliq_pis":{"type":"decimal"},"qtde_unid_trib_pis":{"type":"decimal"},"valor_unid_trib_pis":{"type":"decimal"},"valor_pis":{"type":"decimal"}},"description":"PIS."},"pis_st":{"type":"object","properties":{"cod_sit_trib_pis_st":{"type":"string"},"tipo_calculo_pis_st":{"type":"string"},"base_pis_st":{"type":"decimal"},"aliq_pis_st":{"type":"decimal"},"qtde_unid_trib_pis_st":{"type":"decimal"},"valor_unid_trib_pis_st":{"type":"decimal"},"margem_pis_st":{"type":"decimal"},"valor_pis_st":{"type":"decimal"}},"description":"PIS - Substituíção Tributária."},"cofins_padrao":{"type":"object","properties":{"cod_sit_trib_cofins":{"type":"string"},"tipo_calculo_cofins":{"type":"string"},"base_cofins":{"type":"decimal"},"aliq_cofins":{"type":"decimal"},"qtde_unid_trib_cofins":{"type":"decimal"},"valor_unid_trib_cofins":{"type":"decimal"},"valor_cofins":{"type":"decimal"}},"description":"COFINS."},"cofins_st":{"type":"object","properties":{"cod_sit_trib_cofins_st":{"type":"string"},"tipo_calculo_cofins_st":{"type":"string"},"base_cofins_st":{"type":"decimal"},"aliq_cofins_st":{"type":"decimal"},"qtde_unid_trib_cofins_st":{"type":"decimal"},"valor_unid_trib_cofins_st":{"type":"decimal"},"margem_cofins_st":{"type":"decimal"},"valor_cofins_st":{"type":"decimal"}},"description":"COFINS - Substituição Tributária."},"inss":{"type":"object","properties":{"aliq_inss":{"type":"decimal"},"valor_inss":{"type":"decimal"}},"description":"INSS."},"csll":{"type":"object","properties":{"aliq_csll":{"type":"decimal"},"valor_csll":{"type":"decimal"}},"description":"CSLL."},"irrf":{"type":"object","properties":{"aliq_irrf":{"type":"decimal"},"valor_irrf":{"type":"decimal"}},"description":"IRRF."},"iss":{"type":"object","properties":{"base_iss":{"type":"decimal"},"aliq_iss":{"type":"decimal"},"valor_iss":{"type":"decimal"},"retem_iss":{"type":"string"}},"description":"ISS."},"ibs_cbs":{"type":"object","properties":{"cst_ibs_cbs":{"type":"string","description":"Código de Situação Tributária do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"class_trib":{"type":"string","description":"Código de Classificação Tributária do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"base_ibs_cbs":{"type":"decimal","description":"Base de cálculo do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."}}},"ibs":{"type":"object","properties":{"aliquota_ibs_uf":{"type":"decimal","description":"Alíquota do IBS de competência das UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"perc_dif_ibs_uf":{"type":"decimal","description":"Percentual do Diferimento - IBS UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"perc_red_ibs_uf":{"type":"decimal","description":"Percentual da redução de alíquota - IBS UF. Não deve ser informado na Inclusão/Alteração. Campos disponíveis apenas para consulta. Para os métodos de inclusão e alteração, esses campos serão alimentados conforme o cenário fiscal."},"valor_dif_ibs_uf":{"type":"decimal","description":"Valor do Diferimento - IBS UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_ibs_uf":{"type":"decimal","description":"Valor do IBS de competência da UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"aliquota_ibs_mu":{"type":"decimal","description":"Alíquota do IBS de competência do Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"perc_dif_ibs_mu":{"type":"decimal","description":"Percentual do diferimento - UBS Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"perc_red_ibs_mu":{"type":"decimal","description":"Percentual da redução de alíquota - IBS Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_dif_ibs_mu":{"type":"decimal","description":"Valor do Diferimento - IBS Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_ibs_mu":{"type":"decimal","description":"Valor do IBS de competência do Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_ibs":{"type":"decimal","description":"Valor total do IBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."}}},"cbs":{"type":"object","properties":{"aliquota_cbs":{"type":"decimal","description":"Alíquota da CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"perc_dif_cbs":{"type":"decimal","description":"Percentual do diferimento - CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"perc_red_cbs":{"type":"decimal","description":"Percentual da redução de alíquota - CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_dif_cbs":{"type":"decimal","description":"Valor do diferimento - CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_cbs":{"type":"decimal","description":"Valor da CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."}}},"trib_reg":{"type":"object","properties":{"cst_reg_ibs_cst":{"type":"string","description":"Código da Situação Tributária do IBS e CBS (Tributação Regular). Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"class_trib_reg":{"type":"string","description":"Código de Classificação Tributária do IBS e CBS (Tributação Regular). Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"aliquota_reg_ibs_uf":{"type":"decimal","description":"Valor da alíquota do IBS da UF na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"aliquota_reg_ibs_mu":{"type":"decimal","description":"Valor da alíquota do IBS do Município na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"aliquota_reg_cbs":{"type":"decimal","description":"Valor da alíquota da CBS na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_reg_ibs_uf":{"type":"decimal","description":"Valor do Tributo do IBS da UF na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_reg_ibs_mu":{"type":"decimal","description":"Valor do Tributo do IBS do Município na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_reg_cbs":{"type":"decimal","description":"Valor do Tributo da CBS na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."}}}},"description":"Informações referentes aos impostos do Item do Pedido de Vendas. Essa estrutura deve ser preenchida quando os dados dos impostos devem ser respeitados tais como foram enviados na API. Caso essa estrutura não seja enviada, o Omie irá identificar a regra de imposto que melhor se ajusta as condições da venda realizada. Para utilizar essa opção esteja seguro de que as regras e cenários de impostos estejam cadastrados corretamente no Omie. As infomações preenchidas serão decorrentes dos dados configurados."},"rastreabilidade":{"type":"object","properties":{"numeroLote":{"type":"string","description":"Número do Lote"},"qtdeProdutoLote":{"type":"decimal","description":"Quantidade de Produto"},"dataFabricacaoLote":{"type":"string","description":"Data de Fabricação/Produção"},"dataValidadeLote":{"type":"string","description":"Data de Validade"},"codigoAgregacaoLote":{"type":"string","description":"Código de Agregação"}},"description":"Dados da rastreabilidade do produto."},"combustivel":{"type":"object","properties":{"cCodigoANP":{"type":"string","description":"Código de Produto da ANP."},"cDescrANP":{"type":"string","description":"Descrição do Produto conforme ANP."},"cCODIF":{"type":"string","description":"Registro do CODIF."},"nPercGLP":{"type":"decimal","description":"Percentual de GLP Derivado do Petróleo."},"nPercGasNacional":{"type":"decimal","description":"Percentual de Gás Natural Nacional."},"nPercGasImportado":{"type":"decimal","description":"Percentual de Gás Natural Importado."},"nValorPartida":{"type":"decimal","description":"Valor de Partida."},"nQtdeFatTempAmb":{"type":"decimal","description":"Quantidade Faturada à Temperatura Ambiente."},"cUFConsumoComb":{"type":"string","description":"UF de Consumo."},"nBC_CIDE":{"type":"decimal","description":"Base de Cálculo (em quantidade) da CIDE."},"nAliquota_CIDE":{"type":"decimal","description":"Valor da Alíquota em Reais da CIDE."},"nValor_CIDE":{"type":"decimal","description":"Valor da CIDE."},"nBC_UFRem":{"type":"decimal","description":"Base de Cálculo da UF Remetente. Base de Cálculo do ICMS retido anteriormente por Substituição Tributária."},"nValorUFRem":{"type":"decimal","description":"Valor da UF Remetente. Alíquota do ICMS retido anteriormente por Substituição Tributária."},"nBC_UFDest":{"type":"decimal","description":"Base de Cálculo da UF Destino. Base de Cálculo do ICMS ST da UF Destino."},"nValorUFDest":{"type":"decimal","description":"Valor da UF Destino. Base de Cálculo do ICMS ST da UF Destino."}},"description":"Detalhamento específico de Combustível."},"tributavel":{"type":"object","properties":{"cUnidTrib":{"type":"string","description":"Unidade tributável do Item."},"nQuantTrib":{"type":"decimal","description":"Quantidade tributável do item."},"nValorTrib":{"type":"decimal","description":"Valor tributável do item."},"cEanTrib":{"type":"string","description":"código EAN tributável do item."}},"description":"Unidade, Quantidade, Valor e EAN tributáveis do item do pedido."},"lote_validade":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","description":"Id do Lote do produto. Obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.."},"nQtdLote":{"type":"decimal","description":"Informe aqui a quantidade do Lote para o produto. É obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações."}}},"description":"Informações referentes ao lote e validade do produto. A tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes \"manualmente\" por API."}}},"description":"Dados da Aba \"Itens da Venda\" do Pedido de Venda."},"market_place":{"type":"object","properties":{"nTaxa":{"type":"decimal","description":"Valor da taxa do Market Place."},"nEnvio":{"type":"decimal","description":"Valor do envio do Market Place."}},"description":"Dados para o Market Place."},"total_pedido":{"type":"object","properties":{"base_calculo_icms":{"type":"decimal","description":"Base de Cálculo do ICMS."},"base_calculo_st":{"type":"decimal","description":"Base de cálculo da substituição tributária."},"valor_pis":{"type":"decimal","description":"Valor do PIS."},"valor_cofins":{"type":"decimal","description":"Valor do cofins."},"valor_csll":{"type":"decimal","description":"Valor da CSLL."},"valor_icms":{"type":"decimal","description":"Valor total do ICMS."},"valor_st":{"type":"decimal","description":"Valor total da ST."},"valor_inss":{"type":"decimal","description":"Valor do INSS."},"valor_IPI":{"type":"decimal","description":"Valor do IPI."},"valor_ir":{"type":"decimal","description":"Valor do IR. .Preenchimento automático - Não informar."},"valor_iss":{"type":"decimal","description":"Valor do ISS."},"valor_deducoes":{"type":"decimal","description":"Valor das deduções."},"valor_descontos":{"type":"decimal","description":"Valor dos descontos."},"valor_mercadorias":{"type":"decimal","description":"valor das mercadorias."},"valor_total_pedido":{"type":"decimal","description":"Valor total do pedido."},"base_ibs_cbs":{"type":"decimal","description":"Valor total da base de cálculo do IBS e da CBS."},"valor_dif_ibs_uf":{"type":"decimal","description":"Valor total do diferimento do IBS UF."},"valor_ibs_uf":{"type":"decimal","description":"Valor total do IBS da UF."},"valor_dif_ibs_mu":{"type":"decimal","description":"Valor total do diferimento do IBS do município."},"valor_ibs_mu":{"type":"decimal","description":"Valor total do IBS do município."},"valor_ibs":{"type":"decimal","description":"Valor total do IBS."},"valor_dif_cbs":{"type":"decimal","description":"Valor total do diferimento da CBS."},"valor_cbs":{"type":"decimal","description":"Valor total da CBS."},"valor_tot_ibs_cbs_is":{"type":"decimal","description":"Total da NF-e com IBS/CBS/IS."}},"description":"Valores totais do pedido."},"infoCadastro":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão."},"hInc":{"type":"string","description":"Hora da Inclusão."},"uInc":{"type":"string","description":"Usuário da Inclusão."},"dAlt":{"type":"string","description":"Data da Alteração."},"hAlt":{"type":"string","description":"Hora da Alteração."},"uAlt":{"type":"string","description":"Usuário da Alteração."},"dCan":{"type":"string","description":"Data da Cancelamento."},"hCan":{"type":"string","description":"Hora da Cancelamento."},"uCan":{"type":"string","description":"Usuário da Cancelamento."},"cancelado":{"type":"string","description":"Indica se o pedido foi cancelado."},"dFat":{"type":"string","description":"Data de Faturamento."},"hFat":{"type":"string","description":"Hora de faturamento."},"uFat":{"type":"string","description":"Usuário que realizou o faturamento."},"faturado":{"type":"string","description":"Indica se o pedido está faturado."},"denegado":{"type":"string","description":"Indica se o pedido foi denegado."},"autorizado":{"type":"string","description":"Indica se o pedido foi autorizado."},"devolvido":{"type":"string","description":"Indica se o pedido foi devolvido."},"devolvido_parcial":{"type":"string","description":"Indica se o pedido foi devolvido parcialmente."},"cImpAPI":{"type":"string","description":"Importado pela API."}},"description":"Informações complementares do pedido."},"exportacao":{"type":"object","properties":{"nao_exportacao":{"type":"string","description":"O cliente é estrangeiro, mas na verdade não se trata de uma exportação"},"local_embarque":{"type":"string","description":"Local de Embarque (ou de transposição de fronteira)"},"uf_embarque":{"type":"string","description":"UF do Local de Embarque"},"local_despacho":{"type":"string","description":"Local de Despacho"}},"description":"Dados da exportacao"},"lancamentos":{"type":"array","items":{"type":"object","properties":{"nSequencia":{"type":"integer","description":"Número da Sequencia. Para os itens da NF identifica qual o item do XML se refere. Para as parcelas da NF identifica o número da parcela. Para os lançamentos no Conta Corrente indentifica o lançamento que será gerado. Permite sequencial de 1 a 999."},"cNaturezaDocumento":{"type":"string","description":"Natureza do Documento. Pode ser: P - Pagar R - Receber Obrigatório na operação \"IncluirPedido\"; não é processado nas demais operações que reutilizam esta estrutura, como \"AlterarPedidoVenda\"."},"nValorDocumento":{"type":"decimal","description":"Valor do Documento. Obrigatório na operação \"IncluirPedido\"; não é processado nas demais operações que reutilizam esta estrutura, como \"AlterarPedidoVenda\"."},"dDataDocumento":{"type":"string","description":"Data do documento. Obrigatório na operação \"IncluirPedido\"; não é processado nas demais operações que reutilizam esta estrutura, como \"AlterarPedidoVenda\"."},"cTipoDocumento":{"type":"string","description":"Tipo de Documento. Lista de tipos de documentos em: /api/v1/geral/tiposdoc Obrigatório na operação \"IncluirPedido\"; não é processado nas demais operações que reutilizam esta estrutura, como \"AlterarPedidoVenda\"."},"cCategoria":{"type":"string","description":"Código da Categoria."},"nContaCorrente":{"type":"integer","description":"Id da Conta Corrente."},"cOrigem":{"type":"string","description":"Origem da Nota Fiscal. Códigos Disponíveis: API - Importado via API. Obrigatório na operação \"IncluirPedido\"; não é processado nas demais operações que reutilizam esta estrutura, como \"AlterarPedidoVenda\"."},"cObs":{"type":"string","description":"Observações."},"nProjeto":{"type":"integer","description":"Id do projeto."},"nVendedor":{"type":"integer","description":"Id do Vendedor."}}},"description":"Lançamentos no Conta Corrente relacionados ao Pedido de Vendas taxas,entre outros)."},"agropecuario":{"type":"object","properties":{"cNumReceita":{"type":"string","description":"Número da receita ou receituário do agrotóxico/defensivo agrícola"},"cCpfResponsavel":{"type":"string","description":"CPF do responsá¡vel técnico legalmente habilitado"},"nTipoGuia":{"type":"integer","description":"Tipo da Guia 1 - Corresponde ao GTA 2 - Corresponde ao TTA 3 - Corresponde ao DTA 4 - Corresponde ao ATV 5 - Corresponde ao PTV 6 - Corresponde ao GTV 7 - Corresponde ao Guia Florestal (DOF, SisFlora - PA e MT, SIAM - MG)"},"cUFGuia":{"type":"string","description":"UF de emissão da Guia"},"cSerieGuia":{"type":"string","description":"Número de série da guia"},"nNumGuia":{"type":"integer","description":"Número da guia"}}}}},"description":"Cadastro de Pedido de Venda"}},"title":"ListarPedidos (retorno)"},"produtos_pedido_SimularImpostos":{"type":"object","title":"SimularImpostos","description":"Simula os impostos de um pedido de venda.","required":["call","param"],"properties":{"call":{"type":"string","enum":["SimularImpostos"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_cliente":{"type":"integer","maxLength":15,"description":"Código de identificação do cliente.\n\nUtilize a tag \"codigo_cliente_omie\" do método \"ListarClientes\" da API\n/api/v1/geral/clientes/\npara obter essa informação."},"cliente_simul":{"type":"object","properties":{"clientes_contribuinte":{"type":"string","maxLength":1,"description":"Indica que o Cliente é Contribuinte do ICMS\n\nInformar \"S\" ou \"N\".\n\nInformação localizada na Aba \"Inscrições CNAE e Outros\" do cadastro do Cliente."},"clientes_estado":{"type":"string","maxLength":2,"description":"Informação localizada na Aba \"Endereço\" do cadastro do Cliente.\n\nUtilize a tag \"cSigla\" do método \"ListarEstados\" da API\n/api/v1/geral/estados/\npara obter essa informação."},"cidades_codmunibge":{"type":"string","maxLength":7,"description":"Código do município conforme tabela do IBGE para simulação dos impostos"},"clientes_suframa":{"type":"string","maxLength":20,"description":"Inscrição SUFRAMA do cliente para simulação dos impostos.\n\nInformação localizada na Aba \"Inscrições CNAE e Outros\" do cadastro do Cliente"},"clientes_cnae":{"type":"string","maxLength":7,"description":"Informação localizada na Aba \"Inscrições CNAE e Outros\" do cadastro do Cliente para simulação dos impostos"},"tipo_atividade":{"type":"string","maxLength":1,"description":"Tipo da Atividade\n\nInformação localizada na Aba \"Inscrições CNAE e Outros\" do cadastro do Cliente.\n\nUtilize a tag \"cCodigo\" do método \"ListarTipoAtiv\" da API\nhttp://app.omie.com.br/api/v1/geral/tpativ/\npara obter essa informação."},"optante_simples_nacional":{"type":"string","maxLength":1,"description":"Indica se o Cliente / Fornecedor é Optante do Simples Nacional\n\nInformar \"S\" ou \"N\".\n\nInformação localizada na Aba \"Inscrições CNAE e Outros\" do cadastro do Cliente."}},"description":"Informações de cliente para simulação dos impostos."},"codigo_cliente_integracao":{"type":"string","maxLength":60,"description":"Código de Integração do Cliente\n\nEsse campo deve ser informado apenas se você incluiu o cliente via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag \"codigo_cliente\"."},"consumidor_final":{"type":"string","maxLength":1,"description":"Indicativo se a venda seria para consumidor final.\n\n\nInformar \"S\" ou \"N\".\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"impostos_embutidos":{"type":"string","maxLength":1},"frete_simul":{"type":"object","properties":{"valor_frete":{"type":"number","maxLength":18,"description":"Valor do Frete"},"valor_seguro":{"type":"number","maxLength":18,"description":"Valor do seguro para simulação de impostos."},"outras_despesas":{"type":"number","maxLength":18,"description":"Valor das outras despesas para simulação dos impostos"}},"description":"Dados da Aba \"Frete e Outras Despesas\" do Pedido de Venda para simulação dos impostos."},"uf_entrega":{"type":"string","maxLength":2,"description":"Estado onde ocorrerá a entrega do produto.\n\nSó preencher esse essa informação caso a entrega do produto não seja no mesmo endereço do cadastro do cliente."},"indPresenca":{"type":"string","maxLength":1,"description":"Indicador de Presença da Operação.\n\n\n1 - Operação presencial.\n2 - Operação não presencial, pela Internet.\n3 - Operação não presencial, Teleatendimento.\n4 - NFC-e em operação com entrega a domicílio.\n5 - Operação presencial, fora do estabelecimento.\n9 - Operação não presencial, outros.\n\nMesma informação da na Aba \"Informações Adicionais\" do Pedido de Venda."},"det_simul":{"type":"array","items":{"type":"object","properties":{"codigo_cenario_impostos_item":{"type":"integer","maxLength":15,"description":"Código do Cenário de Impostos."},"produto_simul":{"type":"object","properties":{"codigo_produto":{"type":"integer","maxLength":15,"description":"ID do Produto\n\n\nEsse campo não é exibido na tela do Pedido de Vendas.\nÉ uma informação interna, utilizada apenas nas APIs.\n\nUtilize a tag \"codigo_produto\" do método \"ListarProdutos\" da API\n/api/v1/geral/produtos/\npara obter essa informação."},"codigo_produto_integracao":{"type":"string","maxLength":60,"description":"Código de integração do Produto.\n\n\nEsse campo deve ser informado apenas se você incluiu o produto via API e informou um código de integração para o produto. Do contrário, informe sempre a tag \"codigo_produto\"."},"codigo_item_integracao":{"type":"string","maxLength":30,"description":"Código de Integração do Item do Pedido de Venda.\n\n\nInforme a identificação do Item do Pedido."},"quantidade":{"type":"number","maxLength":18,"description":"Quantidade do produto para simulação dos impostos."},"valor_unitario":{"type":"number","maxLength":18,"description":"Valor unitário para simulação dos impostos"},"valor_desconto":{"type":"number","maxLength":18,"description":"Valor do desconto do item, se houver, para ser considerado na simulação dos impostos."}},"required":["quantidade","valor_unitario"],"description":"Informações do produto para simulação dos impostos."}}},"description":"Dados do item do Pedido de Vendas para simulação dos impostos."}}}}},"example":{"call":"SimularImpostos","param":[{"codigo_cliente":0,"consumidor_final":"","frete_simul":{"valor_frete":0,"valor_seguro":0,"outras_despesas":0},"det_simul":[{"codigo_cenario_impostos_item":0,"produto_simul":{"codigo_produto":0,"quantidade":0,"valor_unitario":0,"valor_desconto":0}}]}]}},"produtos_pedido_SimularImpostos_retorno":{"type":"object","properties":{"codigo_cliente":{"type":"integer","description":"Código interno do cliente"},"codigo_cliente_integracao":{"type":"string","description":"Código de Integração do Cliente Esse campo deve ser informado apenas se você incluiu o cliente via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag \"codigo_cliente\"."},"consumidor_final":{"type":"string","description":"Indicação se a venda para é consumo final"},"frete_simul":{"type":"object","properties":{"valor_frete":{"type":"decimal","description":"Valor do Frete"},"valor_seguro":{"type":"decimal","description":"Valor do seguro para simulação de impostos."},"outras_despesas":{"type":"decimal","description":"Valor das outras despesas para simulação dos impostos"}},"description":"Dados da Aba \"Frete e Outras Despesas\" do Pedido de Venda para simulação dos impostos."},"uf_entrega":{"type":"string","description":"Estado onde ocorrerá a entrega do produto. Só preencher esse essa informação caso a entrega do produto não seja no mesmo endereço do cadastro do cliente."},"indPresenca":{"type":"string","description":"Indicador de Presença da Operação. 1 - Operação presencial. 2 - Operação não presencial, pela Internet. 3 - Operação não presencial, Teleatendimento. 4 - NFC-e em operação com entrega a domicílio. 5 - Operação presencial, fora do estabelecimento. 9 - Operação não presencial, outros. Mesma informação da na Aba \"Informações Adicionais\" do Pedido de Venda."},"det_simul_resp":{"type":"array","items":{"type":"object","properties":{"codigo_cenario_impostos_item":{"type":"integer","description":"Cenário de impostos do item para simulação"},"produto_simul_resp":{"type":"object","properties":{"codigo_produto":{"type":"integer","description":"ID do Produto Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs. Utilize a tag \"codigo_produto\" do método \"ListarProdutos\" da API /api/v1/geral/produtos/ para obter essa informação."},"codigo_produto_integracao":{"type":"string","description":"Código de integração do Produto. Esse campo deve ser informado apenas se você incluiu o produto via API e informou um código de integração para o produto. Do contrário, informe sempre a tag \"codigo_produto\"."},"codigo_item_integracao":{"type":"string","description":"Código de Integração do Item do Pedido de Venda. Código informado em \"codigo_item_integracao\" ou vazio se o produto for componente de um kit. Presente se a tag \"codigo_item_integracao\" for informada."},"codigo_item_kit":{"type":"integer","description":"ID do Item do kit (pai) que o componente pertence. Presente se a tag \"codigo_item_integracao\" for informada."},"quantidade":{"type":"decimal","description":"Quantidade do produto para simulação dos impostos."},"valor_unitario":{"type":"decimal","description":"Valor unitário para simulação dos impostos"},"valor_desconto":{"type":"decimal","description":"Valor do desconto do item, se houver, para ser considerado na simulação dos impostos."},"valor_icms_desonerado":{"type":"decimal","description":"Valor do ICMS desonerado"},"motivo_icms_desonerado":{"type":"string","description":"Código do Motivo de desoneração do ICMS Códigos para desoneração do ICMS 01 Táxi 03 Produtor Agropecuário 04 Frotista/Locadora 05 Diplomático/Consular 06 Utilitários e Motocicletas da Amazônia Ocidental e Áreas de Livre Comércio (Resolução 714/88 e 790/94 ? CONTRAN e suas alterações) 07 SUFRAMA 08 Venda a Órgão Público 09 Outros. (NT 2011/004) 10 Deficiente Condutor (Convênio ICMS 38/12) 11 Deficiente Não Condutor (Convênio ICMS 38/12) 16 Olimpíadas Rio 2016 90 Solicitado pelo Fisco"},"valor_total":{"type":"decimal","description":"Valor Total."},"cfop":{"type":"string","description":"CFOP - Código Fiscal de Operações e Prestações."}},"description":"Informações do produto para simulação de impostos"},"imposto":{"type":"object","properties":{"icms_sn":{"type":"object","properties":{"cod_sit_trib_icms_sn":{"type":"string"},"origem_icms_sn":{"type":"string"},"aliq_icms_sn":{"type":"decimal"},"valor_credito_icms_sn":{"type":"decimal"},"base_icms_sn":{"type":"decimal"},"valor_icms_sn":{"type":"decimal"}},"description":"ICMS - Simples Nacional."},"icms":{"type":"object","properties":{"cod_sit_trib_icms":{"type":"string"},"origem_icms":{"type":"string"},"modalidade_icms":{"type":"string"},"perc_red_base_icms":{"type":"decimal"},"base_icms":{"type":"decimal"},"aliq_icms":{"type":"decimal"},"valor_icms":{"type":"decimal"},"perc_fcp_icms":{"type":"decimal","description":"Percentual do FCP - Fundo de Combate a Pobreza do ICMS."},"base_fcp_icms":{"type":"decimal","description":"Base de Cálculo do FCP - Fundo de Combate a Pobreza do ICMS."},"valor_fcp_icms":{"type":"decimal","description":"Valor do FCP - Fundo de Combate a Pobreza do ICMS."}},"description":"ICMS"},"icms_st":{"type":"object","properties":{"cod_sit_trib_icms_st":{"type":"string"},"modalidade_icms_st":{"type":"string"},"perc_red_base_icms_st":{"type":"decimal"},"base_icms_st":{"type":"decimal"},"aliq_icms_st":{"type":"decimal"},"margem_icms_st":{"type":"decimal"},"valor_icms_st":{"type":"decimal"},"aliq_icms_opprop":{"type":"decimal","description":"Alíquota de ICMS Operação Própria."},"perc_red_base_icms_op":{"type":"decimal","description":"Percentual de redução de base de cálculo de Icms Operação Própria."},"cest":{"type":"string","description":"CEST - Código Especificador da Substituíção Tributária."},"perc_fcp_icms_st":{"type":"decimal","description":"Percentual do FCP - Fundo de Combate a Pobreza do ICMS ST."},"base_fcp_icms_st":{"type":"decimal","description":"Base de Cálculo do FCP - Fundo de Combate a Pobreza do ICMS ST."},"valor_fcp_icms_st":{"type":"decimal","description":"Valor do FCP - Fundo de Combate a Pobreza do ICMS ST."}},"description":"ICMS - Substituição Tributária."},"icms_ie":{"type":"object","properties":{"base_icms_uf_destino":{"type":"decimal","description":"BC do ICMS na UF de Destino"},"aliq_icms_FCP":{"type":"decimal","description":"Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de Destino"},"aliq_interna_uf_destino":{"type":"decimal","description":"Alíquota Interna da UF de Destino"},"aliq_interestadual":{"type":"decimal","description":"Alíquota Interestadual das UFs Envolvidas"},"aliq_partilha_icms":{"type":"decimal","description":"Percentual Provisório de Partilha do ICMS Interestadual"},"valor_fcp_icms_inter":{"type":"decimal","description":"Valor do fundo de combate a pobreza."},"valor_icms_uf_dest":{"type":"decimal","description":"Valor do ICMS - UF Destino"},"valor_icms_uf_remet":{"type":"decimal","description":"Valor do ICMS - UF Remetente"}},"description":"ICMS Interestadual."},"icms_efet":{"type":"object","properties":{"cod_sit_trib_icms_efet":{"type":"string"},"origem_icms_efet":{"type":"string"},"modalidade_icms_efet":{"type":"string"},"perc_red_base_icms_efet":{"type":"decimal"},"base_icms_efet":{"type":"decimal"},"aliq_icms_efet":{"type":"decimal"},"valor_icms_efet":{"type":"decimal"}},"description":"ICMS efetivo. Não informar na Inclusão e Alteração. Utilizado somente na Consulta e Listagem"},"ipi":{"type":"object","properties":{"cod_sit_trib_ipi":{"type":"string"},"tipo_calculo_ipi":{"type":"string"},"enquadramento_ipi":{"type":"string","description":"Enquadramento do IPI"},"base_ipi":{"type":"decimal"},"aliq_ipi":{"type":"decimal"},"qtde_unid_trib_ipi":{"type":"decimal"},"valor_unid_trib_ipi":{"type":"decimal"},"valor_ipi":{"type":"decimal"}},"description":"IPI."},"pis_padrao":{"type":"object","properties":{"cod_sit_trib_pis":{"type":"string"},"tipo_calculo_pis":{"type":"string"},"base_pis":{"type":"decimal"},"aliq_pis":{"type":"decimal"},"qtde_unid_trib_pis":{"type":"decimal"},"valor_unid_trib_pis":{"type":"decimal"},"valor_pis":{"type":"decimal"}},"description":"PIS."},"pis_st":{"type":"object","properties":{"cod_sit_trib_pis_st":{"type":"string"},"tipo_calculo_pis_st":{"type":"string"},"base_pis_st":{"type":"decimal"},"aliq_pis_st":{"type":"decimal"},"qtde_unid_trib_pis_st":{"type":"decimal"},"valor_unid_trib_pis_st":{"type":"decimal"},"margem_pis_st":{"type":"decimal"},"valor_pis_st":{"type":"decimal"}},"description":"PIS - Substituíção Tributária."},"cofins_padrao":{"type":"object","properties":{"cod_sit_trib_cofins":{"type":"string"},"tipo_calculo_cofins":{"type":"string"},"base_cofins":{"type":"decimal"},"aliq_cofins":{"type":"decimal"},"qtde_unid_trib_cofins":{"type":"decimal"},"valor_unid_trib_cofins":{"type":"decimal"},"valor_cofins":{"type":"decimal"}},"description":"COFINS."},"cofins_st":{"type":"object","properties":{"cod_sit_trib_cofins_st":{"type":"string"},"tipo_calculo_cofins_st":{"type":"string"},"base_cofins_st":{"type":"decimal"},"aliq_cofins_st":{"type":"decimal"},"qtde_unid_trib_cofins_st":{"type":"decimal"},"valor_unid_trib_cofins_st":{"type":"decimal"},"margem_cofins_st":{"type":"decimal"},"valor_cofins_st":{"type":"decimal"}},"description":"COFINS - Substituição Tributária."},"inss":{"type":"object","properties":{"aliq_inss":{"type":"decimal"},"valor_inss":{"type":"decimal"}},"description":"INSS."},"csll":{"type":"object","properties":{"aliq_csll":{"type":"decimal"},"valor_csll":{"type":"decimal"}},"description":"CSLL."},"irrf":{"type":"object","properties":{"aliq_irrf":{"type":"decimal"},"valor_irrf":{"type":"decimal"}},"description":"IRRF."},"iss":{"type":"object","properties":{"base_iss":{"type":"decimal"},"aliq_iss":{"type":"decimal"},"valor_iss":{"type":"decimal"},"retem_iss":{"type":"string"}},"description":"ISS."},"ibs_cbs":{"type":"object","properties":{"cst_ibs_cbs":{"type":"string","description":"Código de Situação Tributária do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"class_trib":{"type":"string","description":"Código de Classificação Tributária do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"base_ibs_cbs":{"type":"decimal","description":"Base de cálculo do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."}}},"ibs":{"type":"object","properties":{"aliquota_ibs_uf":{"type":"decimal","description":"Alíquota do IBS de competência das UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"perc_dif_ibs_uf":{"type":"decimal","description":"Percentual do Diferimento - IBS UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"perc_red_ibs_uf":{"type":"decimal","description":"Percentual da redução de alíquota - IBS UF. Não deve ser informado na Inclusão/Alteração. Campos disponíveis apenas para consulta. Para os métodos de inclusão e alteração, esses campos serão alimentados conforme o cenário fiscal."},"valor_dif_ibs_uf":{"type":"decimal","description":"Valor do Diferimento - IBS UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_ibs_uf":{"type":"decimal","description":"Valor do IBS de competência da UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"aliquota_ibs_mu":{"type":"decimal","description":"Alíquota do IBS de competência do Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"perc_dif_ibs_mu":{"type":"decimal","description":"Percentual do diferimento - UBS Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"perc_red_ibs_mu":{"type":"decimal","description":"Percentual da redução de alíquota - IBS Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_dif_ibs_mu":{"type":"decimal","description":"Valor do Diferimento - IBS Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_ibs_mu":{"type":"decimal","description":"Valor do IBS de competência do Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_ibs":{"type":"decimal","description":"Valor total do IBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."}}},"cbs":{"type":"object","properties":{"aliquota_cbs":{"type":"decimal","description":"Alíquota da CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"perc_dif_cbs":{"type":"decimal","description":"Percentual do diferimento - CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"perc_red_cbs":{"type":"decimal","description":"Percentual da redução de alíquota - CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_dif_cbs":{"type":"decimal","description":"Valor do diferimento - CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_cbs":{"type":"decimal","description":"Valor da CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."}}},"trib_reg":{"type":"object","properties":{"cst_reg_ibs_cst":{"type":"string","description":"Código da Situação Tributária do IBS e CBS (Tributação Regular). Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"class_trib_reg":{"type":"string","description":"Código de Classificação Tributária do IBS e CBS (Tributação Regular). Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"aliquota_reg_ibs_uf":{"type":"decimal","description":"Valor da alíquota do IBS da UF na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"aliquota_reg_ibs_mu":{"type":"decimal","description":"Valor da alíquota do IBS do Município na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"aliquota_reg_cbs":{"type":"decimal","description":"Valor da alíquota da CBS na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_reg_ibs_uf":{"type":"decimal","description":"Valor do Tributo do IBS da UF na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_reg_ibs_mu":{"type":"decimal","description":"Valor do Tributo do IBS do Município na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."},"valor_reg_cbs":{"type":"decimal","description":"Valor do Tributo da CBS na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído ao pedido."}}}},"description":"Informações referentes aos impostos do Item do Pedido de Vendas. Essa estrutura deve ser preenchida quando os dados dos impostos devem ser respeitados tais como foram enviados na API. Caso essa estrutura não seja enviada, o Omie irá identificar a regra de imposto que melhor se ajusta as condições da venda realizada. Para utilizar essa opção esteja seguro de que as regras e cenários de impostos estejam cadastrados corretamente no Omie. As infomações preenchidas serão decorrentes dos dados configurados."}}},"description":"Retorno com o detalhe do item com a simulação de impostos"}},"title":"SimularImpostos (retorno)"},"produtos_pedido_StatusPedido":{"type":"object","title":"StatusPedido","description":"Consulta do Status do Pedido","required":["call","param"],"properties":{"call":{"type":"string","enum":["StatusPedido"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_pedido":{"type":"integer","maxLength":15,"description":"ID do pedido do venda.\n\nEsse campo não é exibido na tela do Pedido de Vendas.\nÉ uma informação interna, utilizada apenas nas APIs."},"codigo_pedido_integracao":{"type":"string","maxLength":60,"description":"Código de integração do pedido de venda.\n\nPreencha esse campo com o código do pedido no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de pedidos você conseguirá ver a relação entre o id do pedido gerado no Omie e o código de pedido existente em sua aplicação."}}}}},"example":{"call":"StatusPedido","param":[{"codigo_pedido":0,"codigo_pedido_integracao":""}]}},"produtos_pedido_StatusPedido_retorno":{"type":"object","properties":{"codigo_pedido":{"type":"integer","description":"ID do pedido do venda. Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs."},"codigo_pedido_integracao":{"type":"string","description":"Código de integração do pedido de venda. Preencha esse campo com o código do pedido no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de pedidos você conseguirá ver a relação entre o id do pedido gerado no Omie e o código de pedido existente em sua aplicação."},"numero_pedido":{"type":"string","description":"Número do pedido de venda. Esse é o número do pedido de venda no Omie, que é gerado automaticamente e exibido na tela."},"etapa":{"type":"string","description":"Etapa do pedido de venda. Esse campo indica em que coluna o pedido de venda irá figurar no processo de faturamento do Omie. Utilize a tag \"codigo\" do método \"ListarEtapasFaturamento\" da API http://app.omie.com.br/api/v1/produtos/etapafat/ para obter essa informação. Os valores são fixos, mas as descrições (funções atribuídas a cada coluna pode mudar. A API irá indicar a descrição de cada coluna. Os valores disponíveis para esse campo podem ser: \"10\" - Primeira coluna \"20\" - Segunda coluna \"30\" - Terceira coluna \"40\" - Quarta coluna \"50\" - Faturar."},"cancelada":{"type":"string","description":"NF-e Cancelada?"},"faturada":{"type":"string"},"ambiente":{"type":"string"},"valor_total_pedido":{"type":"decimal","description":"Valor total do pedido"},"ListaNfe":{"type":"array","items":{"type":"object","properties":{"numero_lote":{"type":"integer","description":"Número do lote da NF-e"},"status_lote":{"type":"string","description":"Status do Lote da NF-e."},"recibo":{"type":"integer","description":"Recibo"},"contingencia":{"type":"string","description":"NF-e emitida em contingência"},"numero_nfe":{"type":"string","description":"Número da NF-e gerada"},"serie_nfe":{"type":"string","description":"Série da NF-e"},"status_nfe":{"type":"string","description":"Status da NF-e"},"chave_nfe":{"type":"string","description":"Chave de Acesso da NF-e"},"protocolo":{"type":"integer","description":"Número do Protocolo"},"tipo":{"type":"string","description":"Tipo de Emissão. Pode ser: E - Entrada S - Saída"},"data_emissao":{"type":"string","description":"Data da Emissão da NF-e"},"hora_emissao":{"type":"string","description":"Hora da Emissão da NF-e"},"data_fatura":{"type":"string","description":"Data do faturamento"},"hora_fatura":{"type":"string","description":"Hora de Faturamento"},"data_saida":{"type":"string","description":"Data de Saída"},"hora_saida":{"type":"string","description":"Hora de Saída da NF-e"},"mensagens":{"type":"array","items":{"type":"object","properties":{"cCodigo":{"type":"string","description":"Código da mensagem de erro/aviso"},"cDescricao":{"type":"string","description":"Descrição da mensagem de erro/aviso."},"cCorrecao":{"type":"string","description":"Correção da descrição de mensagem de erro/aviso."}}},"description":"Mensagens de Erros"},"xml_distr":{"type":"string","description":"XML de distribuição da NF-e"},"danfe":{"type":"string","description":"Link para o DANFE da NF-e gerada."}}},"description":"Lista de NF-es geradas"}},"title":"StatusPedido (retorno)"},"produtos_pedido_TrocarEtapaPedido":{"type":"object","title":"TrocarEtapaPedido","description":"Troca etapa do pedido.","required":["call","param"],"properties":{"call":{"type":"string","enum":["TrocarEtapaPedido"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_pedido":{"type":"integer","maxLength":15,"description":"ID do pedido do venda.\n\nEsse campo não é exibido na tela do Pedido de Vendas.\nÉ uma informação interna, utilizada apenas nas APIs."},"codigo_pedido_integracao":{"type":"string","maxLength":60,"description":"Código de integração do pedido de venda.\n\nPreencha esse campo com o código do pedido no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de pedidos você conseguirá ver a relação entre o id do pedido gerado no Omie e o código de pedido existente em sua aplicação."},"numero_pedido":{"type":"string","maxLength":15,"description":"Número do pedido de venda.\n\nEsse é o número do pedido de venda no Omie, que é gerado automaticamente e exibido na tela."},"etapa":{"type":"string","maxLength":2,"description":"Etapa do pedido de venda.\n\nEsse campo indica em que coluna o pedido de venda irá figurar no processo de faturamento do Omie.\n\nUtilize a tag \"codigo\" do método \"ListarEtapasFaturamento\" da API\nhttp://app.omie.com.br/api/v1/produtos/etapafat/\npara obter essa informação.\n\nOs valores são fixos, mas as descrições (funções atribuídas a cada coluna pode mudar. A API irá indicar a descrição de cada coluna.\n\nOs valores disponíveis para esse campo podem ser:\n\n\"10\" - Primeira coluna\n\"20\" - Segunda coluna\n\"30\" - Terceira coluna\n\"40\" - Quarta coluna\n\"50\" - Faturar."}},"required":["etapa"]}}},"example":{"call":"TrocarEtapaPedido","param":[{"codigo_pedido":0,"codigo_pedido_integracao":"","etapa":"20"}]}},"produtos_pedido_TrocarEtapaPedido_retorno":{"type":"object","properties":{"codigo_pedido":{"type":"integer","description":"ID do pedido do venda. Esse campo não é exibido na tela do Pedido de Vendas. É uma informação interna, utilizada apenas nas APIs."},"codigo_pedido_integracao":{"type":"string","description":"Código de integração do pedido de venda. Preencha esse campo com o código do pedido no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de pedidos você conseguirá ver a relação entre o id do pedido gerado no Omie e o código de pedido existente em sua aplicação."},"numero_pedido":{"type":"string","description":"Número do pedido de venda. Esse é o número do pedido de venda no Omie, que é gerado automaticamente e exibido na tela."},"codigo_status":{"type":"string","description":"Código do Status do Pedido de Venda."},"descricao_status":{"type":"string","description":"Descrição do status."}},"title":"TrocarEtapaPedido (retorno)"},"produtos_pedidocompra_AlteraPedCompra":{"type":"object","title":"AlteraPedCompra","description":"Alterar as Informações de um Pedido de Compra.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlteraPedCompra"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cabecalho_alterar":{"type":"object","properties":{"nCodPed":{"type":"integer","maxLength":15,"description":"Código interno do pedido de compra (este é o código do pedido no Omie)."},"cCodIntPed":{"type":"string","maxLength":20,"description":"Código de integração do pedido de compra (este é o código do pedido no seu sistema)."},"dDtPrevisao":{"type":"string","maxLength":10,"description":"Data de previsão de entrega do pedido de compra."},"cCodParc":{"type":"string","maxLength":3,"description":"Código da Condição de Pagamento/Parcelamento.\n\n\"999\" - Padrão."},"nQtdeParc":{"type":"integer","maxLength":3,"description":"Quantidade de parcelas do pedido."},"cCnpjCpfFor":{"type":"string","maxLength":20,"description":"CNPJ / CPF\n\nQuando informada as tags nCodFor e cCodIntFor não devem ser informadas."},"nCodFor":{"type":"integer","maxLength":15,"description":"Código interno do fornecedor do pedido (este é o código do fornecedor no Omie)."},"cCodIntFor":{"type":"string","maxLength":20,"description":"Código de integração do fornecedor do pedido (este é o código do fornecedor no seu sistema)."},"cCodCateg":{"type":"string","maxLength":20,"description":"Código da categoria de compra."},"nCodCompr":{"type":"integer","maxLength":15,"description":"Código do comprador do pedido."},"cContato":{"type":"string","maxLength":100,"description":"Nome do contato no fornecedor responsável pelo pedido de compra."},"cContrato":{"type":"string","maxLength":20,"description":"Número do Contrato de Compra.\n\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Compra."},"nCodCC":{"type":"integer","maxLength":15,"description":"Código interno da conta corrente do pedido de compra (este é o código da conta corrente no Omie)."},"nCodIntCC":{"type":"string","maxLength":20,"description":"Código de integração da conta corrente do pedido (este é o código da conta corrente no seu sistema)."},"nCodProj":{"type":"integer","maxLength":15,"description":"Código do projeto relacionado ao pedido de compra."},"cNumPedido":{"type":"string","maxLength":30,"description":"Número do pedido para o fornecedor."},"cObs":{"type":"string","description":"Observações do pedido de compra (elas não serão impressas no pedido enviado ao fornecedor)."},"cObsInt":{"type":"string","description":"Observações internas do pedido (elas serão exibidas apenas para quem consultar o pedido de compra)."}},"description":"Cabeçalho do Pedido de Compra."},"frete_alterar":{"type":"object","properties":{"nCodTransp":{"type":"integer","maxLength":15,"description":"Código interno da transportadora (este é o código da transportadora no Omie)."},"cCodIntTransp":{"type":"string","maxLength":20,"description":"Código de integração da transportadora (este é o código da transportadora no seu sistema)."},"cTpFrete":{"type":"string","maxLength":1,"description":"Modalidade do frete no pedido."},"cPlaca":{"type":"string","maxLength":7,"description":"Placa do veículo de transporte."},"cUF":{"type":"string","maxLength":2,"description":"UF da placa do veículo do transporte."},"nQtdVol":{"type":"integer","maxLength":15,"description":"Quantidade de volumes."},"cEspVol":{"type":"string","maxLength":60,"description":"Espécie dos volumes."},"cMarVol":{"type":"string","maxLength":60,"description":"Marca dos volumes."},"cNumVol":{"type":"string","maxLength":60,"description":"Numeração dos volumes."},"nPesoLiq":{"type":"number","maxLength":18,"description":"Peso líquido (Kg)."},"nPesoBruto":{"type":"number","maxLength":18,"description":"Peso bruto (Kg)."},"nValFrete":{"type":"number","maxLength":18,"description":"Valor do frete."},"nValSeguro":{"type":"number","maxLength":18,"description":"Valor do seguro."},"cLacre":{"type":"string","maxLength":60,"description":"Número do lacre."},"nValOutras":{"type":"number","maxLength":18,"description":"Valor das outras despesas acessórias."}},"description":"Frete, Transporte e Outras Despesas do Pedido de Compra."},"produtos_alterar":{"type":"array","items":{"type":"object","properties":{"cCodIntItem":{"type":"string","maxLength":20,"description":"Código de integração do item do pedido de compra (este é o código do item no seu sistema)."},"nCodItem":{"type":"integer","maxLength":15,"description":"Código interno do item do pedido de compra (este é o código do item no Omie)."},"cCodIntProd":{"type":"string","maxLength":20,"description":"Código de integração do cadastro do produto (este é o código do produto no seu sistema)."},"nCodProd":{"type":"integer","maxLength":15,"description":"Código interno do cadastro do produto (este é o código do produto no Omie)."},"cProduto":{"type":"string","maxLength":60,"description":"Código do item no pedido (pode ser o mesmo código que aparece na NF-e do fornecedor)."},"cDescricao":{"type":"string","maxLength":120,"description":"Descrição do item no pedido."},"cNCM":{"type":"string","maxLength":13,"description":"Código NCM do item."},"cUnidade":{"type":"string","maxLength":6,"description":"Unidade do item no pedido."},"cEAN":{"type":"string","maxLength":14,"description":"Código EAN / GTIN do item no pedido."},"nPesoLiq":{"type":"number","maxLength":18,"description":"Peso líquido (Kg)."},"nPesoBruto":{"type":"number","maxLength":18,"description":"Peso bruto (Kg)."},"nQtde":{"type":"number","maxLength":18,"description":"Quantidade do item no pedido."},"nValUnit":{"type":"number","maxLength":18,"description":"Valor unitário do item no pedido."},"nDesconto":{"type":"number","maxLength":18,"description":"Valor do desconto do item no pedido."},"nValorIcms":{"type":"number","maxLength":18,"description":"Valor do ICMS."},"nValorSt":{"type":"number","maxLength":18,"description":"Valor do ICMS ST."},"nValorIpi":{"type":"number","maxLength":18,"description":"Valor do IPI."},"nValorPis":{"type":"number","maxLength":18,"description":"Valor do PIS."},"nValorCofins":{"type":"number","maxLength":18,"description":"Valor do COFINS."},"cObs":{"type":"string","description":"Observação do item no pedido (elas serão impressas no pedido enviado ao fornecedor)."},"cMkpAtuPv":{"type":"string","maxLength":1,"description":"Indica que deve atualizar o preço de venda do produto no recebimento."},"cMkpAtuSm":{"type":"string","maxLength":1,"description":"Indica que deve atualizar o preço apenas se for maior que o atual."},"nMkpPerc":{"type":"number","maxLength":10,"description":"Percentual a ser utilizado para a atualização do preço de venda do produto."},"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do Local do Estoque.\n\n\nCaso não informado assumirá o Local do Estoque padrão."},"cCodCateg":{"type":"string","maxLength":20,"description":"Código da categoria de compra do item."}}},"description":"Produtos do Pedido de Compra."},"departamentos_alterar":{"type":"array","items":{"type":"object","properties":{"cCodDepto":{"type":"string","description":"Departamento."},"nPerc":{"type":"number","description":"Percentual de rateio."}},"required":["cCodDepto"]},"description":"Rateio do Pedido de Compra por departamento."},"parcelas_alterar":{"type":"array","items":{"type":"object","properties":{"nParcela":{"type":"integer","maxLength":3,"description":"Número da parcela."},"dVencto":{"type":"string","maxLength":10,"description":"Data de vencimento da parcela."},"nValor":{"type":"number","maxLength":18,"description":"Valor da parcela."},"nDias":{"type":"integer","maxLength":6,"description":"Dias para vencimento da parcela (a partir da data de previsão de entrega)."},"nPercent":{"type":"number","maxLength":9,"description":"Percentual da parcela em relação ao total do pedido de compra."},"cTipoDoc":{"type":"string","description":"Tipo de Documento.\n\nLista de tipos de documentos em:\n/api/v1/geral/tiposdoc."}},"required":["dVencto","nParcela","nPercent","nValor"]},"description":"Parcelas  do Pedido de Compra."},"agropecuario":{"type":"array","items":{"type":"object","properties":{"cNumReceita":{"type":"string","maxLength":20,"description":"Número da receita ou receituário do agrotóxico/defensivo agrícola."},"cCpfResponsavel":{"type":"string","maxLength":14,"description":"CPF do responsável técnico legalmente habilitado."},"nTipoGuia":{"type":"integer","maxLength":1,"description":"Tipo da Guia\n\n1 - Corresponde ao GTA\n2 - Corresponde ao TTA\n3 - Corresponde ao DTA\n4 - Corresponde ao ATV\n5 - Corresponde ao PTV\n6 - Corresponde ao GTV\n7 - Corresponde ao Guia Florestal (DOF, SisFlora - PA e MT, SIAM - MG)."},"cUFGuia":{"type":"string","maxLength":2,"description":"UF de emissão da Guia."},"cSerieGuia":{"type":"string","maxLength":9,"description":"Número de série da guia."},"nNumGuia":{"type":"integer","maxLength":9,"description":"Número da guia."}}}}}}}},"example":{"call":"AlteraPedCompra","param":[{"cabecalho_alterar":{"cCodIntPed":"INT001","dDtPrevisao":"01/03/2027","cCodParc":"","nQtdeParc":3,"nCodFor":"14170458","cCodIntFor":"","cCodCateg":"","nCodCompr":0,"cContato":"","cContrato":"","nCodCC":"1208238","nCodIntCC":0,"nCodProj":0,"cObs":"Pedido alterado via API","cObsInt":"Pedido alterado via API"},"frete_alterar":{"nCodTransp":0,"cCodIntTransp":"","cTpFrete":"9","cPlaca":"XXX-9999","cUF":"SP","nQtdVol":5,"cEspVol":"","cMarVol":"","cNumVol":"","nPesoLiq":5.0,"nPesoBruto":10.0,"nValFrete":50.0,"nValSeguro":10.0,"cLacre":"","nValOutras":0.0},"departamentos_alterar":[{"cCodDepto":"200000002498904","nPerc":90},{"cCodDepto":"200000002498905","nPerc":10}],"produtos_alterar":[{"cCodIntItem":"ITEM001","cCodIntProd":"","nCodProd":"2037060","cProduto":"","cDescricao":"","cNCM":"","cUnidade":"","cEAN":"","nPesoLiq":0,"nPesoBruto":0,"nQtde":10,"nValUnit":200,"nDesconto":0.0,"nValorIcms":360.0,"nValorSt":0.0,"nValorIpi":20.0,"nValorPis":33.0,"nValorCofins":152.0,"cObs":"Item alterado via API","cMkpAtuPv":"N","cMkpAtuSm":"N","nMkpPerc":0,"codigo_local_estoque":"","cCodCateg":""}]}]}},"produtos_pedidocompra_AlteraPedCompra_retorno":{"type":"object","properties":{"nCodPed":{"type":"integer","description":"Código interno do pedido de compra (este é o código do pedido de compra no Omie)."},"cCodIntPed":{"type":"string","description":"Código de integração do pedido de compra (este é o código do pedido de compra no seu sistema)."},"cCodStatus":{"type":"string","description":"Código do status."},"cDescStatus":{"type":"string","description":"Descrição do status."},"cNumero":{"type":"string","description":"Número do pedido de compra."}},"title":"AlteraPedCompra (retorno)"},"produtos_pedidocompra_ConsultarPedCompra":{"type":"object","title":"ConsultarPedCompra","description":"Consultar as Informações de um Pedido de Compra.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarPedCompra"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodPed":{"type":"integer","maxLength":15,"description":"Código interno do pedido de compra (este é o código do pedido de compra no Omie)."},"cCodIntPed":{"type":"string","maxLength":20,"description":"Código de integração do pedido de compra (este é o código do pedido de compra no seu sistema)."},"cNumero":{"type":"string","maxLength":15,"description":"Número do pedido de compra."}}}}},"example":{"call":"ConsultarPedCompra","param":[{"nCodPed":0,"cCodIntPed":"INT001","cNumero":""}]}},"produtos_pedidocompra_ConsultarPedCompra_retorno":{"type":"object","properties":{"cabecalho_consulta":{"type":"object","properties":{"nCodPed":{"type":"integer","description":"Código interno do pedido de compra (este é o código do pedido no Omie)."},"cCodIntPed":{"type":"string","description":"Código de integração do pedido de compra (este é o código do pedido no seu sistema)."},"dIncData":{"type":"string","description":"Data de inclusão ou de criação."},"cIncHora":{"type":"string","description":"Hora de inclusão ou de criação."},"cEtapa":{"type":"string","description":"Etapa atual do pedido de compra."},"cNumero":{"type":"string","description":"Número do pedido de compra."},"dDtPrevisao":{"type":"string","description":"Data de previsão de entrega do pedido de compra."},"cCodParc":{"type":"string","description":"Código da Condição de Pagamento/Parcelamento. \"999\" - Padrão."},"nQtdeParc":{"type":"integer","description":"Quantidade de parcelas do pedido."},"nCodFor":{"type":"integer","description":"Código interno do fornecedor do pedido (este é o código do fornecedor no Omie)."},"cCodIntFor":{"type":"string","description":"Código de integração do fornecedor do pedido (este é o código do fornecedor no seu sistema)."},"cCodCateg":{"type":"string","description":"Código da categoria de compra."},"nCodCompr":{"type":"integer","description":"Código do comprador do pedido."},"cContato":{"type":"string","description":"Nome do contato no fornecedor responsável pelo pedido de compra."},"cContrato":{"type":"string","description":"Número do Contrato de Compra."},"nCodCC":{"type":"integer","description":"Código interno da conta corrente do pedido de compra (este é o código da conta corrente no Omie)."},"nCodIntCC":{"type":"string","description":"Código de integração da conta corrente do pedido (este é o código da conta corrente no seu sistema)."},"nCodProj":{"type":"integer","description":"Código do projeto relacionado ao pedido de compra."},"cNumPedido":{"type":"string","description":"Número do pedido para o fornecedor."},"cObs":{"type":"string","description":"Observações do pedido de compra (elas não serão impressas no pedido enviado ao fornecedor)."},"cObsInt":{"type":"string","description":"Observações internas do pedido (elas serão exibidas apenas para quem consultar o pedido de compra)."}},"description":"Cabeçalho do Pedido de Compra."},"frete_consulta":{"type":"object","properties":{"nCodTransp":{"type":"integer","description":"Código interno da transportadora (este é o código da transportadora no Omie)."},"cCodIntTransp":{"type":"string","description":"Código de integração da transportadora (este é o código da transportadora no seu sistema)."},"cTpFrete":{"type":"string","description":"Modalidade do frete no pedido."},"cPlaca":{"type":"string","description":"Placa do veículo de transporte."},"cUF":{"type":"string","description":"UF da placa do veículo do transporte."},"nQtdVol":{"type":"integer","description":"Quantidade de volumes."},"cEspVol":{"type":"string","description":"Espécie dos volumes."},"cMarVol":{"type":"string","description":"Marca dos volumes."},"cNumVol":{"type":"string","description":"Numeração dos volumes."},"nPesoLiq":{"type":"decimal","description":"Peso líquido (Kg)."},"nPesoBruto":{"type":"decimal","description":"Peso bruto (Kg)."},"nValFrete":{"type":"decimal","description":"Valor do frete."},"nValSeguro":{"type":"decimal","description":"Valor do seguro."},"cLacre":{"type":"string","description":"Número do lacre."},"nValOutras":{"type":"decimal","description":"Valor das outras despesas acessórias."}},"description":"Frete, Transporte e Outras Despesas do Pedido de Compra."},"produtos_consulta":{"type":"array","items":{"type":"object","properties":{"cCodIntItem":{"type":"string","description":"Código de integração do item do pedido de compra (este é o código do item no seu sistema)."},"nCodItem":{"type":"integer","description":"Código interno do item do pedido de compra (este é o código do item no Omie)."},"cCodIntProd":{"type":"string","description":"Código de integração do cadastro do produto (este é o código do produto no seu sistema)."},"nCodProd":{"type":"integer","description":"Código interno do cadastro do produto (este é o código do produto no Omie)."},"cProduto":{"type":"string","description":"Código do item no pedido (pode ser o mesmo código que aparece na NF-e do fornecedor)."},"cDescricao":{"type":"string","description":"Descrição do item no pedido."},"cNCM":{"type":"string","description":"Código NCM do item."},"cEAN":{"type":"string","description":"Código EAN / GTIN do item no pedido."},"cUnidade":{"type":"string","description":"Unidade do item no pedido."},"nPesoLiq":{"type":"decimal","description":"Peso líquido (Kg)."},"nPesoBruto":{"type":"decimal","description":"Peso bruto (Kg)."},"nQtde":{"type":"decimal","description":"Quantidade do item no pedido."},"nValUnit":{"type":"decimal","description":"Valor unitário do item no pedido."},"nValMerc":{"type":"decimal","description":"Valor total do produto (de mercadoria) no pedido."},"nDesconto":{"type":"decimal","description":"Valor do desconto do item no pedido."},"nValorIcms":{"type":"decimal","description":"Valor do ICMS."},"nValorSt":{"type":"decimal","description":"Valor do ICMS ST."},"nValorIpi":{"type":"decimal","description":"Valor do IPI."},"nValorPis":{"type":"decimal","description":"Valor do PIS."},"nValorCofins":{"type":"decimal","description":"Valor do COFINS."},"nFrete":{"type":"decimal","description":"Valor do frete (proporcional para o item do pedido)."},"nSeguro":{"type":"decimal","description":"Valor do seguro (proporcional para o item do pedido)."},"nDespesas":{"type":"decimal","description":"Valor das outras despesas acessórias (proporcional para o item do pedido)."},"nValTot":{"type":"decimal","description":"Valor total do item (considerando descontos, despesas e impostos)."},"cObs":{"type":"string","description":"Observação do item no pedido (elas serão impressas no pedido enviado ao fornecedor)."},"cMkpAtuPv":{"type":"string","description":"Indica que deve atualizar o preço de venda do produto no recebimento."},"cMkpAtuSm":{"type":"string","description":"Indica que deve atualizar o preço apenas se for maior que o atual."},"nMkpPerc":{"type":"decimal","description":"Percentual a ser utilizado para a atualização do preço de venda do produto."},"codigo_local_estoque":{"type":"integer","description":"Código do Local do Estoque. Caso não informado assumirá o Local do Estoque padrão."},"cCodCateg":{"type":"string","description":"Código da categoria de compra do item."},"nQtdeRec":{"type":"decimal","description":"Quantidade recebida do Item."}}},"description":"Produtos do Pedido de Compra."},"parcelas_consulta":{"type":"array","items":{"type":"object","properties":{"nParcela":{"type":"integer","description":"Número da parcela."},"dVencto":{"type":"string","description":"Data de vencimento da parcela."},"nValor":{"type":"decimal","description":"Valor da parcela."},"nDias":{"type":"integer","description":"Dias para vencimento da parcela (a partir da data de previsão de entrega)."},"nPercent":{"type":"decimal","description":"Percentual da parcela em relação ao total do pedido de compra."},"cTipoDoc":{"type":"string","description":"Tipo de Documento. Lista de tipos de documentos em: /api/v1/geral/tiposdoc."}}},"description":"Parcelas do Pedido de Compras."},"departamentos_consulta":{"type":"array","items":{"type":"object","properties":{"cCodDepto":{"type":"string","description":"Código do Departamento."},"nPerc":{"type":"decimal","description":"Percentual de rateio."},"nValor":{"type":"decimal","description":"Valor do rateio."}}},"description":"Departamentos do Pedido de Compras."},"caracteristicas_consulta":{"type":"object","properties":{"cNome":{"type":"string","description":"Nome da Característica do Pedido de Compra."},"cConteudo":{"type":"string","description":"Conteúdo da Característica do Pedido de Compra."}},"description":"Características do Pedido de compra."}},"title":"ConsultarPedCompra (retorno)"},"produtos_pedidocompra_EncerraPedCompra":{"type":"object","title":"EncerraPedCompra","description":"Encerra um Pedido de Compra aprovado, ou cancela um Pedido de Compra ainda não aprovado. A ação aplicada é decidida pelo Omie e devolvida na tag cAcaoRealizada.","required":["call","param"],"properties":{"call":{"type":"string","enum":["EncerraPedCompra"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodPed":{"type":"integer","maxLength":15,"description":"Código interno do pedido de compra (este é o código do pedido de compra no Omie)."},"cCodIntPed":{"type":"string","maxLength":20,"description":"Código de integração do pedido de compra (este é o código do pedido de compra no seu sistema)."},"nIdMotivoEnc":{"type":"integer","maxLength":15,"description":"ID do motivo do encerramento.\n\nUtilizado apenas quando o pedido está aprovado e, portanto, é encerrado. No cancelamento não existe motivo e esta tag é ignorada. Os valores aceitos são os devolvidos pela operação ListarMotivosEncerramento. Quando não informada, vale a tag cDescEnc; sem nenhuma das duas o pedido é encerrado sem motivo."},"cDescEnc":{"type":"string","maxLength":150,"description":"Descrição do motivo do encerramento.\n\nAlternativa ao nIdMotivoEnc para quem não conhece o ID do motivo. O Omie procura um motivo com essa mesma descrição no aplicativo e o reaproveita; se não existir, cadastra um novo. Quando as duas tags são enviadas, prevalece o nIdMotivoEnc. Não pode ser preenchida apenas com números, pois o valor seria interpretado como ID de motivo."},"cObsEnc":{"type":"string","description":"Observações do encerramento.\n\nUtilizado apenas quando o pedido está aprovado e, portanto, é encerrado. Se não for informado, o Omie registra \"Encerramento enviado via API.\"."}}}}},"example":{"call":"EncerraPedCompra","param":[{"nCodPed":1234567890,"nIdMotivoEnc":1,"cObsEnc":"Compra desistida junto ao fornecedor."}]}},"produtos_pedidocompra_EncerraPedCompra_retorno":{"type":"object","properties":{"nCodPed":{"type":"integer","description":"Código interno do pedido de compra (este é o código do pedido de compra no Omie)."},"cCodIntPed":{"type":"string","description":"Código de integração do pedido de compra (este é o código do pedido de compra no seu sistema)."},"cAcaoRealizada":{"type":"string","description":"Ação efetivamente realizada no pedido. \"ENCERRADO\" quando o pedido estava aprovado, \"CANCELADO\" quando ainda não estava."},"cCodStatus":{"type":"string","description":"Código do status. Retorna 0 quando a operação é concluída com sucesso. Em caso de falha, traz o código do erro."},"cDescStatus":{"type":"string","description":"Descrição do status. Em caso de sucesso, confirma se o pedido foi encerrado ou cancelado; em caso de falha, descreve o motivo."}},"title":"EncerraPedCompra (retorno)"},"produtos_pedidocompra_ExcluirPedCompra":{"type":"object","title":"ExcluirPedCompra","description":"Excluir um Pedido de Compra.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirPedCompra"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodPed":{"type":"integer","maxLength":15,"description":"Código interno do pedido de compra (este é o código do pedido de compra no Omie)."},"cCodIntPed":{"type":"string","maxLength":20,"description":"Código de integração do pedido de compra (este é o código do pedido de compra no seu sistema)."}}}}},"example":{"call":"ExcluirPedCompra","param":[{"nCodPed":0,"cCodIntPed":"INT001"}]}},"produtos_pedidocompra_ExcluirPedCompra_retorno":{"type":"object","properties":{"nCodPed":{"type":"integer","description":"Código interno do pedido de compra (este é o código do pedido de compra no Omie)."},"cCodIntPed":{"type":"string","description":"Código de integração do pedido de compra (este é o código do pedido de compra no seu sistema)."},"cCodStatus":{"type":"string","description":"Código do status."},"cDescStatus":{"type":"string","description":"Descrição do status."}},"title":"ExcluirPedCompra (retorno)"},"produtos_pedidocompra_IncluirPedCompra":{"type":"object","title":"IncluirPedCompra","description":"Incluir um Pedido de Compra.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirPedCompra"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cabecalho_incluir":{"type":"object","properties":{"cCodIntPed":{"type":"string","maxLength":20,"description":"Código de integração do pedido de compra (este é o código do pedido no seu sistema)."},"dDtPrevisao":{"type":"string","maxLength":10,"description":"Data de previsão de entrega do pedido de compra."},"cCodParc":{"type":"string","maxLength":3,"description":"Código da Condição de Pagamento/Parcelamento.\n\n\"999\" - Padrão."},"nQtdeParc":{"type":"integer","maxLength":3,"description":"Quantidade de parcelas do pedido."},"cCnpjCpfFor":{"type":"string","maxLength":20,"description":"CNPJ / CPF\n\nQuando informada as tags nCodFor e cCodIntFor não devem ser informadas."},"nCodFor":{"type":"integer","maxLength":15,"description":"Código interno do fornecedor do pedido (este é o código do fornecedor no Omie)."},"cCodIntFor":{"type":"string","maxLength":20,"description":"Código de integração do fornecedor do pedido (este é o código do fornecedor no seu sistema)."},"cCodCateg":{"type":"string","maxLength":20,"description":"Código da categoria de compra."},"nCodCompr":{"type":"integer","maxLength":15,"description":"Código do comprador do pedido."},"cContato":{"type":"string","maxLength":100,"description":"Nome do contato no fornecedor responsável pelo pedido de compra."},"cContrato":{"type":"string","maxLength":20,"description":"Número do Contrato de Compra.\n\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Compra."},"nCodCC":{"type":"integer","maxLength":15,"description":"Código interno da conta corrente do pedido de compra (este é o código da conta corrente no Omie)."},"nCodIntCC":{"type":"string","maxLength":20,"description":"Código de integração da conta corrente do pedido (este é o código da conta corrente no seu sistema)."},"nCodProj":{"type":"integer","maxLength":15,"description":"Código do projeto relacionado ao pedido de compra."},"cNumPedido":{"type":"string","maxLength":30,"description":"Número do pedido para o fornecedor."},"cObs":{"type":"string","description":"Observações do pedido de compra (elas não serão impressas no pedido enviado ao fornecedor)."},"cObsInt":{"type":"string","description":"Observações internas do pedido (elas serão exibidas apenas para quem consultar o pedido de compra)."},"cEmailAprovador":{"type":"string","maxLength":120,"description":"Informe aqui o E-mail do usúario que irá aprovar o pedido.\nEsse usúario deve ter permissão de acesso para realizar a aprovação.\n\nAo informar esse campo o pedido de compra será atribuído a etapa de aprovação com o status de aprovado."}},"description":"Cabeçalho do Pedido de Compra."},"frete_incluir":{"type":"object","properties":{"nCodTransp":{"type":"integer","maxLength":15,"description":"Código interno da transportadora (este é o código da transportadora no Omie)."},"cCodIntTransp":{"type":"string","maxLength":20,"description":"Código de integração da transportadora (este é o código da transportadora no seu sistema)."},"cTpFrete":{"type":"string","maxLength":1,"description":"Modalidade do frete no pedido."},"cPlaca":{"type":"string","maxLength":7,"description":"Placa do veículo de transporte."},"cUF":{"type":"string","maxLength":2,"description":"UF da placa do veículo do transporte."},"nQtdVol":{"type":"integer","maxLength":15,"description":"Quantidade de volumes."},"cEspVol":{"type":"string","maxLength":60,"description":"Espécie dos volumes."},"cMarVol":{"type":"string","maxLength":60,"description":"Marca dos volumes."},"cNumVol":{"type":"string","maxLength":60,"description":"Numeração dos volumes."},"nPesoLiq":{"type":"number","maxLength":18,"description":"Peso líquido (Kg)."},"nPesoBruto":{"type":"number","maxLength":18,"description":"Peso bruto (Kg)."},"nValFrete":{"type":"number","maxLength":18,"description":"Valor do frete."},"nValSeguro":{"type":"number","maxLength":18,"description":"Valor do seguro."},"cLacre":{"type":"string","maxLength":60,"description":"Número do lacre."},"nValOutras":{"type":"number","maxLength":18,"description":"Valor das outras despesas acessórias."}},"description":"Frete, Transporte e Outras Despesas do Pedido de Compra."},"produtos_incluir":{"type":"array","items":{"type":"object","properties":{"cCodIntItem":{"type":"string","maxLength":20,"description":"Código de integração do item do pedido de compra (este é o código do item no seu sistema)."},"cCodIntProd":{"type":"string","maxLength":20,"description":"Código de integração do cadastro do produto (este é o código do produto no seu sistema)."},"nCodProd":{"type":"integer","maxLength":15,"description":"Código interno do cadastro do produto (este é o código do produto no Omie)."},"cProduto":{"type":"string","maxLength":60,"description":"Código do item no pedido (pode ser o mesmo código que aparece na NF-e do fornecedor)."},"cDescricao":{"type":"string","maxLength":120,"description":"Descrição do item no pedido."},"cNCM":{"type":"string","maxLength":13,"description":"Código NCM do item."},"cUnidade":{"type":"string","maxLength":6,"description":"Unidade do item no pedido."},"cEAN":{"type":"string","maxLength":14,"description":"Código EAN / GTIN do item no pedido."},"nPesoLiq":{"type":"number","maxLength":18,"description":"Peso líquido (Kg)."},"nPesoBruto":{"type":"number","maxLength":18,"description":"Peso bruto (Kg)."},"nQtde":{"type":"number","maxLength":18,"description":"Quantidade do item no pedido."},"nValUnit":{"type":"number","maxLength":18,"description":"Valor unitário do item no pedido."},"nDesconto":{"type":"number","maxLength":18,"description":"Valor do desconto do item no pedido."},"nValorIcms":{"type":"number","maxLength":18,"description":"Valor do ICMS."},"nValorSt":{"type":"number","maxLength":18,"description":"Valor do ICMS ST."},"nValorIpi":{"type":"number","maxLength":18,"description":"Valor do IPI."},"nValorPis":{"type":"number","maxLength":18,"description":"Valor do PIS."},"nValorCofins":{"type":"number","maxLength":18,"description":"Valor do COFINS."},"cObs":{"type":"string","description":"Observação do item no pedido (elas serão impressas no pedido enviado ao fornecedor)."},"cMkpAtuPv":{"type":"string","maxLength":1,"description":"Indica que deve atualizar o preço de venda do produto no recebimento."},"cMkpAtuSm":{"type":"string","maxLength":1,"description":"Indica que deve atualizar o preço apenas se for maior que o atual."},"nMkpPerc":{"type":"number","maxLength":10,"description":"Percentual a ser utilizado para a atualização do preço de venda do produto."},"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do Local do Estoque.\n\n\nCaso não informado assumirá o Local do Estoque padrão."},"cCodCateg":{"type":"string","maxLength":20,"description":"Código da categoria de compra do item."}},"required":["nQtde","nValUnit"]},"description":"Produtos do Pedido de Compra."},"departamentos_incluir":{"type":"array","items":{"type":"object","properties":{"cCodDepto":{"type":"string","description":"Departamento."},"nPerc":{"type":"number","description":"Percentual de rateio."}},"required":["cCodDepto"]},"description":"Rateio do Pedido de Compra por departamento."},"parcelas_incluir":{"type":"array","items":{"type":"object","properties":{"nParcela":{"type":"integer","maxLength":3,"description":"Número da parcela."},"dVencto":{"type":"string","maxLength":10,"description":"Data de vencimento da parcela."},"nValor":{"type":"number","maxLength":18,"description":"Valor da parcela."},"nDias":{"type":"integer","maxLength":6,"description":"Dias para vencimento da parcela (a partir da data de previsão de entrega)."},"nPercent":{"type":"number","maxLength":9,"description":"Percentual da parcela em relação ao total do pedido de compra."},"cTipoDoc":{"type":"string","maxLength":5,"description":"Tipo de Documento.\n\nLista de tipos de documentos em:\n/api/v1/geral/tiposdoc."}},"required":["dVencto","nParcela","nPercent","nValor"]},"description":"Parcelas  do Pedido de Compra."},"agropecuario":{"type":"array","items":{"type":"object","properties":{"cNumReceita":{"type":"string","maxLength":20,"description":"Número da receita ou receituário do agrotóxico/defensivo agrícola."},"cCpfResponsavel":{"type":"string","maxLength":14,"description":"CPF do responsável técnico legalmente habilitado."},"nTipoGuia":{"type":"integer","maxLength":1,"description":"Tipo da Guia\n\n1 - Corresponde ao GTA\n2 - Corresponde ao TTA\n3 - Corresponde ao DTA\n4 - Corresponde ao ATV\n5 - Corresponde ao PTV\n6 - Corresponde ao GTV\n7 - Corresponde ao Guia Florestal (DOF, SisFlora - PA e MT, SIAM - MG)."},"cUFGuia":{"type":"string","maxLength":2,"description":"UF de emissão da Guia."},"cSerieGuia":{"type":"string","maxLength":9,"description":"Número de série da guia."},"nNumGuia":{"type":"integer","maxLength":9,"description":"Número da guia."}}}}}}}},"example":{"call":"IncluirPedCompra","param":[{"cabecalho_incluir":{"cCodIntPed":"INT001","dDtPrevisao":"09/11/2026","cCodParc":"","nQtdeParc":1,"nCodFor":"14170458","cCodIntFor":"","cCodCateg":"","nCodCompr":0,"cContato":"","cContrato":"","nCodCC":"1208238","nCodIntCC":0,"nCodProj":0,"cNumPedido":"71876","cObs":"Pedido incluido via API","cObsInt":"Pedido Cadastrado via API"},"frete_incluir":{"nCodTransp":0,"cCodIntTransp":"","cTpFrete":"9","cPlaca":"XXX-9999","cUF":"SP","nQtdVol":5,"cEspVol":"","cMarVol":"","cNumVol":"","nPesoLiq":0.0,"nPesoBruto":0.0,"nValFrete":0,"nValSeguro":0.0,"cLacre":"","nValOutras":0.0},"departamentos_incluir":[{"cCodDepto":"200000002498904","nPerc":50},{"cCodDepto":"200000002498905","nPerc":50}],"produtos_incluir":[{"cCodIntItem":"ITEM001","cCodIntProd":"","nCodProd":"2037060","cProduto":"","cDescricao":"","cNCM":"","cUnidade":"","cEAN":"","nPesoLiq":0,"nPesoBruto":0,"nQtde":10,"nValUnit":200,"nDesconto":0.0,"nValorIcms":360.0,"nValorSt":0.0,"nValorIpi":20.0,"nValorPis":33.0,"nValorCofins":152.0,"cObs":"","cMkpAtuPv":"N","cMkpAtuSm":"N","nMkpPerc":0,"codigo_local_estoque":"","cCodCateg":""}]}]}},"produtos_pedidocompra_IncluirPedCompra_retorno":{"type":"object","properties":{"nCodPed":{"type":"integer","description":"Código interno do pedido de compra (este é o código do pedido de compra no Omie)."},"cCodIntPed":{"type":"string","description":"Código de integração do pedido de compra (este é o código do pedido de compra no seu sistema)."},"cCodStatus":{"type":"string","description":"Código do status."},"cDescStatus":{"type":"string","description":"Descrição do status."},"cNumero":{"type":"string","description":"Número do pedido de compra."}},"title":"IncluirPedCompra (retorno)"},"produtos_pedidocompra_ListarMotivosEncerramento":{"type":"object","title":"ListarMotivosEncerramento","description":"Lista os motivos de encerramento cadastrados no aplicativo, para uso na tag nIdMotivoEnc da operação EncerraPedCompra.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarMotivosEncerramento"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"nRegistrosPorPagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página."}}}}},"example":{"call":"ListarMotivosEncerramento","param":[{"nPagina":1,"nRegistrosPorPagina":100}]}},"produtos_pedidocompra_ListarMotivosEncerramento_retorno":{"type":"object","properties":{"nPagina":{"type":"integer","description":"Número da página retornada."},"nTotalPaginas":{"type":"integer","description":"Número total de páginas."},"nRegistrosPorPagina":{"type":"integer","description":"Número de registros retornados na página."},"nTotalRegistros":{"type":"integer","description":"Total de registros encontrados."},"motivos":{"type":"array","items":{"type":"object","properties":{"nIdMotivoEnc":{"type":"integer","description":"ID do motivo do encerramento, aceito na tag nIdMotivoEnc da operação EncerraPedCompra."},"cDescricao":{"type":"string","description":"Descrição do motivo do encerramento."},"cInativo":{"type":"string","description":"Indica se o motivo está inativo [S/N]."}}},"description":"Lista dos motivos de encerramento cadastrados no aplicativo."}},"title":"ListarMotivosEncerramento (retorno)"},"produtos_pedidocompra_PesquisarPedCompra":{"type":"object","title":"PesquisarPedCompra","description":"Pesquisar por Pedidos de Compra em determinada condição.","required":["call","param"],"properties":{"call":{"type":"string","enum":["PesquisarPedCompra"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Página da pesquisa."},"nRegsPorPagina":{"type":"integer","maxLength":15,"description":"Registros por página."},"lApenasImportadoApi":{"type":"string","maxLength":1,"description":"Exibir apenas pedidos importados por esta API."},"lExibirPedidosPendentes":{"type":"string","description":"Exibir os pedidos de compra pendentes."},"lExibirPedidosFaturados":{"type":"string","description":"Exibir os pedidos de compra faturados pelo fornecedor."},"lExibirPedidosRecebidos":{"type":"string","description":"Exibir os pedidos de compra recebidos."},"lExibirPedidosCancelados":{"type":"string","description":"Exibir os pedidos de compra cancelados."},"lExibirPedidosEncerrados":{"type":"string","description":"Exibir os pedidos de compra encerrados."},"lExibirPedidosRecParciais":{"type":"string","description":"Exibir os pedidos de compra recebidos parcialmente."},"lExibirPedidosFatParciais":{"type":"string","description":"Exibir os pedidos de compra faturados parcialmente."},"dDataInicial":{"type":"string","description":"Exibir os pedidos de compra a partir desta data."},"dDataFinal":{"type":"string","description":"Exibir os pedidos de compra até esta data."},"lApenasAlterados":{"type":"boolean","description":"Exibir apenas pedidos alterados no periodo.\n\nDefault = false."}}}}},"example":{"call":"PesquisarPedCompra","param":[{"nPagina":1,"nRegsPorPagina":10,"lApenasImportadoApi":"F","lExibirPedidosPendentes":"T","lExibirPedidosFaturados":"F","lExibirPedidosRecebidos":"F","lExibirPedidosCancelados":"F","lExibirPedidosEncerrados":"F","lExibirPedidosRecParciais":"F","lExibirPedidosFatParciais":"F","dDataInicial":"01/01/2021","dDataFinal":"31/12/2021","lApenasAlterados":"F"}]}},"produtos_pedidocompra_PesquisarPedCompra_retorno":{"type":"object","properties":{"nPagina":{"type":"integer","description":"Página da pesquisa."},"nRegsPorPagina":{"type":"integer","description":"Registros por página."},"lApenasImportadoApi":{"type":"string","description":"Exibir apenas pedidos importados por esta API."},"lExibirPedidosPendentes":{"type":"string","description":"Exibir os pedidos de compra pendentes."},"lExibirPedidosFaturados":{"type":"string","description":"Exibir os pedidos de compra faturados pelo fornecedor."},"lExibirPedidosRecebidos":{"type":"string","description":"Exibir os pedidos de compra recebidos."},"lExibirPedidosCancelados":{"type":"string","description":"Exibir os pedidos de compra cancelados."},"lExibirPedidosEncerrados":{"type":"string","description":"Exibir os pedidos de compra encerrados."},"dDataInicial":{"type":"string","description":"Exibir os pedidos de compra a partir desta data."},"dDataFinal":{"type":"string","description":"Exibir os pedidos de compra até esta data."},"nTotalPaginas":{"type":"integer","description":"Total de páginas disponíveis na pesquisa."},"nTotalRegistros":{"type":"integer","description":"Total de registros disponíveis na pesquisa."},"pedidos_pesquisa":{"type":"array","items":{"type":"object","properties":{"cabecalho_consulta":{"type":"object","properties":{"nCodPed":{"type":"integer","description":"Código interno do pedido de compra (este é o código do pedido no Omie)."},"cCodIntPed":{"type":"string","description":"Código de integração do pedido de compra (este é o código do pedido no seu sistema)."},"dIncData":{"type":"string","description":"Data de inclusão ou de criação."},"cIncHora":{"type":"string","description":"Hora de inclusão ou de criação."},"cEtapa":{"type":"string","description":"Etapa atual do pedido de compra."},"cNumero":{"type":"string","description":"Número do pedido de compra."},"dDtPrevisao":{"type":"string","description":"Data de previsão de entrega do pedido de compra."},"cCodParc":{"type":"string","description":"Código da Condição de Pagamento/Parcelamento. \"999\" - Padrão."},"nQtdeParc":{"type":"integer","description":"Quantidade de parcelas do pedido."},"nCodFor":{"type":"integer","description":"Código interno do fornecedor do pedido (este é o código do fornecedor no Omie)."},"cCodIntFor":{"type":"string","description":"Código de integração do fornecedor do pedido (este é o código do fornecedor no seu sistema)."},"cCodCateg":{"type":"string","description":"Código da categoria de compra."},"nCodCompr":{"type":"integer","description":"Código do comprador do pedido."},"cContato":{"type":"string","description":"Nome do contato no fornecedor responsável pelo pedido de compra."},"cContrato":{"type":"string","description":"Número do Contrato de Compra."},"nCodCC":{"type":"integer","description":"Código interno da conta corrente do pedido de compra (este é o código da conta corrente no Omie)."},"nCodIntCC":{"type":"string","description":"Código de integração da conta corrente do pedido (este é o código da conta corrente no seu sistema)."},"nCodProj":{"type":"integer","description":"Código do projeto relacionado ao pedido de compra."},"cNumPedido":{"type":"string","description":"Número do pedido para o fornecedor."},"cObs":{"type":"string","description":"Observações do pedido de compra (elas não serão impressas no pedido enviado ao fornecedor)."},"cObsInt":{"type":"string","description":"Observações internas do pedido (elas serão exibidas apenas para quem consultar o pedido de compra)."}},"description":"Cabeçalho do Pedido de Compra."},"frete_consulta":{"type":"object","properties":{"nCodTransp":{"type":"integer","description":"Código interno da transportadora (este é o código da transportadora no Omie)."},"cCodIntTransp":{"type":"string","description":"Código de integração da transportadora (este é o código da transportadora no seu sistema)."},"cTpFrete":{"type":"string","description":"Modalidade do frete no pedido."},"cPlaca":{"type":"string","description":"Placa do veículo de transporte."},"cUF":{"type":"string","description":"UF da placa do veículo do transporte."},"nQtdVol":{"type":"integer","description":"Quantidade de volumes."},"cEspVol":{"type":"string","description":"Espécie dos volumes."},"cMarVol":{"type":"string","description":"Marca dos volumes."},"cNumVol":{"type":"string","description":"Numeração dos volumes."},"nPesoLiq":{"type":"decimal","description":"Peso líquido (Kg)."},"nPesoBruto":{"type":"decimal","description":"Peso bruto (Kg)."},"nValFrete":{"type":"decimal","description":"Valor do frete."},"nValSeguro":{"type":"decimal","description":"Valor do seguro."},"cLacre":{"type":"string","description":"Número do lacre."},"nValOutras":{"type":"decimal","description":"Valor das outras despesas acessórias."}},"description":"Frete, Transporte e Outras Despesas do Pedido de Compra."},"produtos_consulta":{"type":"array","items":{"type":"object","properties":{"cCodIntItem":{"type":"string","description":"Código de integração do item do pedido de compra (este é o código do item no seu sistema)."},"nCodItem":{"type":"integer","description":"Código interno do item do pedido de compra (este é o código do item no Omie)."},"cCodIntProd":{"type":"string","description":"Código de integração do cadastro do produto (este é o código do produto no seu sistema)."},"nCodProd":{"type":"integer","description":"Código interno do cadastro do produto (este é o código do produto no Omie)."},"cProduto":{"type":"string","description":"Código do item no pedido (pode ser o mesmo código que aparece na NF-e do fornecedor)."},"cDescricao":{"type":"string","description":"Descrição do item no pedido."},"cNCM":{"type":"string","description":"Código NCM do item."},"cEAN":{"type":"string","description":"Código EAN / GTIN do item no pedido."},"cUnidade":{"type":"string","description":"Unidade do item no pedido."},"nPesoLiq":{"type":"decimal","description":"Peso líquido (Kg)."},"nPesoBruto":{"type":"decimal","description":"Peso bruto (Kg)."},"nQtde":{"type":"decimal","description":"Quantidade do item no pedido."},"nValUnit":{"type":"decimal","description":"Valor unitário do item no pedido."},"nValMerc":{"type":"decimal","description":"Valor total do produto (de mercadoria) no pedido."},"nDesconto":{"type":"decimal","description":"Valor do desconto do item no pedido."},"nValorIcms":{"type":"decimal","description":"Valor do ICMS."},"nValorSt":{"type":"decimal","description":"Valor do ICMS ST."},"nValorIpi":{"type":"decimal","description":"Valor do IPI."},"nValorPis":{"type":"decimal","description":"Valor do PIS."},"nValorCofins":{"type":"decimal","description":"Valor do COFINS."},"nFrete":{"type":"decimal","description":"Valor do frete (proporcional para o item do pedido)."},"nSeguro":{"type":"decimal","description":"Valor do seguro (proporcional para o item do pedido)."},"nDespesas":{"type":"decimal","description":"Valor das outras despesas acessórias (proporcional para o item do pedido)."},"nValTot":{"type":"decimal","description":"Valor total do item (considerando descontos, despesas e impostos)."},"cObs":{"type":"string","description":"Observação do item no pedido (elas serão impressas no pedido enviado ao fornecedor)."},"cMkpAtuPv":{"type":"string","description":"Indica que deve atualizar o preço de venda do produto no recebimento."},"cMkpAtuSm":{"type":"string","description":"Indica que deve atualizar o preço apenas se for maior que o atual."},"nMkpPerc":{"type":"decimal","description":"Percentual a ser utilizado para a atualização do preço de venda do produto."},"codigo_local_estoque":{"type":"integer","description":"Código do Local do Estoque. Caso não informado assumirá o Local do Estoque padrão."},"cCodCateg":{"type":"string","description":"Código da categoria de compra do item."},"nQtdeRec":{"type":"decimal","description":"Quantidade recebida do Item."}}},"description":"Produtos do Pedido de Compra."},"parcelas_consulta":{"type":"array","items":{"type":"object","properties":{"nParcela":{"type":"integer","description":"Número da parcela."},"dVencto":{"type":"string","description":"Data de vencimento da parcela."},"nValor":{"type":"decimal","description":"Valor da parcela."},"nDias":{"type":"integer","description":"Dias para vencimento da parcela (a partir da data de previsão de entrega)."},"nPercent":{"type":"decimal","description":"Percentual da parcela em relação ao total do pedido de compra."},"cTipoDoc":{"type":"string","description":"Tipo de Documento. Lista de tipos de documentos em: /api/v1/geral/tiposdoc."}}},"description":"Parcelas do Pedido de Compras."},"departamentos_consulta":{"type":"array","items":{"type":"object","properties":{"cCodDepto":{"type":"string","description":"Código do Departamento."},"nPerc":{"type":"decimal","description":"Percentual de rateio."},"nValor":{"type":"decimal","description":"Valor do rateio."}}},"description":"Departamentos do Pedido de Compras."},"caracteristicas_consulta":{"type":"object","properties":{"cNome":{"type":"string","description":"Nome da Característica do Pedido de Compra."},"cConteudo":{"type":"string","description":"Conteúdo da Característica do Pedido de Compra."}},"description":"Características do Pedido de compra."}}},"description":"Lista com os pedidos de compra."}},"title":"PesquisarPedCompra (retorno)"},"produtos_pedidocompra_UpsertPedCompra":{"type":"object","title":"UpsertPedCompra","description":"Upsert (inclusão ou alteração) de um Pedido de Compra.","required":["call","param"],"properties":{"call":{"type":"string","enum":["UpsertPedCompra"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cabecalho_upsert":{"type":"object","properties":{"nCodPed":{"type":"integer","maxLength":15,"description":"Código interno do pedido de compra (este é o código do pedido no Omie)."},"cCodIntPed":{"type":"string","maxLength":20,"description":"Código de integração do pedido de compra (este é o código do pedido no seu sistema)."},"dDtPrevisao":{"type":"string","maxLength":10,"description":"Data de previsão de entrega do pedido de compra."},"cCodParc":{"type":"string","maxLength":3,"description":"Código da Condição de Pagamento/Parcelamento.\n\n\"999\" - Padrão."},"nQtdeParc":{"type":"integer","maxLength":3,"description":"Quantidade de parcelas do pedido."},"cCnpjCpfFor":{"type":"string","maxLength":20,"description":"CNPJ / CPF\n\nQuando informada as tags nCodFor e cCodIntFor não devem ser informadas."},"nCodFor":{"type":"integer","maxLength":15,"description":"Código interno do fornecedor do pedido (este é o código do fornecedor no Omie)."},"cCodIntFor":{"type":"string","maxLength":20,"description":"Código de integração do fornecedor do pedido (este é o código do fornecedor no seu sistema)."},"cCodCateg":{"type":"string","maxLength":20,"description":"Código da categoria de compra."},"nCodCompr":{"type":"integer","maxLength":15,"description":"Código do comprador do pedido."},"cContato":{"type":"string","maxLength":100,"description":"Nome do contato no fornecedor responsável pelo pedido de compra."},"cContrato":{"type":"string","maxLength":20,"description":"Número do Contrato de Compra.\n\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Compra."},"nCodCC":{"type":"integer","maxLength":15,"description":"Código interno da conta corrente do pedido de compra (este é o código da conta corrente no Omie)."},"nCodIntCC":{"type":"string","maxLength":20,"description":"Código de integração da conta corrente do pedido (este é o código da conta corrente no seu sistema)."},"nCodProj":{"type":"integer","maxLength":15,"description":"Código do projeto relacionado ao pedido de compra."},"cNumPedido":{"type":"string","maxLength":30,"description":"Número do pedido para o fornecedor."},"cObs":{"type":"string","description":"Observações do pedido de compra (elas não serão impressas no pedido enviado ao fornecedor)."},"cObsInt":{"type":"string","description":"Observações internas do pedido (elas serão exibidas apenas para quem consultar o pedido de compra)."},"cEmailAprovador":{"type":"string","maxLength":120,"description":"Informe aqui o E-mail do usúario que irá aprovar o pedido.\nEsse usúario deve ter permissão de acesso para realizar a aprovação.\n\nAo informar esse campo o pedido de compra será atribuído a etapa de aprovação com o status de aprovado."}},"description":"Cabeçalho do Pedido de Compra."},"frete_upsert":{"type":"object","properties":{"nCodTransp":{"type":"integer","maxLength":15,"description":"Código interno da transportadora (este é o código da transportadora no Omie)."},"cCodIntTransp":{"type":"string","maxLength":20,"description":"Código de integração da transportadora (este é o código da transportadora no seu sistema)."},"cTpFrete":{"type":"string","maxLength":1,"description":"Modalidade do frete no pedido."},"cPlaca":{"type":"string","maxLength":7,"description":"Placa do veículo de transporte."},"cUF":{"type":"string","maxLength":2,"description":"UF da placa do veículo do transporte."},"nQtdVol":{"type":"integer","maxLength":15,"description":"Quantidade de volumes."},"cEspVol":{"type":"string","maxLength":60,"description":"Espécie dos volumes."},"cMarVol":{"type":"string","maxLength":60,"description":"Marca dos volumes."},"cNumVol":{"type":"string","maxLength":60,"description":"Numeração dos volumes."},"nPesoLiq":{"type":"number","maxLength":18,"description":"Peso líquido (Kg)."},"nPesoBruto":{"type":"number","maxLength":18,"description":"Peso bruto (Kg)."},"nValFrete":{"type":"number","maxLength":18,"description":"Valor do frete."},"nValSeguro":{"type":"number","maxLength":18,"description":"Valor do seguro."},"cLacre":{"type":"string","maxLength":60,"description":"Número do lacre."},"nValOutras":{"type":"number","maxLength":18,"description":"Valor das outras despesas acessórias."}},"description":"Frete, Transporte e Outras Despesas do Pedido de Compra."},"produtos_upsert":{"type":"array","items":{"type":"object","properties":{"cCodIntItem":{"type":"string","maxLength":20,"description":"Código de integração do item do pedido de compra (este é o código do item no seu sistema)."},"nCodItem":{"type":"integer","maxLength":15,"description":"Código interno do item do pedido de compra (este é o código do item no Omie)."},"cCodIntProd":{"type":"string","maxLength":20,"description":"Código de integração do cadastro do produto (este é o código do produto no seu sistema)."},"nCodProd":{"type":"integer","maxLength":15,"description":"Código interno do cadastro do produto (este é o código do produto no Omie)."},"cProduto":{"type":"string","maxLength":60,"description":"Código do item no pedido (pode ser o mesmo código que aparece na NF-e do fornecedor)."},"cDescricao":{"type":"string","maxLength":120,"description":"Descrição do item no pedido."},"cNCM":{"type":"string","maxLength":13,"description":"Código NCM do item."},"cUnidade":{"type":"string","maxLength":6,"description":"Unidade do item no pedido."},"cEAN":{"type":"string","maxLength":14,"description":"Código EAN / GTIN do item no pedido."},"nPesoLiq":{"type":"number","maxLength":18,"description":"Peso líquido (Kg)."},"nPesoBruto":{"type":"number","maxLength":18,"description":"Peso bruto (Kg)."},"nQtde":{"type":"number","maxLength":18,"description":"Quantidade do item no pedido."},"nValUnit":{"type":"number","maxLength":18,"description":"Valor unitário do item no pedido."},"nDesconto":{"type":"number","maxLength":18,"description":"Valor do desconto do item no pedido."},"nValorIcms":{"type":"number","maxLength":18,"description":"Valor do ICMS."},"nValorSt":{"type":"number","maxLength":18,"description":"Valor do ICMS ST."},"nValorIpi":{"type":"number","maxLength":18,"description":"Valor do IPI."},"nValorPis":{"type":"number","maxLength":18,"description":"Valor do PIS."},"nValorCofins":{"type":"number","maxLength":18,"description":"Valor do COFINS."},"cObs":{"type":"string","description":"Observação do item no pedido (elas serão impressas no pedido enviado ao fornecedor)."},"cMkpAtuPv":{"type":"string","maxLength":1,"description":"Indica que deve atualizar o preço de venda do produto no recebimento."},"cMkpAtuSm":{"type":"string","maxLength":1,"description":"Indica que deve atualizar o preço apenas se for maior que o atual."},"nMkpPerc":{"type":"number","maxLength":10,"description":"Percentual a ser utilizado para a atualização do preço de venda do produto."},"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do Local do Estoque.\n\n\nCaso não informado assumirá o Local do Estoque padrão."},"cCodCateg":{"type":"string","maxLength":20,"description":"Código da categoria de compra do item."}}},"description":"Produtos do Pedido de Compra."},"departamentos_upsert":{"type":"array","items":{"type":"object","properties":{"cCodDepto":{"type":"string","description":"Departamento."},"nPerc":{"type":"number","description":"Percentual de rateio."}},"required":["cCodDepto"]},"description":"Rateio do Pedido de Compra por departamento."},"parcelas_upsert":{"type":"array","items":{"type":"object","properties":{"nParcela":{"type":"integer","maxLength":3,"description":"Número da parcela."},"dVencto":{"type":"string","maxLength":10,"description":"Data de vencimento da parcela."},"nValor":{"type":"number","maxLength":18,"description":"Valor da parcela."},"nDias":{"type":"integer","maxLength":6,"description":"Dias para vencimento da parcela (a partir da data de previsão de entrega)."},"nPercent":{"type":"number","maxLength":9,"description":"Percentual da parcela em relação ao total do pedido de compra."},"cTipoDoc":{"type":"string","description":"Tipo de Documento.\n\nLista de tipos de documentos em:\n/api/v1/geral/tiposdoc."}},"required":["dVencto","nParcela","nPercent","nValor"]},"description":"Parcelas  do Pedido de Compra."},"agropecuario":{"type":"array","items":{"type":"object","properties":{"cNumReceita":{"type":"string","maxLength":20,"description":"Número da receita ou receituário do agrotóxico/defensivo agrícola."},"cCpfResponsavel":{"type":"string","maxLength":14,"description":"CPF do responsável técnico legalmente habilitado."},"nTipoGuia":{"type":"integer","maxLength":1,"description":"Tipo da Guia\n\n1 - Corresponde ao GTA\n2 - Corresponde ao TTA\n3 - Corresponde ao DTA\n4 - Corresponde ao ATV\n5 - Corresponde ao PTV\n6 - Corresponde ao GTV\n7 - Corresponde ao Guia Florestal (DOF, SisFlora - PA e MT, SIAM - MG)."},"cUFGuia":{"type":"string","maxLength":2,"description":"UF de emissão da Guia."},"cSerieGuia":{"type":"string","maxLength":9,"description":"Número de série da guia."},"nNumGuia":{"type":"integer","maxLength":9,"description":"Número da guia."}}}}}}}},"example":{"call":"UpsertPedCompra","param":[{"cabecalho_upsert":{"cCodIntPed":"INT001","dDtPrevisao":"28/12/2026","cCodParc":"","nQtdeParc":3,"nCodFor":"14170458","cCodIntFor":"","cCodCateg":"","nCodCompr":0,"cContato":"","cContrato":"","nCodCC":"1208238","nCodIntCC":0,"nCodProj":0,"cObs":"Pedido alterado via API - Upsert","cObsInt":"Pedido alterado via API - Upsert"},"frete_upsert":{"nCodTransp":0,"cCodIntTransp":"","cTpFrete":"9","cPlaca":"XXX-9999","cUF":"SP","nQtdVol":5,"cEspVol":"","cMarVol":"","cNumVol":"","nPesoLiq":5.0,"nPesoBruto":10.0,"nValFrete":50.0,"nValSeguro":10.0,"cLacre":"","nValOutras":0.0},"departamentos_upsert":[{"cCodDepto":"200000002498904","nPerc":40},{"cCodDepto":"200000002498905","nPerc":30},{"cCodDepto":"200000002498906","nPerc":15},{"cCodDepto":"200000002498907","nPerc":15}],"produtos_upsert":[{"cCodIntItem":"ITEM001","cCodIntProd":"","nCodProd":"2037060","cProduto":"","cDescricao":"","cNCM":"","cUnidade":"","cEAN":"","nPesoLiq":0,"nPesoBruto":0,"nQtde":10,"nValUnit":200,"nDesconto":0.0,"nValorIcms":360.0,"nValorSt":0.0,"nValorIpi":20.0,"nValorPis":33.0,"nValorCofins":152.0,"cObs":"Item alterado via API - Upsert","cMkpAtuPv":"N","cMkpAtuSm":"N","nMkpPerc":0,"codigo_local_estoque":"","cCodCateg":""},{"cCodIntItem":"ITEM002","cCodIntProd":"","nCodProd":"2037060","cProduto":"","cDescricao":"","cNCM":"","cUnidade":"","cEAN":"","nPesoLiq":0,"nPesoBruto":0,"nQtde":20,"nValUnit":200,"nDesconto":0.0,"nValorIcms":720.0,"nValorSt":0.0,"nValorIpi":40.0,"nValorPis":66.0,"nValorCofins":304.0,"cObs":"Item incluído via API - Upsert","cMkpAtuPv":"N","cMkpAtuSm":"N","nMkpPerc":0,"codigo_local_estoque":"","cCodCateg":""}]}]}},"produtos_pedidocompra_UpsertPedCompra_retorno":{"type":"object","properties":{"nCodPed":{"type":"integer","description":"Código interno do pedido de compra (este é o código do pedido de compra no Omie)."},"cCodIntPed":{"type":"string","description":"Código de integração do pedido de compra (este é o código do pedido de compra no seu sistema)."},"cCodStatus":{"type":"string","description":"Código do status."},"cDescStatus":{"type":"string","description":"Descrição do status."},"cNumero":{"type":"string","description":"Número do pedido de compra."}},"title":"UpsertPedCompra (retorno)"},"produtos_pedidoetapas_ListarEtapasPedido":{"type":"object","title":"ListarEtapasPedido","description":"Lista as etapas do Pedido de Venda de Produtos.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarEtapasPedido"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página que se deseja resgatar.\nO padrão é \"1\"."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Número de registros retornados por página.\nO padrão é 20.\nO limite máximo é 50 por página."},"cOrdenarPor":{"type":"string","maxLength":100,"description":"Ordem os resultados da página por:\nCODIGO - Código do Pedido de Venda.\nDATAHORA - Data + Hora da mudança da etapa do pedido."},"cOrdemDecrescente":{"type":"string","maxLength":1,"description":"Indica se a ordem de exibição é Decrescente caso seja informado \"S\"."},"dDtInicial":{"type":"string","maxLength":10,"description":"Data inicial.\nNo formato dd/mm/aaaa."},"dDtFinal":{"type":"string","maxLength":10,"description":"Data final.\nNo formato dd/mm/aaaa."},"cHrInicial":{"type":"string","maxLength":8,"description":"Hora inicial.\nNo formato hh:mm:ss."},"cHrFinal":{"type":"string","maxLength":8,"description":"Hora final.\nNo Formato hh:mm:ss."},"nCodPed":{"type":"integer","maxLength":15,"description":"Código do Pedido de Venda de Produto.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno do Pedido de Venda gerado pelo Omie."},"cCodIntPed":{"type":"string","maxLength":60,"description":"Código de Integração do Pedido de Venda de Produto.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código do Pedido de Venda utilizado no seu aplicativo quando incluir um Pedido no Omie.\nAssim, poderá utilizar esse campo para resgatar as informações do título desejado.\nCaso informe esse campo, não informe a tag cCodIntPed. Caso isso aconteça, o conteúdo dessa tag seja desconsiderada."},"cEtapa":{"type":"string","maxLength":2,"description":"Etapa do Pedido de Venda."}}}}},"example":{"call":"ListarEtapasPedido","param":[{"nPagina":1,"nRegPorPagina":20}]}},"produtos_pedidoetapas_ListarEtapasPedido_retorno":{"type":"object","properties":{"nPagina":{"type":"integer","description":"Número da página resgatada."},"nTotPaginas":{"type":"integer","description":"Número total de páginas encontradas."},"nRegistros":{"type":"integer","description":"Número de registros retornados na página."},"nTotRegistros":{"type":"integer","description":"Número total de registros encontrados."},"etapasPedido":{"type":"array","items":{"type":"object","properties":{"nCodPed":{"type":"integer","description":"Código do Pedido de Venda de Produto."},"cCodIntPed":{"type":"string","description":"Código de Integração do Pedido de Venda de Produto."},"cNumero":{"type":"string","description":"Número do Pedido de Venda. (Visualizado na tela do Omie.)"},"cEtapa":{"type":"string","description":"Etapa do Pedido de Venda."},"dDtEtapa":{"type":"string","description":"Data da Etapa do Pedido de Venda. No formato dd/mm/aaaa."},"cHrEtapa":{"type":"string","description":"Hora da Etapa do Pedido de Venda. No formato hh:mm:ss."},"cUsEtapa":{"type":"string","description":"Usuário que mudou a Etapa do Pedido de Venda."},"faturamento":{"type":"object","properties":{"cFaturado":{"type":"string","description":"Pedido de Vendas foi faturado (S/N)?"},"dDtFat":{"type":"string","description":"Data de Faturamento do Pedido. No formato dd/mm/aaaa."},"cHrFat":{"type":"string","description":"Hora do Faturamento do Pedido. No formato hh:mm:ss."},"cUsDev":{"type":"string","description":"Usuário que realizou o faturamento do pedido."},"cAutorizado":{"type":"string","description":"NFE foi autorizada (S/N)?"},"cDenegado":{"type":"string","description":"NFE foi denegada (S/N)?"},"cDANFE":{"type":"string","description":"DANFE foi gerado (S/N)?"},"cAmbiente":{"type":"string","description":"Ambiente em que a NF-e foi gerada. Pode ser: H - Homologação. P - Produção."},"cChaveNFE":{"type":"string","description":"Chave da NF-e gerada."},"cNumNFE":{"type":"string","description":"Número da NF-e Gerada."},"cSerieNFE":{"type":"string","description":"Série da NF-e gerada."},"dDtSainda":{"type":"string","description":"Data de Saída da NF-e."},"cHrSaida":{"type":"string","description":"Hora de Saída da NF-e."}},"description":"Dados do faturamento."},"cancelamento":{"type":"object","properties":{"cCancelado":{"type":"string","description":"Pedido de Vendas foi cancelado (S/N)?"},"dDtCanc":{"type":"string","description":"Data do Cancelamento do Pedido. No formato dd/mm/aaaa."},"cHrCanc":{"type":"string","description":"Hora do Cancelamento do Pedido. No formato hh:mm:ss."},"cUsCanc":{"type":"string","description":"Usuário que realizou o Cancelamento do pedido."}},"description":"Dados do Cancelamento."},"devolucao":{"type":"object","properties":{"cDevolvido":{"type":"string","description":"Pedido de Vendas foi devolvido (S/N)?"},"dDtDev":{"type":"string","description":"Data da Devolução do Pedido. No formato dd/mm/aaaa."},"cHrDev":{"type":"string","description":"Hora da Devolução do Pedido. No formato hh:mm:ss."},"cUsDev":{"type":"string","description":"Usuário que realizou a devolução do pedido."}},"description":"Dados da Devolução."},"info":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão. No formato dd/mm/aaaa."},"hInc":{"type":"string","description":"Hora da Inclusão. No formato hh:mm:ss."},"uInc":{"type":"string","description":"Usuário da Inclusão."},"dAlt":{"type":"string","description":"Data da Alteração. No formato dd/mm/aaaa."},"hAlt":{"type":"string","description":"Hora da Alteração. No formato hh:mm:ss."},"uAlt":{"type":"string","description":"Usuário da Alteração."},"cImpAPI":{"type":"string","description":"Importado pela API (S/N)."}},"description":"Outras informações do pedido."}}},"description":"Lista de status do pedido encontrados."}},"title":"ListarEtapasPedido (retorno)"},"produtos_pedidovenda_AdicionarPedido":{"type":"object","title":"AdicionarPedido","description":"Inclusão do Pedido de Venda.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AdicionarPedido"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_pedido_integracao":{"type":"string","maxLength":60,"description":"Código de integração do pedido de venda.\n\nPreencha esse campo com o código do pedido no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de pedidos você conseguirá ver a relação entre o id do pedido gerado no Omie e o código de pedido existente em sua aplicação."},"codigo_cliente":{"type":"integer","maxLength":15,"description":"Código do cliente.\n\nUtilize a tag \"codigo_cliente_omie\" do método \"ListarClientes\" da API\nhttp://app.omie.com.br/api/v1/geral/clientes/\npara obter essa informação."},"codigo_cliente_integracao":{"type":"string","maxLength":60,"description":"Código de Integração do Cliente\n\nEsse campo deve ser informado apenas se você incluiu o cliente via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag \"codigo_cliente\"."},"data_previsao":{"type":"string","maxLength":10,"description":"Data de Previsão de Faturamento.\n\nUtilize o formato \"dd/mm/aaaa\".\n\nEsse campo indica a data da previsão do faturamento do pedido e deve ser informado com uma data igual ou superior a data corrente."},"etapa":{"type":"string","maxLength":2,"description":"Etapa do pedido de venda.\n\nEsse campo indica em que coluna o pedido de venda irá figurar no processo de faturamento do Omie.\n\nUtilize a tag \"codigo\" do método \"ListarEtapasFaturamento\" da API\nhttp://app.omie.com.br/api/v1/produtos/etapafat/\npara obter essa informação.\n\nOs valores são fixos, mas as descrições (funções atribuídas a cada coluna pode mudar. A API irá indicar a descrição de cada coluna.\n\nOs valores disponíveis para esse campo podem ser:\n\n\"10\" - Primeira coluna\n\"20\" - Segunda coluna\n\"30\" - Terceira coluna\n\"40\" - Quarta coluna\n\"50\" - Faturar."},"codigo_parcela":{"type":"string","maxLength":3,"description":"Código da parcela/Condição de pagamento.\n\nUtilize a tag \"nCodigo\" do método \"ListarFormasPagVendas\" da API\nhttp://app.omie.com.br/api/v1/produtos/formaspagvendas/\npara obter essa informação.\n\nO código \"999\" é o único que permite uma definição de forma de pagamento customizada. Caso você escolha essa opção, deve também informar a tag \"qtde_parcelas\" e a estrutura \"lista_parcelas\".\n\nAlguns dos valores disponíveis são:\n\n\"000\" - A Vista\n\"A03\" - Para 3 dias\n\"A05\" - Para 5 dias\n\"A07\" - Para 7 dias\n\"A08\" - Para 8 dias\n\"A09\" - Para 9 dias\n\"A10\" - Para 10 dias\n\"A13\" - Para 13 dias\n\"A14\" - Para 14 dias\n\"A15\" - Para 15 dias\n\"A17\" - Para 17 dias\n\"A20\" - Para 20 dias\n\"A21\" - Para 21 dias\n\"A25\" - Para 25 dias\n\"A26\" - Para 26 dias\n\"A28\" - Para 28 dias\n\"A35\" - Para 35 dias\n\"A36\" - Para 36 dias\n\"A40\" - Para 40 dias\n\"A42\" - Para 42 dias\n\"A45\" - Para 45 dias\n\"A50\" - Para 50 dias\n\"A56\" - Para 56 dias\n\"A60\" - Para 60 dias\n\"A70\" - Para 70 dias\n\"A75\" - Para 75 dias\n\"A90\" - Para 90 dias\n\"A98\" - Para 98 dias\n\"B20\" - Para 120 dias\n\"001\" - 1 Parcela (para 30 dias)\n\"002\" - 2 Parcelas\n\"003\" - 3 Parcelas\n\"004\" - 4 Parcelas\n\"005\" - 5 Parcelas\n\"006\" - 6 Parcelas\n\"007\" - 7 Parcelas\n\"010\" - 10 Parcelas\n\"012\" - 12 Parcelas\n\"024\" - 24 Parcelas\n\"036\" - 36 Parcelas\n\"048\" - 48 Parcelas\n\"S01\" - 30/60\n\"S02\" - 45/60\n\"S03\" - 21/28/35\n\"S04\" - 21/28/35/42\n\"S05\" - 28/35/42\n\"S06\" - 28/35/42/49\n\"S07\" - 30/45/60/75/90\n\"S08\" - 25/56\n\"S09\" - 30/45\n\"S10\" - 28/56\n\"S11\" - 10/30/60\n\"S12\" - 15/30/60\n\"S13\" - 28/35\n\"S14\" - 7/14/21\n\"S15\" - 10/30/60/90\n\"S16\" - 60/90/120\n\"S17\" - 45/60/90\n\"S18\" - 30/60/90\n\"S19\" - 14/21\n\"S20\" - 7/14\n\"S21\" - 14/21/28\n\"S22\" - 45/75\n\"S23\" - 30/45/60\n\"S24\" - 3/20/40\n\"S25\" - 30/60/90/120\n\"S26\" - 21/28\n\"S27\" - a Vista/15\n\"S28\" - a Vista/30\n\"S29\" - a Vista/30/60\n\"S30\" - a Vista/30/60/90\n\"S31\" - a Vista/30/60/90/120/150\n\"S41\" - 28/42/56\n\"S32\" - 15/45/75\n\"S33\" - 14/28/42\n\"S34\" - 14/21/28/35/42\n\"S35\" - 30/42/54/66/78/90\n\"S36\" - 14/21/28/35\n\"S37\" - 28/42\n\"S38\" - 30/45/60\n\"S39\" - 35/42/49/56\n\"S40\" - 28/42/56/70\n\"S42\" - 30/40/50/60\n\"S43\" - 30/50/70/90\n\"S44\" - 14/28\n\"S45\" - 45/60/75/90\n\"S46\" - a Vista/30/60/90/120\n\"S47\" - a vista/20/40/60\n\"S48\" - 21/42\n\"S49\" - 15/30/45\n\"S50\" - 14/42\n\"S51\" - 21/35\n\"S52\" - 28/56/84\n\"S53\" - 28/42/56/70/84\n\"S54\" - a Vista/30/45\n\"S55\" - 21/45\n\"S56\" - a Vista/28\n\"S57\" - a Vista/60/90\n\"S58\" - 35/45/55\n\"S59\" - 28/35/42/56\n\"S60\" - 30/45/60/75\n\"S61\" - 28/35/42/49/56\n\"S62\" - 40/70/100\n\"S63\" - 42/56\n\"S64\" - a Vista/28/35\n\"S65\" - 35/42\n\"S66\" - 20/40\n\"S67\" - a Vista/28/35/42"},"origem_pedido":{"type":"string","maxLength":3,"description":"Origem do Pedido.\n\nDefault:\nAPI - Importado via API.\nMLV - Mercado Livre."},"codigo_cenario_impostos":{"type":"integer","maxLength":15,"description":"Código do Cenário de Impostos.\n\nSe não informado, será assumido o cenário padrão."},"codigo_categoria":{"type":"string","maxLength":20,"description":"Código da categoria.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda.\n\nUtilize a tag \"codigo\" do método \"ListarCategorias\" da API\nhttp://app.omie.com.br/api/v1/geral/categorias/\npara obter essa informação."},"codigo_conta_corrente":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda.\n\nUtilize a tag \"codigo\" do método \"PesquisarContaCorrente\" da API\nhttp://app.omie.com.br/api/v1/geral/contacorrente/\npara obter essa informação."},"numero_pedido_cliente":{"type":"string","maxLength":30,"description":"Número do pedido do cliente.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"numero_contrato":{"type":"string","maxLength":20,"description":"Número do Contrato de Venda.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"contato":{"type":"string","maxLength":100,"description":"Contato.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"consumidor_final":{"type":"string","maxLength":1,"description":"Nota Fiscal para Consumo Final.\n\nInformar \"S\" ou \"N\".\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"utilizar_emails":{"type":"string","description":"Utilizar os seguintes endereços de e-mail.\n\nInformar a lista de e-mail que receberão a Nota Fiscal.\nUtilize a virgula (,) como separador.\n\nInformação localizada na Aba \"E-mail para o Cliente\" do Pedido de Venda."},"enviar_email":{"type":"string","maxLength":1,"description":"Enviar e-mail com o boleto de cobrança gerado pelo faturamento (juntamente com o DANFE e o XML da NF-e).\n\nInformar \"S\" ou \"N\".\nDefault \"N\"\n\nInformação localizada na Aba \"E-mail para o Cliente\" do Pedido de Venda.\n\nÉ permitido somente o preenchimento de uma das tags \"enviar_pix\" ou \"enviar_email\"."},"enviar_pix":{"type":"string","maxLength":1,"description":"Enviar e-mail com o PIX de cobrança gerado pelo faturamento (juntamente com o DANFE e o XML da NF-e).\n\nInformar \"S\" ou \"N\".\nDefault \"N\"\n\nInformação localizada na Aba \"E-mail para o Cliente\" do Pedido de Venda.\n\nÉ permitido somente o preenchimento de uma das tags \"enviar_pix\" ou \"enviar_email\"."},"codVend":{"type":"integer","maxLength":15,"description":"Código do Vendedor.\n\nInformação localizada no cabeçalho do Pedido de Venda.\n\nUtilize a tag \"codigo\" do método \"ListarVendedores\" da API\nhttp://app.omie.com.br/api/v1/geral/vendedores/\npara obter essa informação."},"codProj":{"type":"integer","maxLength":15,"description":"Código do Projeto.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda.\n\nUtilize a tag \"codigo\" do método \"ListarProjetos\" da API\nhttp://app.omie.com.br/api/v1/geral/projetos/\npara obter essa informação."},"dados_adicionais_nf":{"type":"string","description":"Dados adicionais para a Nota Fiscal.\n\nUtilize o caracter pipe ( | ) como separador de linha.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"itens":{"type":"array","items":{"type":"object","properties":{"codigo_pedido":{"type":"integer","maxLength":15,"description":"ID do pedido do venda.\nIdentificação do pedido de venda, esse campo não é exibido na tela do Omie.\nÉ uma informação interna, utilizada apenas nas APIs."},"codigo_produto":{"type":"integer","maxLength":15,"description":"ID do Produto.\n\nEsse campo não é exibido na tela do Pedido de Vendas.\nÉ uma informação interna, utilizada apenas nas APIs.\n\nUtilize a tag \"codigo_produto\" do método \"ListarProdutos\" da API\nhttp://app.omie.com.br/api/v1/geral/produtos/\npara obter essa informação."},"quantidade":{"type":"number","maxLength":18,"description":"Quantidade."},"cfop":{"type":"string","maxLength":10,"description":"CFOP - Código Fiscal de Operações e Prestações.\n\nUtilize a tag \"nCodigo\" do método \"ListarCFOP\" da API\n/api/v1/produtos/cfop/\npara obter essa informação."},"valor_unitario":{"type":"number","maxLength":18,"description":"Valor Unitário."},"tipo_desconto":{"type":"string","maxLength":1,"description":"Tipo de Desconto.\nPode ser:\nV - Valor\nP - Percentual\n\n\nAo informar o desconto na capa do pedido o mesmo será distribuído proporcionalmente para os itens. Uma vez realizada a distribuição os valores do desconto serão exibidos apenas nos itens.\n\nIMPORTANTE:\n- Não será permitido informar desconto na capa caso já exista distribuição pelos itens.\n- Na alteração o desconto será aplicado para todos os itens do pedido."},"percentual_desconto":{"type":"number","maxLength":18,"description":"Percentual de Desconto.\n\nAo informar o desconto na capa do pedido o mesmo será distribuído proporcionalmente para os itens. Uma vez realizada a distribuição os valores do desconto serão exibidos apenas nos itens.\n\nIMPORTANTE:\n- Não será permitido informar desconto na capa caso já exista distribuição pelos itens.\n- Na alteração o desconto será aplicado para todos os itens do pedido."},"valor_desconto":{"type":"number","maxLength":18,"description":"Valor do Desconto\n\nAo informar o desconto na capa do pedido o mesmo será distribuído proporcionalmente para os itens. Uma vez realizada a distribuição os valores do desconto serão exibidos apenas nos itens.\n\nIMPORTANTE:\n- Não será permitido informar desconto na capa caso já exista distribuição pelos itens.\n- Na alteração o desconto será aplicado para todos os itens do pedido.\n- Se o desconto for superior ao valor do pedido ele não será aplicado."},"codigo_tabela_preco":{"type":"integer","maxLength":15,"description":"Código da tabela de preço.\n\n(Código Interno, utilizado apenas na integração via API, não é exibido na tela).\nDeve ser informada opcionalmente, caso a tabela de preços esteja configurada no Omie."},"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do Local do Estoque."},"codigo_cenario_impostos_item":{"type":"integer","maxLength":15,"description":"Código do Cenário de Impostos."},"numero_pedido_compra":{"type":"string","maxLength":15,"description":"Número do Pedido de Compra."},"item_pedido_compra":{"type":"integer","maxLength":6,"description":"Item do Pedido de Compra."},"quantidade_trib":{"type":"number","maxLength":19},"unidade_trib":{"type":"string","maxLength":6},"dados_adicionais_item":{"type":"string","description":"Informações para a Nota Fiscal."},"nao_movimentar_estoque":{"type":"string","maxLength":1,"description":"Não gerar a saída de estoque deste item ao emitir NF-e.\n\nInformar \"S\" ou \"N\".\n(informe \"S\" para ativar essa opção)."},"nao_gerar_financeiro":{"type":"string","maxLength":1,"description":"Não gerar conta a receber para este item.\n\nInformar \"S\" ou \"N\".\n(Informe \"S\" para ativar essa opção)."},"nao_somar_total":{"type":"string","maxLength":1},"codigo_categoria_item":{"type":"string","maxLength":20,"description":"Código da Categoria do item."},"obs_item":{"type":"string","description":"Observações do item (elas não serão exibidas na Nota Fisca, mas serão impressas no pedido de venda).\n\nInformação localizada na Aba \"Observações\" do Item do Pedido de Venda."},"lote_validade":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","maxLength":15,"description":"Id do Lote do produto.\n\nObrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.."},"nQtdLote":{"type":"number","maxLength":18,"description":"Informe aqui a quantidade do Lote para o produto.\n\nÉ obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações."}},"required":["nIdLote","nQtdLote"]},"description":"Informações referentes ao lote e validade do produto.\n\nA tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes \"manualmente\" por API."},"numero_recopi":{"type":"string","maxLength":20,"description":"Número do registro gerado pelo sistema RECOPI Nacional (Reconhecimento e Controle das Operações com Papel Imune)."}}},"description":"Array de Itens do pedido de Venda."}},"required":["codigo_pedido_integracao"]}}},"example":{"call":"AdicionarPedido","param":[{"codigo_pedido_integracao":"PED0001","codigo_cliente":123456,"itens":{"codigo_produto":654321,"quantidade":2,"valor_unitario":150.0}}]}},"produtos_pedidovenda_AdicionarPedido_retorno":{"type":"object","properties":{"codigo_pedido":{"type":"integer","description":"ID do pedido do venda. Identificação do pedido de venda, esse campo não é exibido na tela do Omie. É uma informação interna, utilizada apenas nas APIs."},"codigo_status":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro duranteo o processamento da solicitação. A tag \"codigo_status\" descreve o problema ocorrido."},"descricao_status":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"codigo_status\"."},"numero_pedido":{"type":"string"}},"title":"AdicionarPedido (retorno)"},"produtos_pedidovenda_AlterarItemPedido":{"type":"object","title":"AlterarItemPedido","description":"Altera um item no pedido de venda.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarItemPedido"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_pedido":{"type":"integer","maxLength":15,"description":"ID do pedido do venda.\nIdentificação do pedido de venda, esse campo não é exibido na tela do Omie.\nÉ uma informação interna, utilizada apenas nas APIs."},"codigo_item":{"type":"integer","maxLength":15,"description":"ID do Item do Pedido."},"codigo_item_integracao":{"type":"string","maxLength":30,"description":"Código de Integração do Item do Pedido de Venda.\n\nInforme a identificação do Item do Pedido de Venda. Caso você não tenha essa informação no seu aplicativo, informe o número sequencial de cada item do pedido.\n\nInforma de 1 a 199."},"codigo_produto":{"type":"integer","maxLength":15,"description":"ID do Produto.\n\nEsse campo não é exibido na tela do Pedido de Vendas.\nÉ uma informação interna, utilizada apenas nas APIs.\n\nUtilize a tag \"codigo_produto\" do método \"ListarProdutos\" da API\nhttp://app.omie.com.br/api/v1/geral/produtos/\npara obter essa informação."},"quantidade":{"type":"number","maxLength":18,"description":"Quantidade."},"cfop":{"type":"string","maxLength":10,"description":"Utilize a tag \"nCodigo\" do método \"ListarCFOP\" da API\n/api/v1/produtos/cfop/\npara obter essa informação."},"valor_unitario":{"type":"number","maxLength":18,"description":"Valor Unitário."},"tipo_desconto":{"type":"string","maxLength":1,"description":"Tipo de Desconto.\nPode ser:\nV - Valor\nP - Percentual\n\n\nAo informar o desconto na capa do pedido o mesmo será distribuído proporcionalmente para os itens. Uma vez realizada a distribuição os valores do desconto serão exibidos apenas nos itens.\n\nIMPORTANTE:\n- Não será permitido informar desconto na capa caso já exista distribuição pelos itens.\n- Na alteração o desconto será aplicado para todos os itens do pedido."},"percentual_desconto":{"type":"number","maxLength":18,"description":"Percentual de Desconto.\n\nAo informar o desconto na capa do pedido o mesmo será distribuído proporcionalmente para os itens. Uma vez realizada a distribuição os valores do desconto serão exibidos apenas nos itens.\n\nIMPORTANTE:\n- Não será permitido informar desconto na capa caso já exista distribuição pelos itens.\n- Na alteração o desconto será aplicado para todos os itens do pedido."},"valor_desconto":{"type":"number","maxLength":18,"description":"Valor do Desconto\n\nAo informar o desconto na capa do pedido o mesmo será distribuído proporcionalmente para os itens. Uma vez realizada a distribuição os valores do desconto serão exibidos apenas nos itens.\n\nIMPORTANTE:\n- Não será permitido informar desconto na capa caso já exista distribuição pelos itens.\n- Na alteração o desconto será aplicado para todos os itens do pedido.\n- Se o desconto for superior ao valor do pedido ele não será aplicado."},"codigo_tabela_preco":{"type":"integer","maxLength":15,"description":"Código da tabela de preço.\n\n(Código Interno, utilizado apenas na integração via API, não é exibido na tela).\nDeve ser informada opcionalmente, caso a tabela de preços esteja configurada no Omie."},"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do Local do Estoque."},"lote_validade":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","maxLength":15,"description":"Id do Lote do produto.\n\nObrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.."},"nQtdLote":{"type":"number","maxLength":18,"description":"Informe aqui a quantidade do Lote para o produto.\n\nÉ obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações."}},"required":["nIdLote","nQtdLote"]},"description":"Informações referentes ao lote e validade do produto.\n\nA tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes \"manualmente\" por API."},"codigo_cenario_impostos_item":{"type":"integer","maxLength":15,"description":"Código do Cenário de Impostos."},"numero_pedido_compra":{"type":"string","maxLength":15,"description":"Número do Pedido de Compra."},"item_pedido_compra":{"type":"integer","maxLength":6,"description":"Item do Pedido de Compra."},"quantidade_trib":{"type":"number","maxLength":19},"unidade_trib":{"type":"string","maxLength":6},"dados_adicionais_item":{"type":"string","description":"Informações para a Nota Fiscal."},"nao_movimentar_estoque":{"type":"string","maxLength":1,"description":"Não gerar a saída de estoque deste item ao emitir NF-e.\n\nInformar \"S\" ou \"N\".\n(informe \"S\" para ativar essa opção)."},"nao_gerar_financeiro":{"type":"string","maxLength":1,"description":"Não gerar conta a receber para este item.\n\nInformar \"S\" ou \"N\".\n(Informe \"S\" para ativar essa opção)."},"nao_somar_total":{"type":"string","maxLength":1},"codigo_categoria_item":{"type":"string","maxLength":20,"description":"Código da Categoria do item."},"obs_item":{"type":"string","description":"Observações do item (elas não serão exibidas na Nota Fisca, mas serão impressas no pedido de venda).\n\nInformação localizada na Aba \"Observações\" do Item do Pedido de Venda."},"numero_recopi":{"type":"string","maxLength":20,"description":"Número do registro gerado pelo sistema RECOPI Nacional (Reconhecimento e Controle das Operações com Papel Imune)."}},"required":["codigo_pedido"]}}},"example":{"call":"AlterarItemPedido","param":[{"codigo_pedido":123456789,"codigo_item":1,"quantidade":3,"valor_unitario":145.0}]}},"produtos_pedidovenda_AlterarItemPedido_retorno":{"type":"object","properties":{"codigo_pedido":{"type":"integer","description":"ID do pedido do venda. Identificação do pedido de venda, esse campo não é exibido na tela do Omie. É uma informação interna, utilizada apenas nas APIs."},"codigo_item_integracao":{"type":"string","description":"Código de Integração do Item do Pedido de Venda. Informe a identificação do Item do Pedido de Venda. Caso você não tenha essa informação no seu aplicativo, informe o número sequencial de cada item do pedido. Informa de 1 a 199."},"codigo_item":{"type":"integer","description":"ID do Item do Pedido."},"codigo_status":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro duranteo o processamento da solicitação. A tag \"codigo_status\" descreve o problema ocorrido."},"descricao_status":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"codigo_status\"."}},"title":"AlterarItemPedido (retorno)"},"produtos_pedidovenda_ExcluirItemPedido":{"type":"object","title":"ExcluirItemPedido","description":"Exclui um item no pedido de venda.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirItemPedido"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_pedido":{"type":"integer","maxLength":15,"description":"ID do pedido do venda.\nIdentificação do pedido de venda, esse campo não é exibido na tela do Omie.\nÉ uma informação interna, utilizada apenas nas APIs."},"codigo_item":{"type":"integer","maxLength":15,"description":"ID do Item do Pedido."},"codigo_item_integracao":{"type":"string","maxLength":30,"description":"Código de Integração do Item do Pedido de Venda.\n\nInforme a identificação do Item do Pedido de Venda. Caso você não tenha essa informação no seu aplicativo, informe o número sequencial de cada item do pedido.\n\nInforma de 1 a 199."}},"required":["codigo_pedido"]}}},"example":{"call":"ExcluirItemPedido","param":[{"codigo_pedido":123456789,"codigo_item":1}]}},"produtos_pedidovenda_ExcluirItemPedido_retorno":{"type":"object","properties":{"codigo_pedido":{"type":"integer","description":"ID do pedido do venda. Identificação do pedido de venda, esse campo não é exibido na tela do Omie. É uma informação interna, utilizada apenas nas APIs."},"codigo_item_integracao":{"type":"string","description":"Código de Integração do Item do Pedido de Venda. Informe a identificação do Item do Pedido de Venda. Caso você não tenha essa informação no seu aplicativo, informe o número sequencial de cada item do pedido. Informa de 1 a 199."},"codigo_item":{"type":"integer","description":"ID do Item do Pedido."},"codigo_status":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro duranteo o processamento da solicitação. A tag \"codigo_status\" descreve o problema ocorrido."},"descricao_status":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"codigo_status\"."}},"title":"ExcluirItemPedido (retorno)"},"produtos_pedidovenda_ExcluirItensPedido":{"type":"object","title":"ExcluirItensPedido","description":"Exclui todos os itens do pedido de venda.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirItensPedido"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_pedido":{"type":"integer","maxLength":15,"description":"ID do pedido do venda.\nIdentificação do pedido de venda, esse campo não é exibido na tela do Omie.\nÉ uma informação interna, utilizada apenas nas APIs."}},"required":["codigo_pedido"]}}},"example":{"call":"ExcluirItensPedido","param":[{"codigo_pedido":123456789}]}},"produtos_pedidovenda_ExcluirItensPedido_retorno":{"type":"object","properties":{"codigo_pedido":{"type":"integer","description":"ID do pedido do venda. Identificação do pedido de venda, esse campo não é exibido na tela do Omie. É uma informação interna, utilizada apenas nas APIs."},"codigo_status":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro duranteo o processamento da solicitação. A tag \"codigo_status\" descreve o problema ocorrido."},"descricao_status":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"codigo_status\"."}},"title":"ExcluirItensPedido (retorno)"},"produtos_pedidovenda_IncluirItemPedido":{"type":"object","title":"IncluirItemPedido","description":"Inclui um item no pedido de venda.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirItemPedido"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_pedido":{"type":"integer","maxLength":15,"description":"ID do pedido do venda.\nIdentificação do pedido de venda, esse campo não é exibido na tela do Omie.\nÉ uma informação interna, utilizada apenas nas APIs."},"codigo_item_integracao":{"type":"string","maxLength":30,"description":"Código de Integração do Item do Pedido de Venda.\n\nInforme a identificação do Item do Pedido de Venda. Caso você não tenha essa informação no seu aplicativo, informe o número sequencial de cada item do pedido.\n\nInforma de 1 a 199."},"codigo_produto":{"type":"integer","maxLength":15,"description":"ID do Produto.\n\nEsse campo não é exibido na tela do Pedido de Vendas.\nÉ uma informação interna, utilizada apenas nas APIs.\n\nUtilize a tag \"codigo_produto\" do método \"ListarProdutos\" da API\nhttp://app.omie.com.br/api/v1/geral/produtos/\npara obter essa informação."},"quantidade":{"type":"number","maxLength":18,"description":"Quantidade."},"cfop":{"type":"string","maxLength":10,"description":"Utilize a tag \"nCodigo\" do método \"ListarCFOP\" da API\n/api/v1/produtos/cfop/\npara obter essa informação."},"valor_unitario":{"type":"number","maxLength":18,"description":"Valor Unitário."},"tipo_desconto":{"type":"string","maxLength":1,"description":"Tipo de desconto para o pedido.\nPode ser:\nV - Valor\nP - Percentual\n\n\nAo informar o desconto na capa do pedido o mesmo será distribuído proporcionalmente para os itens. Uma vez realizada a distribuição os valores do desconto serão exibidos apenas nos itens.\n\nIMPORTANTE:\n- Não será permitido informar desconto na capa caso já exista distribuição pelos itens.\n- Na alteração o desconto será aplicado para todos os itens do pedido."},"percentual_desconto":{"type":"number","maxLength":18,"description":"Percentual de Desconto.\n\nAo informar o desconto na capa do pedido o mesmo será distribuído proporcionalmente para os itens. Uma vez realizada a distribuição os valores do desconto serão exibidos apenas nos itens.\n\nIMPORTANTE:\n- Não será permitido informar desconto na capa caso já exista distribuição pelos itens.\n- Na alteração o desconto será aplicado para todos os itens do pedido."},"valor_desconto":{"type":"number","maxLength":18,"description":"Valor do Desconto\n\nAo informar o desconto na capa do pedido o mesmo será distribuído proporcionalmente para os itens. Uma vez realizada a distribuição os valores do desconto serão exibidos apenas nos itens.\n\nIMPORTANTE:\n- Não será permitido informar desconto na capa caso já exista distribuição pelos itens.\n- Na alteração o desconto será aplicado para todos os itens do pedido.\n- Se o desconto for superior ao valor do pedido ele não será aplicado."},"codigo_tabela_preco":{"type":"integer","maxLength":15,"description":"Código da tabela de preço.\n\n(Código Interno, utilizado apenas na integração via API, não é exibido na tela).\nDeve ser informada opcionalmente, caso a tabela de preços esteja configurada no Omie."},"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do Local do Estoque."},"codigo_cenario_impostos_item":{"type":"integer","maxLength":15,"description":"Código do Cenário de Impostos."},"numero_pedido_compra":{"type":"string","maxLength":15,"description":"Item do Pedido de Compra."},"item_pedido_compra":{"type":"integer","maxLength":6,"description":"Item do Pedido de Compra."},"quantidade_trib":{"type":"number","maxLength":19},"unidade_trib":{"type":"string","maxLength":6},"dados_adicionais_item":{"type":"string","description":"Informações para a Nota Fiscal."},"nao_movimentar_estoque":{"type":"string","maxLength":1,"description":"Não gerar a saída de estoque deste item ao emitir NF-e.\n\nInformar \"S\" ou \"N\".\n(informe \"S\" para ativar essa opção)."},"nao_gerar_financeiro":{"type":"string","maxLength":1,"description":"Não gerar conta a receber para este item.\n\nInformar \"S\" ou \"N\".\n(Informe \"S\" para ativar essa opção)."},"nao_somar_total":{"type":"string","maxLength":1},"codigo_categoria_item":{"type":"string","maxLength":20,"description":"Código da Categoria do item."},"obs_item":{"type":"string","description":"Observações do item (elas não serão exibidas na Nota Fisca, mas serão impressas no pedido de venda).\n\nInformação localizada na Aba \"Observações\" do Item do Pedido de Venda."},"lote_validade":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","maxLength":15,"description":"Id do Lote do produto.\n\nObrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.."},"nQtdLote":{"type":"number","maxLength":18,"description":"Informe aqui a quantidade do Lote para o produto.\n\nÉ obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações."}},"required":["nIdLote","nQtdLote"]},"description":"Informações referentes ao lote e validade do produto.\n\nA tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes \"manualmente\" por API."},"numero_recopi":{"type":"string","maxLength":20,"description":"Número do registro gerado pelo sistema RECOPI Nacional (Reconhecimento e Controle das Operações com Papel Imune)."}},"required":["codigo_pedido","codigo_produto","quantidade","valor_unitario"]}}},"example":{"call":"IncluirItemPedido","param":[{"codigo_pedido":123456789,"codigo_produto":654321,"quantidade":2,"valor_unitario":150.0}]}},"produtos_pedidovenda_IncluirItemPedido_retorno":{"type":"object","properties":{"codigo_pedido":{"type":"integer","description":"ID do pedido do venda. Identificação do pedido de venda, esse campo não é exibido na tela do Omie. É uma informação interna, utilizada apenas nas APIs."},"codigo_item_integracao":{"type":"string","description":"Código de Integração do Item do Pedido de Venda. Informe a identificação do Item do Pedido de Venda. Caso você não tenha essa informação no seu aplicativo, informe o número sequencial de cada item do pedido. Informa de 1 a 199."},"codigo_item":{"type":"integer","description":"ID do Item do Pedido."},"codigo_status":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro duranteo o processamento da solicitação. A tag \"codigo_status\" descreve o problema ocorrido."},"descricao_status":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"codigo_status\"."}},"title":"IncluirItemPedido (retorno)"},"produtos_pedidovenda_TotalizarPedido":{"type":"object","title":"TotalizarPedido","description":"Recalcula os totais do pedido de venda.","required":["call","param"],"properties":{"call":{"type":"string","enum":["TotalizarPedido"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codigo_pedido":{"type":"integer","maxLength":15,"description":"ID do pedido do venda.\nIdentificação do pedido de venda, esse campo não é exibido na tela do Omie.\nÉ uma informação interna, utilizada apenas nas APIs."}},"required":["codigo_pedido"]}}},"example":{"call":"TotalizarPedido","param":[{"codigo_pedido":123456789}]}},"produtos_pedidovenda_TotalizarPedido_retorno":{"type":"object","properties":{"codigo_pedido":{"type":"integer","description":"ID do pedido do venda. Identificação do pedido de venda, esse campo não é exibido na tela do Omie. É uma informação interna, utilizada apenas nas APIs."},"codigo_status":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro duranteo o processamento da solicitação. A tag \"codigo_status\" descreve o problema ocorrido."},"descricao_status":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"codigo_status\"."}},"title":"TotalizarPedido (retorno)"},"produtos_pedidovendaanexos_pvaConsultarAnexo":{"type":"object","title":"pvaConsultarAnexo","description":"Consulta um anexo de um Pedido de Vendas.","required":["call","param"],"properties":{"call":{"type":"string","enum":["pvaConsultarAnexo"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodPed":{"type":"integer","maxLength":15,"description":"Código interno do pedido de venda. Informe este ou cCodIntPed."},"cCodIntPed":{"type":"string","maxLength":60,"description":"Código de integração do pedido de venda. Informe este ou nCodPed."},"cCodIntAnexo":{"type":"string","maxLength":20,"description":"Código de integração do anexo, informado na inclusão. Usado na busca quando cNomeArq não é informado."},"cNomeArq":{"type":"string","maxLength":100,"description":"Nome do arquivo anexado.\nCom cNomeArq preenchido a busca é pelo nome do arquivo e cCodIntAnexo é ignorado."}}}}},"example":{"call":"pvaConsultarAnexo","param":[{"nCodPed":3478512690,"cCodIntAnexo":"ANX-000123"}]}},"produtos_pedidovendaanexos_pvaConsultarAnexo_retorno":{"type":"object","properties":{"nCodPed":{"type":"integer","description":"Código do Pedido de Venda."},"cCodIntPed":{"type":"string","description":"Código de integração do Pedido de Venda."},"cCodIntAnexo":{"type":"string","description":"Código de integração do anexo."},"cNomeArq":{"type":"string","description":"Nome do arquivo anexado."},"cTipoArq":{"type":"string","description":"Tipo de Arquivo."},"info":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão. No formato dd/mm/aaaa."},"hInc":{"type":"string","description":"Hora da Inclusão. No formato hh:mm:ss."},"uInc":{"type":"string","description":"Usuário da Inclusão."},"dAlt":{"type":"string","description":"Data da Alteração. No formato dd/mm/aaaa."},"hAlt":{"type":"string","description":"Hora da Alteração. No formato hh:mm:ss."},"uAlt":{"type":"string","description":"Usuário da Alteração."},"cImpAPI":{"type":"string","description":"Importado pela API (S/N)."}},"description":"Informações complementares do anexo."}},"title":"pvaConsultarAnexo (retorno)"},"produtos_pedidovendaanexos_pvaExcluirAnexo":{"type":"object","title":"pvaExcluirAnexo","description":"Exclui um anexo de um Pedido de Vendas.","required":["call","param"],"properties":{"call":{"type":"string","enum":["pvaExcluirAnexo"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodPed":{"type":"integer","maxLength":15,"description":"Código interno do pedido de venda. Informe este ou cCodIntPed."},"cCodIntPed":{"type":"string","maxLength":60,"description":"Código de integração do pedido de venda. Informe este ou nCodPed."},"cCodIntAnexo":{"type":"string","maxLength":20,"description":"Código de integração do anexo, informado na inclusão. Usado na busca quando cNomeArq não é informado."},"cNomeArq":{"type":"string","maxLength":100,"description":"Nome do arquivo anexado.\nCom cNomeArq preenchido a busca é pelo nome do arquivo e cCodIntAnexo é ignorado."}}}}},"example":{"call":"pvaExcluirAnexo","param":[{"nCodPed":3478512690,"cCodIntAnexo":"ANX-000123"}]}},"produtos_pedidovendaanexos_pvaExcluirAnexo_retorno":{"type":"object","properties":{"nCodPed":{"type":"integer","description":"Código do Pedido de Venda."},"cCodIntPed":{"type":"string","description":"Código de integração do Pedido de Venda."},"cCodIntAnexo":{"type":"string","description":"Código de integração do anexo."},"cNomeArq":{"type":"string","description":"Nome do arquivo anexado."},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro duranteo o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodigoStatus\"."}},"title":"pvaExcluirAnexo (retorno)"},"produtos_pedidovendaanexos_pvaIncluirAnexo":{"type":"object","title":"pvaIncluirAnexo","description":"Inclui um anexo no Pedido de Vendas.","required":["call","param"],"properties":{"call":{"type":"string","enum":["pvaIncluirAnexo"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodPed":{"type":"integer","maxLength":15,"description":"Código interno do pedido de venda. Informe este ou cCodIntPed."},"cCodIntPed":{"type":"string","maxLength":60,"description":"Código de integração do pedido de venda. Informe este ou nCodPed."},"cCodIntAnexo":{"type":"string","maxLength":20,"description":"Código de integração do anexo no seu sistema, para achá-lo depois. Obrigatório; use um código único."},"cNomeArq":{"type":"string","maxLength":100,"description":"Nome do arquivo dentro do zip enviado em cArquivo, com extensão. Obrigatório. Não pode repetir o nome de outro anexo do pedido."},"cTipoArq":{"type":"string","maxLength":10,"description":"Tipo do anexo, que precisa estar cadastrado. \"ZPL-LABEL\" ou \"PDF-LABEL\" marcam o arquivo como etiqueta do pedido."},"cArquivo":{"type":"string","description":"Conteúdo do arquivo compactado em zip e convertido em base 64. Obrigatório."},"cMd5":{"type":"string","maxLength":32,"description":"MD5 do texto enviado em cArquivo (o base 64 do zip), em hexadecimal minúsculo. Obrigatório."}},"required":["cArquivo","cCodIntAnexo","cMd5","cNomeArq"]}}},"example":{"call":"pvaIncluirAnexo","param":[{"nCodPed":3478512690,"cCodIntAnexo":"ANX-000123","cNomeArq":"etiqueta-pedido-1532.pdf","cTipoArq":"PDF-LABEL","cArquivo":"UEsDBBQAAAAIA...","cMd5":"9e107d9d372bb6826bd81d3542a419d6"}]}},"produtos_pedidovendaanexos_pvaIncluirAnexo_retorno":{"type":"object","properties":{"nCodPed":{"type":"integer","description":"Código do Pedido de Venda."},"cCodIntPed":{"type":"string","description":"Código de integração do Pedido de Venda."},"cCodIntAnexo":{"type":"string","description":"Código de integração do anexo."},"cNomeArq":{"type":"string","description":"Nome do arquivo anexado."},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro duranteo o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodigoStatus\"."}},"title":"pvaIncluirAnexo (retorno)"},"produtos_pedidovendaanexos_pvaListarAnexos":{"type":"object","title":"pvaListarAnexos","description":"Lista os anexos de um Pedido de Vendas.","required":["call","param"],"properties":{"call":{"type":"string","enum":["pvaListarAnexos"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página. Padrão 1."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Número de registros por página. Padrão 100, máximo 100 (valor maior volta a 100)."},"cOrdenarPor":{"type":"string","maxLength":100,"description":"Ordem dos resultados. Só aceita ARQUIVO (nome do arquivo), que também é o padrão."},"cOrdemDecrescente":{"type":"string","maxLength":1,"description":"\"S\" para ordem decrescente."},"dDtIncDe":{"type":"string","maxLength":10,"description":"Data de inclusão inicial.\nNo formato dd/mm/aaaa."},"dDtIncAte":{"type":"string","maxLength":10,"description":"Data de inclusão final.\nNo formato dd/mm/aaaa."},"dDtAltDe":{"type":"string","maxLength":10,"description":"Data de alteração inicial, no formato dd/mm/aaaa."},"dDtAltAte":{"type":"string","maxLength":10,"description":"Data de alteração final, no formato dd/mm/aaaa."},"nCodPed":{"type":"integer","maxLength":15,"description":"Código interno do pedido de venda. Informe este ou cCodIntPed."},"cCodIntPed":{"type":"string","maxLength":60,"description":"Código de integração do pedido de venda. Informe este ou nCodPed."},"cTipoArq":{"type":"string","maxLength":10,"description":"Filtra pelo tipo de anexo cadastrado (ex.: PDF-LABEL)."}}}}},"example":{"call":"pvaListarAnexos","param":[{"nPagina":1,"nRegPorPagina":50,"nCodPed":3478512690}]}},"produtos_pedidovendaanexos_pvaListarAnexos_retorno":{"type":"object","properties":{"nPagina":{"type":"integer","description":"Número da página resgatada."},"nTotPaginas":{"type":"integer","description":"Número total de páginas encontradas."},"nRegistros":{"type":"integer","description":"Número de registros retornados na página."},"nTotRegistros":{"type":"integer","description":"Número total de registros encontrados."},"listaAnexos":{"type":"array","items":{"type":"object","properties":{"nCodPed":{"type":"integer","description":"Código do Pedido de Venda."},"cCodIntPed":{"type":"string","description":"Código de integração do pedido de venda. Vem sempre vazio nesta listagem; use nCodPed."},"cCodIntAnexo":{"type":"string","description":"Código de integração do anexo."},"cNomeArq":{"type":"string","description":"Nome do arquivo anexado."},"cTipoArq":{"type":"string","description":"Tipo de Arquivo."},"info":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão. No formato dd/mm/aaaa."},"hInc":{"type":"string","description":"Hora da Inclusão. No formato hh:mm:ss."},"uInc":{"type":"string","description":"Usuário da Inclusão."},"dAlt":{"type":"string","description":"Data da Alteração. No formato dd/mm/aaaa."},"hAlt":{"type":"string","description":"Hora da Alteração. No formato hh:mm:ss."},"uAlt":{"type":"string","description":"Usuário da Alteração."},"cImpAPI":{"type":"string","description":"Importado pela API (S/N)."}},"description":"Informações complementares do anexo."}}},"description":"Lista de anexos dos Pedidos de Vendas encontradas."}},"title":"pvaListarAnexos (retorno)"},"produtos_pedidovendaanexos_pvaObterAnexo":{"type":"object","title":"pvaObterAnexo","description":"Obtém um anexo de um Pedido de Vendas.","required":["call","param"],"properties":{"call":{"type":"string","enum":["pvaObterAnexo"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodPed":{"type":"integer","maxLength":15,"description":"Código interno do pedido de venda. Informe este ou cCodIntPed."},"cCodIntPed":{"type":"string","maxLength":60,"description":"Código de integração do pedido de venda. Informe este ou nCodPed."},"cCodIntAnexo":{"type":"string","maxLength":20,"description":"Código de integração do anexo, informado na inclusão. Usado na busca quando cNomeArq não é informado."},"cNomeArq":{"type":"string","maxLength":100,"description":"Nome do arquivo anexado.\nCom cNomeArq preenchido a busca é pelo nome do arquivo e cCodIntAnexo é ignorado."}}}}},"example":{"call":"pvaObterAnexo","param":[{"nCodPed":3478512690,"cCodIntAnexo":"ANX-000123"}]}},"produtos_pedidovendaanexos_pvaObterAnexo_retorno":{"type":"object","properties":{"nCodPed":{"type":"integer","description":"Código do Pedido de Venda."},"cCodIntPed":{"type":"string","description":"Código de integração do Pedido de Venda."},"cCodIntAnexo":{"type":"string","description":"Código de integração do anexo."},"cNomeArq":{"type":"string","description":"Nome do arquivo anexado."},"cTipoArq":{"type":"string","description":"Tipo de Arquivo."},"cLinkDownload":{"type":"string","description":"URL para download do anexo solicitado."},"dDtExpiracao":{"type":"string","description":"Data de expiração da url disponibilizada. No formato dd/mm/aaaa."},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro duranteo o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodigoStatus\"."}},"title":"pvaObterAnexo (retorno)"},"produtos_pedidovendafat_AssociarCodIntPedidoVenda":{"type":"object","title":"AssociarCodIntPedidoVenda","description":"Associar código de integração do Pedido de Venda.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AssociarCodIntPedidoVenda"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cCodIntPed":{"type":"string","maxLength":60,"description":"Código de Integração do Pedido de Venda de Produto."},"nCodPed":{"type":"integer","maxLength":15,"description":"Código do Pedido de Venda de Produto."}},"required":["cCodIntPed","nCodPed"]}}},"example":{"call":"AssociarCodIntPedidoVenda","param":[{"cCodIntPed":"","nCodPed":0}]}},"produtos_pedidovendafat_AssociarCodIntPedidoVenda_retorno":{"type":"object","properties":{"cCodIntPed":{"type":"string","description":"Código de Integração do Pedido de Venda de Produto."},"nCodPed":{"type":"integer","description":"Código do Pedido de Venda de Produto."},"cCodStatus":{"type":"string","description":"Código do Status."},"cDescStatus":{"type":"string","description":"Descrição do Status."}},"title":"AssociarCodIntPedidoVenda (retorno)"},"produtos_pedidovendafat_CancelarPedidoVenda":{"type":"object","title":"CancelarPedidoVenda","description":"Cancela um pedido de venda de produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["CancelarPedidoVenda"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cCodIntPed":{"type":"string","maxLength":60,"description":"Código de Integração do Pedido de Venda de Produto."},"nCodPed":{"type":"integer","maxLength":15,"description":"Código do Pedido de Venda de Produto."}}}}},"example":{"call":"CancelarPedidoVenda","param":[{"cCodIntPed":"","nCodPed":0}]}},"produtos_pedidovendafat_CancelarPedidoVenda_retorno":{"type":"object","properties":{"cCodIntPed":{"type":"string","description":"Código de Integração do Pedido de Venda de Produto."},"nCodPed":{"type":"integer","description":"Código do Pedido de Venda de Produto."},"cCodStatus":{"type":"string","description":"Código do Status."},"cDescStatus":{"type":"string","description":"Descrição do Status."}},"title":"CancelarPedidoVenda (retorno)"},"produtos_pedidovendafat_DuplicarPedidoVenda":{"type":"object","title":"DuplicarPedidoVenda","description":"Duplica um pedido de venda de produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["DuplicarPedidoVenda"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cCodIntPed":{"type":"string","maxLength":60,"description":"Código de Integração do Pedido de Venda de Produto."},"nCodPed":{"type":"integer","maxLength":15,"description":"Código do Pedido de Venda de Produto."}}}}},"example":{"call":"DuplicarPedidoVenda","param":[{"cCodIntPed":"","nCodPed":0}]}},"produtos_pedidovendafat_DuplicarPedidoVenda_retorno":{"type":"object","properties":{"cCodIntPed":{"type":"string","description":"Código de Integração do Pedido de Venda de Produto."},"nCodPed":{"type":"integer","description":"Código do Pedido de Venda de Produto."},"cCodStatus":{"type":"string","description":"Código do Status."},"cDescStatus":{"type":"string","description":"Descrição do Status."}},"title":"DuplicarPedidoVenda (retorno)"},"produtos_pedidovendafat_FaturarPedidoVenda":{"type":"object","title":"FaturarPedidoVenda","description":"Fatura um pedido de venda de produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["FaturarPedidoVenda"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cCodIntPed":{"type":"string","maxLength":60,"description":"Código de Integração do Pedido de Venda de Produto."},"nCodPed":{"type":"integer","maxLength":15,"description":"Código do Pedido de Venda de Produto."}}}}},"example":{"call":"FaturarPedidoVenda","param":[{"cCodIntPed":"","nCodPed":0}]}},"produtos_pedidovendafat_FaturarPedidoVenda_retorno":{"type":"object","properties":{"cCodIntPed":{"type":"string","description":"Código de Integração do Pedido de Venda de Produto."},"nCodPed":{"type":"integer","description":"Código do Pedido de Venda de Produto."},"cCodStatus":{"type":"string","description":"Código do Status."},"cDescStatus":{"type":"string","description":"Descrição do Status."}},"title":"FaturarPedidoVenda (retorno)"},"produtos_pedidovendafat_ObterPedidosVenda":{"type":"object","title":"ObterPedidosVenda","description":"Retorna a lista de pedidos de venda a serem faturados.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterPedidosVenda"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cEtapa":{"type":"string","maxLength":2,"description":"Código de Etapa do Pedido de Venda de Produto.\n\nValores possíveis:\n\n00 - Lista todos as Propostas.\n\n10 - Lista todos os Pedidos não faturados\n\n20 - Lista os pedidos em separação de estoque.\n\n50 - Lista todos os pedidos a faturar.\n\n60 - Lista todos os pedidos faturados.\n\n70 - Lista todos os pedidos em processo de entrega."}},"required":["cEtapa"]}}},"example":{"call":"ObterPedidosVenda","param":[{"cEtapa":"50"}]}},"produtos_pedidovendafat_ObterPedidosVenda_retorno":{"type":"object","properties":{"cEtapa":{"type":"string","description":"Código de Etapa do Pedido de Venda de Produto."},"listaPedidosVenda":{"type":"array","items":{"type":"object","properties":{"nIdPed":{"type":"integer","description":"Código do Pedido de Venda."},"cNumPedido":{"type":"string","description":"Número do Pedido de Venda."}}},"description":"Lista de Pedidos encontrados na etapa solicitada."}},"title":"ObterPedidosVenda (retorno)"},"produtos_pedidovendafat_ValidarPedidoVenda":{"type":"object","title":"ValidarPedidoVenda","description":"Valida um pedido de venda de produto para faturamento.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ValidarPedidoVenda"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cCodIntPed":{"type":"string","maxLength":60,"description":"Código de Integração do Pedido de Venda de Produto."},"nCodPed":{"type":"integer","maxLength":15,"description":"Código do Pedido de Venda de Produto."}}}}},"example":{"call":"ValidarPedidoVenda","param":[{"cCodIntPed":"","nCodPed":0}]}},"produtos_pedidovendafat_ValidarPedidoVenda_retorno":{"type":"object","properties":{"cCodIntPed":{"type":"string","description":"Código de Integração do Pedido de Venda de Produto."},"nCodPed":{"type":"integer","description":"Código do Pedido de Venda de Produto."},"cCodStatus":{"type":"string","description":"Código do Status."},"cDescStatus":{"type":"string","description":"Descrição do Status."}},"title":"ValidarPedidoVenda (retorno)"},"produtos_piscst_ListarCstPis":{"type":"object","title":"ListarCstPis","description":"Listar o CST do PIS.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarCstPis"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"ordenar_por":{"type":"string","maxLength":100,"example":"CODIGO","description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."}}}}},"example":{"call":"ListarCstPis","param":[{"pagina":1,"registros_por_pagina":50}]}},"produtos_piscst_ListarCstPis_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada."},"total_de_paginas":{"type":"integer","description":"Número total de páginas."},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"Total de registros encontrados."},"cadastros":{"type":"array","items":{"type":"object","properties":{"nCodigo":{"type":"string","description":"Código do CST do PIS."},"cDescricao":{"type":"string","description":"Descrição do CST do PIS."}}},"description":"Lista os CSTs do PIS encontrados."}},"title":"ListarCstPis (retorno)"},"produtos_produtoslote_ConsultarLote":{"type":"object","title":"ConsultarLote","description":"Método para realizar a consulta do lote do produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarLote"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodProd":{"type":"integer","maxLength":15,"description":"Código interno de identificação do produto.\nÉ o ID do produto e será utilizado apenas nas APIs como chave principal para localizar um produto.\n\nQuando um produto for incluído via API, você receberá um ID para esse novo produto.\nRecomendamos que você guarde essa informação no aplicativo que estiver integrando.\n\nUtilize a tag \"codigo_produto\" do método \"ListarProdutos\" da API\n/api/v1/geral/produtos/\npara obter essa informação."},"cCodIntProd":{"type":"string","maxLength":60,"description":"Código de integração do produto.\n\nEsse campo deve ser informado apenas se você incluiu o produto via API e informou um código de integração para o produto. Do contrário, informe sempre a tag \"nCodProd\"."},"nIdLocal":{"type":"integer","maxLength":15,"description":"Código interno de identificação do local(Estoque)."}}}}},"example":{"call":"ConsultarLote","param":[{"nCodProd":0,"cCodIntProd":"","nIdLocal":0}]}},"produtos_produtoslote_ConsultarLote_retorno":{"type":"object","properties":{"ident":{"type":"object","properties":{"nCodProd":{"type":"integer","description":"Código do produto. É o ID do produto e será utilizado apenas nas APIs como chave principal para localizar um produto. Quando um produto for incluído via API, você receberá um ID para esse novo produto. Recomendamos que você guarde essa informação no aplicativo que estiver integrando. Utilize a tag \"codigo_produto\" do método \"ListarProdutos\" da API /api/v1/geral/produtos/ para obter essa informação."},"cCodIntProd":{"type":"string","description":"Código de integração do produto. Esse campo deve ser informado apenas se você incluiu o produto via API e informou um código de integração para o produto. Do contrário, informe sempre a tag \"nCodProd\"."},"cCodProduto":{"type":"string","description":"Código do Produto exibido na tela de Produtos."},"cDescrProduto":{"type":"string","description":"Descrição do produto. Descrição do nome do produto no Omie."}},"description":"Identificação do produto."},"lotes":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","description":"Código interno de identificação do lote. É o ID do lote e será utilizado apenas nas APIs como chave principal para localizar um lote."},"nIdLocal":{"type":"integer","description":"Código interno de identificação do local(Estoque)."},"cNumLote":{"type":"string","description":"Numero do lote."},"dDataFabricacao":{"type":"string","description":"Data fabricação do lote."},"dDataValidade":{"type":"string","description":"Data validade do lote."},"nQuantDisponivel":{"type":"decimal","description":"Quantidade disponível do lote."},"nQuantEntradas":{"type":"decimal","description":"Quantidade entrada do lote."},"nQuantSaidas":{"type":"decimal","description":"Quantidade de saídas do lote."},"nSaldoLote":{"type":"decimal","description":"Quantidade da entrada do produto menos a saída do produto."},"nQuantReservada":{"type":"decimal","description":"Quantidade reservada do lote."},"cCodAgregacao":{"type":"string","description":"Código agregado do lote."},"cObs":{"type":"string","description":"Observação."}}},"description":"Informações do lote."}},"title":"ConsultarLote (retorno)"},"produtos_produtoslote_ListarLotes":{"type":"object","title":"ListarLotes","description":"Método para realizar a listagem dos lotes do produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarLotes"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15},"nRegPorPagina":{"type":"integer","maxLength":15},"cFiltrarApenasInclusao":{"type":"string","maxLength":1},"cFiltrarApenasAlteracao":{"type":"string","maxLength":1},"cFiltrarPorDataDe":{"type":"string","maxLength":10},"cFiltrarPorDataAte":{"type":"string","maxLength":10}}}}},"example":{"call":"ListarLotes","param":[{"nPagina":1,"nRegPorPagina":50}]}},"produtos_produtoslote_ListarLotes_retorno":{"type":"object","properties":{"nPagina":{"type":"integer"},"nTotPaginas":{"type":"integer"},"nRegistros":{"type":"integer"},"nTotRegistros":{"type":"integer"},"listaLotes":{"type":"array","items":{"type":"object","properties":{"ident":{"type":"object","properties":{"nCodProd":{"type":"integer","description":"Código do produto. É o ID do produto e será utilizado apenas nas APIs como chave principal para localizar um produto. Quando um produto for incluído via API, você receberá um ID para esse novo produto. Recomendamos que você guarde essa informação no aplicativo que estiver integrando. Utilize a tag \"codigo_produto\" do método \"ListarProdutos\" da API /api/v1/geral/produtos/ para obter essa informação."},"cCodIntProd":{"type":"string","description":"Código de integração do produto. Esse campo deve ser informado apenas se você incluiu o produto via API e informou um código de integração para o produto. Do contrário, informe sempre a tag \"nCodProd\"."},"cCodProduto":{"type":"string","description":"Código do Produto exibido na tela de Produtos."},"cDescrProduto":{"type":"string","description":"Descrição do produto. Descrição do nome do produto no Omie."}},"description":"Identificação do produto."},"lotes":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","description":"Código interno de identificação do lote. É o ID do lote e será utilizado apenas nas APIs como chave principal para localizar um lote."},"nIdLocal":{"type":"integer","description":"Código interno de identificação do local(Estoque)."},"cNumLote":{"type":"string","description":"Numero do lote."},"dDataFabricacao":{"type":"string","description":"Data fabricação do lote."},"dDataValidade":{"type":"string","description":"Data validade do lote."},"nQuantDisponivel":{"type":"decimal","description":"Quantidade disponível do lote."},"nQuantEntrada":{"type":"decimal","description":"Quantidade entrada do lote."},"nQuantSaida":{"type":"decimal","description":"Quantidade de saídas do lote."},"nSaldoLote":{"type":"decimal","description":"Quantidade da entrada do produto menos a saída do produto."},"nQuantReservada":{"type":"decimal","description":"Quantidade reservada do lote."},"cCodAgregacao":{"type":"string","description":"Código agregado do lote."},"cObs":{"type":"string","description":"Observação."}}},"description":"Informações dos lotes do produto."}}},"description":"Informações dos lotes do produto."}},"title":"ListarLotes (retorno)"},"produtos_recebimentonfe_AlterarEtapaRecebimento":{"type":"object","title":"AlterarEtapaRecebimento","description":"Alterar etapa recebimento NFe.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarEtapaRecebimento"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdReceb":{"type":"integer","maxLength":15,"description":"ID do recebimento\n\n\nEsse campo não é exibido na tela é uma informação interna, utilizada apenas nas APIs."},"cChaveNfe":{"type":"string","maxLength":44,"description":"Chave da NFe."},"cEtapa":{"type":"string","maxLength":2,"description":"Etapa da NFe."}},"required":["cEtapa"]}}},"example":{"call":"AlterarEtapaRecebimento","param":[{"nIdReceb":0,"cChaveNfe":"","cEtapa":""}]}},"produtos_recebimentonfe_AlterarEtapaRecebimento_retorno":{"type":"object","properties":{"nIdReceb":{"type":"integer","description":"Id do recebimento."},"cCodStatus":{"type":"string","description":"Código do status."},"cDescStatus":{"type":"string","description":"Descrição do status."}},"title":"AlterarEtapaRecebimento (retorno)"},"produtos_recebimentonfe_AlterarRecebimento":{"type":"object","title":"AlterarRecebimento","description":"Alterar recebimento de NFe.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarRecebimento"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"ide":{"type":"object","properties":{"nIdReceb":{"type":"integer","maxLength":15,"description":"ID do recebimento\n\n\nEsse campo não é exibido na tela é uma informação interna, utilizada apenas nas APIs."},"cChaveNfe":{"type":"string","maxLength":44,"description":"Chave da NFe."}},"description":"Identificação da NFe de recebimento."},"parcelasEditar":{"type":"object","properties":{"cCodParcela":{"type":"string","maxLength":3,"description":"Código do número de parcelas\n\n\nUtilize a tag \"nCodigo\" do método \"ListarFormasPagVendas\" da API\n/api/v1/produtos/formaspagvendas/ para obter essa informação.\n\nO código \"999\" é o único que permite uma definição de forma de pagamento customizada. Caso você escolha essa opção, deve também informar a tag \"qtde_parcelas\" e a estrutura \"lista_parcelas\".\n\nAlguns dos valores disponíveis são:\n\n\"000\" - A Vista\n\"A03\" - Para 3 dias\n\"A05\" - Para 5 dias\n\"A07\" - Para 7 dias\n\"A08\" - Para 8 dias\n\"A09\" - Para 9 dias\n\"A10\" - Para 10 dias\n\"A13\" - Para 13 dias\n\"A14\" - Para 14 dias\n\"A15\" - Para 15 dias\n\"A17\" - Para 17 dias\n\"A20\" - Para 20 dias\n\"A21\" - Para 21 dias\n\"A25\" - Para 25 dias\n\"A26\" - Para 26 dias\n\"A28\" - Para 28 dias\n\"A35\" - Para 35 dias\n\"A36\" - Para 36 dias\n\"A40\" - Para 40 dias\n\"A42\" - Para 42 dias\n\"A45\" - Para 45 dias\n\"A50\" - Para 50 dias\n\"A56\" - Para 56 dias\n\"A60\" - Para 60 dias\n\"A70\" - Para 70 dias\n\"A75\" - Para 75 dias\n\"A90\" - Para 90 dias\n\"A98\" - Para 98 dias\n\"B20\" - Para 120 dias\n\"001\" - 1 Parcela (para 30 dias)\n\"002\" - 2 Parcelas\n\"003\" - 3 Parcelas\n\"004\" - 4 Parcelas\n\"005\" - 5 Parcelas\n\"006\" - 6 Parcelas\n\"007\" - 7 Parcelas\n\"010\" - 10 Parcelas\n\"012\" - 12 Parcelas\n\"024\" - 24 Parcelas\n\"036\" - 36 Parcelas\n\"048\" - 48 Parcelas\n\"S01\" - 30/60\n\"S02\" - 45/60\n\"S03\" - 21/28/35\n\"S04\" - 21/28/35/42\n\"S05\" - 28/35/42\n\"S06\" - 28/35/42/49\n\"S07\" - 30/45/60/75/90\n\"S08\" - 25/56\n\"S09\" - 30/45\n\"S10\" - 28/56\n\"S11\" - 10/30/60\n\"S12\" - 15/30/60\n\"S13\" - 28/35\n\"S14\" - 7/14/21\n\"S15\" - 10/30/60/90\n\"S16\" - 60/90/120\n\"S17\" - 45/60/90\n\"S18\" - 30/60/90\n\"S19\" - 14/21\n\"S20\" - 7/14\n\"S21\" - 14/21/28\n\"S22\" - 45/75\n\"S23\" - 30/45/60\n\"S24\" - 3/20/40\n\"S25\" - 30/60/90/120\n\"S26\" - 21/28\n\"S27\" - a Vista/15\n\"S28\" - a Vista/30\n\"S29\" - a Vista/30/60\n\"S30\" - a Vista/30/60/90\n\"S31\" - a Vista/30/60/90/120/150\n\"S41\" - 28/42/56\n\"S32\" - 15/45/75\n\"S33\" - 14/28/42\n\"S34\" - 14/21/28/35/42\n\"S35\" - 30/42/54/66/78/90\n\"S36\" - 14/21/28/35\n\"S37\" - 28/42\n\"S38\" - 30/45/60\n\"S39\" - 35/42/49/56\n\"S40\" - 28/42/56/70\n\"S42\" - 30/40/50/60\n\"S43\" - 30/50/70/90\n\"S44\" - 14/28\n\"S45\" - 45/60/75/90\n\"S46\" - a Vista/30/60/90/120\n\"S47\" - a vista/20/40/60\n\"S48\" - 21/42\n\"S49\" - 15/30/45\n\"S50\" - 14/42\n\"S51\" - 21/35\n\"S52\" - 28/56/84\n\"S53\" - 28/42/56/70/84\n\"S54\" - a Vista/30/45\n\"S55\" - 21/45\n\"S56\" - a Vista/28\n\"S57\" - a Vista/60/90\n\"S58\" - 35/45/55\n\"S59\" - 28/35/42/56\n\"S60\" - 30/45/60/75\n\"S61\" - 28/35/42/49/56\n\"S62\" - 40/70/100\n\"S63\" - 42/56\n\"S64\" - a Vista/28/35\n\"S65\" - 35/42\n\"S66\" - 20/40\n\"S67\" - a Vista/28/35/42\n\"S68\" - a vista/20/40/60/80\n\"S69\" - a vista/20/40/60/80/100\n\"S70\" - a vista/20/40/60/80/100/120\n\"S71\" - a vista/30/60/90/120/150/180/210/240/270/300/330/360\n\"S72\" - a vista/30/60/90/120/150/180/210/240/270/300\n\"S73\" - 28/56/84/112\n\"S74\" - 14/28/42/56\n\"S75\" - 28/42/56/70/84/98\n\"S76\" - 15/30/45/60/75\n\"S77\" - a Vista/15/30\n\"S78\" - a Vista/20/40\n\"S79\" - 35/42/56\n\"S80\" - 10/30/60/90/120\n\"S81\" - 15/30/45/75/90/105/120\n\"S82\" - 30/45/75/90/105/120\n\"S83\" - 42/49/56\n\"S84\" - 35/42/49\n\"S85\" - a Vista/60/90/120/150\n\"S86\" - a Vista/30/45/60\n\"S87\" - 20/40/60/80/100\n\"S89\" - 15/30\n\"S90\" - 10/30/50\n\"S91\" - 45/52/60\n\"S92\" - 10/30\n\"S93\" - 20/30/40/50/60/70\n\"S94\" - 45/52/59/66\n\"S95\" - 15/30/45/60\n\"S96\" - 40/50\n\"S97\" - 21/42/56\n\"S98\" - a vista/60/90/120/150/180/240/300/330\n\"S99\" - a vista/180\n\"T01\" - 30/40/50\n\"T02\" - 21/28/35/42/49\n\"T03\" - 30/37/45/60\n\"T04\" - a vista/30/60/90/120/150/180/210/240/270\n\"T05\" - a vista/30/60/90/120/150/180/210\n\"T06\" - 30/60/90/120/150/180/210/240\n\"T07\" - 56/84/112\n\"T08\" - 15/30/45/60/75/90/105\n\"T09\" - 21/35/42\n\"T10\" - 35/49\n\"T11\" - 30/45/60/75/90/105/120\n\"T12\" - 45/75/105/135\n\"T13\" - 35/60/75\n\"T14\" - 10/40/70/100/130\n\"T15\" - 45/60/75\n\"T16\" - 40/55/70\n\"T17\" - 40/70\n\"T18\" - 20/40/60\n\"T19\" - 60/90\n\"T20\" - 25/35/45/55\n\"T21\" - 15/45\n\"T22\" - 7/30/45\n\"T23\" - 7/30/60\n\"T24\" - 64/71\n\"T25\" - 20/30/40\n\"999\" - Informar o número de parcelas."},"nQtdParcela":{"type":"integer","maxLength":3,"description":"Número de Parcelas."},"parcelasListaEditar":{"type":"array","items":{"type":"object","properties":{"dVencimento":{"type":"string","maxLength":10,"description":"Data de vencimento da parcela."},"nSequencia":{"type":"integer","maxLength":3,"description":"Número da Parcela."},"vParcela":{"type":"number","maxLength":18,"description":"Valor da parcela."},"pParcela":{"type":"number","maxLength":9,"description":"Percentual da parcela."}},"required":["dVencimento","nSequencia","pParcela","vParcela"]},"description":"Dados das parcelas."}},"description":"Parcelas da NFe de recebimento."},"departamentos":{"type":"array","items":{"type":"object","properties":{"cCodDepartamento":{"type":"string","maxLength":40,"description":"Código do departamento.\n\nInformação localizada na Aba \"Departamentos\" do recebimento de NFe.\n\nUtilize a tag \"codigo\" do método \"ListarDepatartamentos\" da API\n/api/v1/geral/departamentos/ para obter essa informação."},"vDepartamento":{"type":"number","maxLength":18,"description":"Valor do rateio.\n\n\nInformação localizada na Aba \"Departamentos\" do recebimento de NFe."},"pDepartamento":{"type":"number","maxLength":12,"description":"Percentual de rateio.\n\n\nInformação localizada na Aba \"Departamentos\" do recebimento de NFe."}}},"description":"Departamentos da NFe de recebimento."},"infoAdicionais":{"type":"object","properties":{"cCategCompra":{"type":"string","maxLength":20,"description":"Código da categoria da compra.\n\n\nInformação localizada na Aba \"Informações Adicionais\" do recebimento de NFe.\n\nUtilize a tag \"codigo\" do método \"ListarCategorias\" da API\n/api/v1/geral/categorias/ para obter essa informação."},"nIdConta":{"type":"integer","maxLength":15,"description":"Id da conta corrente.\n\n\nInformação localizada na Aba \"Informações Adicionais\" do recebimento de NFe.\n\nUtilize a tag \"codigo\" do método \"PesquisarContaCorrente\" da API\n/api/v1/geral/contacorrente/ para obter essa informação."},"dRegistro":{"type":"string","maxLength":10,"description":"Data de registro."},"nIdComprador":{"type":"integer","maxLength":15,"description":"Id do comprador."},"nIdProjeto":{"type":"integer","maxLength":15,"description":"Id do projeto\n\n\nInformação localizada na Aba \"Informações Adicionais\" do Recebimento de NFe.\n\nUtilize a tag \"codigo\" do método \"ListarProjetos\" da API\n/api/v1/geral/projetos/ para obter essa informação."}},"description":"Informações adicionais da NFe de recebimento."},"itensRecebimentoEditar":{"type":"array","items":{"type":"object","properties":{"itensIde":{"type":"object","properties":{"nSequencia":{"type":"integer","maxLength":4,"description":"Número sequencial do item da NFe de recebimento."},"cAcao":{"type":"string","maxLength":20,"description":"Ação a ser executada na alteração.\n\nInformação obrigatória.\n\nPode ser:\nNOVO = Cadastrar como novo produto\nASSOCIAR-PRODUTO = Associar a um produto existente\nASSOCIAR-PEDIDO = Associar a um pedido/item existente\nIGNORAR = Ignorar a importação desse item na NFe\nEDITAR = Alterar as informações do item da NFe."},"nIdProdutoExistente":{"type":"integer","maxLength":15,"description":"Id do produto a ser associado."},"nIdPedidoExistente":{"type":"integer","maxLength":15,"description":"Id do pedido a ser associado."},"nIdItPedidoExistente":{"type":"integer","maxLength":15,"description":"Id do item do pedido a ser associado."}},"required":["cAcao","nSequencia"],"description":"Identificação do item."},"itensAjustes":{"type":"object","properties":{"cNaoGerarFinanceiro":{"type":"string","maxLength":1,"description":"Não deve gerar uma conta a pagar para o item da NFe de recebimento.\n\nValores possíveis:\nS - Sim\nN - Não."},"cNaoGerarMovEstoque":{"type":"string","maxLength":1,"description":"Não deve gerar movimento de estoque para o item da NFe de recebimento.\n\nValores possíveis:\nS - Sim\nN - Não."},"nQtdeRecebida":{"type":"number","maxLength":19,"description":"Quantidade recebida."},"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"ID do local de estoque.\n\n\nCaso não preenchido assumirá o local de estoque padrão."},"cUnidade":{"type":"string","maxLength":6,"description":"Unidade."},"cCFOPEntrada":{"type":"string","maxLength":10,"description":"CFOP de entrada.\n\nCódigo Fiscal de Operações e Prestações.\n\nUtilize a tag \"nCodigo\" do método \"ListarCFOP\" da API\n/api/v1/produtos/cfop/ para obter essa informação."},"itensSitTribEnt":{"type":"object","properties":{"cSitTribICMSE":{"type":"string","maxLength":2,"description":"Situação Tributária do ICMS."},"cSitTribIPIE":{"type":"string","maxLength":2,"description":"Situação Tributária do IPI."},"cSitTribPISE":{"type":"string","maxLength":2,"description":"Situação Tributária do PIS."},"cSitTribCOFINSE":{"type":"string","maxLength":2,"description":"Situação Tributária do COFINS."},"nBCPISE":{"type":"number","maxLength":18,"description":"Base de Cálculo do PIS."},"nAliqPISE":{"type":"number","maxLength":10,"description":"Alíquota do PIS (%)."},"nValPISE":{"type":"number","maxLength":18,"description":"Valor do PIS."},"nBCCOFINSE":{"type":"number","maxLength":18,"description":"Base de Cálculo do COFINS."},"nAliqCOFINSE":{"type":"number","maxLength":10,"description":"Alíquota do COFINS (%)."},"nValCOFINSE":{"type":"number","maxLength":18,"description":"Valor do COFINS."},"cNaoCredICMSE":{"type":"string","maxLength":1,"description":"Não deve se creditar do ICMS na entrada desse item.\n\nInformar:\nS - Sim\nN - Não."},"itensSitTribICMSSTEnt":{"type":"object","properties":{"nMargVrAdE":{"type":"number","maxLength":10,"description":"Margem de Valor Adicional."},"nRedBCSTE":{"type":"number","maxLength":10,"description":"Redução da BC do ICMS ST (%)."},"nBCSTE":{"type":"number","maxLength":18,"description":"Base de Cálculo do ICMS ST."},"nAliqSTE":{"type":"number","maxLength":10,"description":"Alíquota do ICMS ST (%)."},"nValorST":{"type":"number","maxLength":18,"description":"Valor do ICMS ST."},"nBCFCPE":{"type":"number","maxLength":18,"description":"Base de Cálculo do Fundo de Combate a Pobreza."},"nAliqFCPE":{"type":"number","maxLength":10,"description":"% do Fundo de Combate a Pobreza (ICMS ST)."},"nValorFCPE":{"type":"number","maxLength":18,"description":"Valor do Fundo de Combate a Pobreza."}},"description":"ICMS ST (Substituição Tributária)\nOpcional. Trata-se do ICMS-ST a ser recolhido por antecipação, quando o fornecedor não calculou o ICMS-ST na NF-e."}},"description":"Situações Tributárias de Entrada do item."}},"description":"Ajustes do item da NFe de recebimento."},"itensInfoAdicEditar":{"type":"object","properties":{"cCategoriaItem":{"type":"string","maxLength":20,"description":"Categoria do item."},"codigo_local_estoque_saida":{"type":"integer","maxLength":15,"description":"Id do local de estoque de saída."}},"description":"Informações adicionais do item da NFe de recebimento."},"itensAtualPreco":{"type":"object","properties":{"cAtualizarAtuPre":{"type":"string","maxLength":1,"description":"Quero atualizar automaticamente o preço de venda deste produto no recebimento da compra\n\nInformar \"S\" ou \"N\"."},"nPercAtuPre":{"type":"number","maxLength":10,"description":"Percentual utilizado para a atualização."},"cAtualizarMaiorAtuPre":{"type":"string","maxLength":1,"description":"Atualizar apenas se o novo preço for maior que o preço de venda atual do produto.\n\nInformar \"S\" ou \"N\"."}},"description":"Informações de atualização do preço de venda."},"itensCustoEstoque":{"type":"object","properties":{"cICMSCusto":{"type":"string","maxLength":1,"description":"ICMS é custo de estoque.\n\nInformar \"S\" ou \"N\"."},"cPISCusto":{"type":"string","maxLength":1,"description":"PIS é custo de estoque.\n\nInformar \"S\" ou \"N\"."},"cICMSSTCusto":{"type":"string","maxLength":1,"description":"ICMS ST é custo de estoque.\n\nInformar \"S\" ou \"N\"."},"cCOFINSCusto":{"type":"string","maxLength":1,"description":"COFINS é custo de estoque.\n\nInformar \"S\" ou \"N\"."},"cIPICusto":{"type":"string","maxLength":1,"description":"IPI é custo de estoque.\n\nInformar \"S\" ou \"N\"."},"cFreteCusto":{"type":"string","maxLength":1,"description":"Frete é custo de estoque.\n\nInformar \"S\" ou \"N\"."},"cSeguroCusto":{"type":"string","maxLength":1,"description":"Seguro é custo de estoque.\n\nInformar \"S\" ou \"N\"."},"cOutrosDespCusto":{"type":"string","maxLength":1,"description":"Outras Desp. é custo de estoque.\n\nInformar \"S\" ou \"N\"."},"nValorICMSSTCusto":{"type":"number","maxLength":18,"description":"Valor do ICMS ST."},"nAliqCredPISCusto":{"type":"number","maxLength":10,"description":"% Alíquota de Crédito do PIS."},"nAliqCredCOFINSCusto":{"type":"number","maxLength":10,"description":"% Alíquota de Crédito do COFINS."}},"description":"Informações do custo."},"lote_validade":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","maxLength":15,"description":"Id do lote do produto. (Opcional)\n\nSe não informado iremos cadastrar um novo lote."},"nQtdLote":{"type":"number","maxLength":18,"description":"Informe aqui a quantidade do lote para o produto."},"cNumLote":{"type":"string","maxLength":60,"description":"Número do lote do produto.\n\nDeve ser informado apenas quando a tag [nIdLote] não for informada, com isso, será criado um novo lote a partir do número informado."},"cCodAgreg":{"type":"string","maxLength":20,"description":"Código de agregação do lote do produto. (Opcional)."},"dDataFab":{"type":"string","description":"Data de fabricação do lote.\n\nDeve ser informado apenas quando a tag [nIdLote] não for informada.\n\nComo default é utilizado a data atual."},"dDataVal":{"type":"string","description":"Data de validade do lote.\n\nDeve ser informado apenas quando a tag [nIdLote] não for informada."}},"required":["nQtdLote"]},"description":"Informações referentes ao lote e validade do produto.\n\nA tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes \"manualmente\" por API."}}},"description":"Itens da NFe de recebimento."},"observacoes":{"type":"object","properties":{"cObs":{"type":"string","description":"Observações do recebimento (não serão exibidas na Nota Fiscal).\n\nInformação localizada na Aba \"Observações\" do Recebimento de NFe."}},"description":"Dados da Aba \"Observações\" do Recebimento de NFe."},"cteCfopEntrada":{"type":"object","properties":{"cCFOPEntrada":{"type":"string","maxLength":10,"description":"CFOP de entrada.\n\nCódigo Fiscal de Operações e Prestações.\n\nUtilize a tag \"nCodigo\" do método \"ListarCFOP\" da API\n/api/v1/produtos/cfop/ para obter essa informação."}},"description":"Dados da Aba \"CFOP de Entrada e Mais Detalhes\" do Recebimento de CT-e."}}}}},"example":{"call":"AlterarRecebimento","param":[{"ide":{"nIdReceb":0,"cChaveNfe":""},"itensRecebimentoEditar":{"itensIde":{"nSequencia":0,"cAcao":"IGNORAR"}}}]}},"produtos_recebimentonfe_AlterarRecebimento_retorno":{"type":"object","properties":{"nIdReceb":{"type":"integer","description":"Id do recebimento."},"cCodStatus":{"type":"string","description":"Código do status."},"cDescStatus":{"type":"string","description":"Descrição do status."}},"title":"AlterarRecebimento (retorno)"},"produtos_recebimentonfe_AlterarRecebimentoConcluido":{"type":"object","title":"AlterarRecebimentoConcluido","description":"Alterar recebimento de NFe concluídos.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarRecebimentoConcluido"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"ide":{"type":"object","properties":{"nIdReceb":{"type":"integer","maxLength":15,"description":"ID do recebimento\n\n\nEsse campo não é exibido na tela é uma informação interna, utilizada apenas nas APIs."},"cChaveNfe":{"type":"string","maxLength":44,"description":"Chave da NFe."}},"description":"Identificação da NFe de recebimento."},"infoAdicionais":{"type":"object","properties":{"cCategCompra":{"type":"string","maxLength":20,"description":"Código da categoria da compra.\n\n\nInformação localizada na Aba \"Informações Adicionais\" do recebimento de NFe.\n\nUtilize a tag \"codigo\" do método \"ListarCategorias\" da API\n/api/v1/geral/categorias/ para obter essa informação."},"nIdConta":{"type":"integer","maxLength":15,"description":"Id da conta corrente.\n\n\nInformação localizada na Aba \"Informações Adicionais\" do recebimento de NFe.\n\nUtilize a tag \"codigo\" do método \"PesquisarContaCorrente\" da API\n/api/v1/geral/contacorrente/ para obter essa informação."},"dRegistro":{"type":"string","maxLength":10,"description":"Data de registro."},"nIdComprador":{"type":"integer","maxLength":15,"description":"Id do comprador."},"nIdProjeto":{"type":"integer","maxLength":15,"description":"Id do projeto\n\n\nInformação localizada na Aba \"Informações Adicionais\" do Recebimento de NFe.\n\nUtilize a tag \"codigo\" do método \"ListarProjetos\" da API\n/api/v1/geral/projetos/ para obter essa informação."}},"description":"Informações adicionais da NFe de recebimento."}}}}},"example":{"call":"AlterarRecebimentoConcluido","param":[{"ide":{"nIdReceb":0,"cChaveNfe":""},"infoAdicionais":{"cCategCompra":"","nIdConta":0,"dRegistro":"30/09/2026","nIdProjeto":0,"nIdComprador":0}}]}},"produtos_recebimentonfe_AlterarRecebimentoConcluido_retorno":{"type":"object","properties":{"nIdReceb":{"type":"integer","description":"Id do recebimento."},"cCodStatus":{"type":"string","description":"Código do status."},"cDescStatus":{"type":"string","description":"Descrição do status."}},"title":"AlterarRecebimentoConcluido (retorno)"},"produtos_recebimentonfe_ConcluirRecebimento":{"type":"object","title":"ConcluirRecebimento","description":"Concluir recebimento de NFe.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConcluirRecebimento"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdReceb":{"type":"integer","maxLength":15,"description":"ID do recebimento\n\n\nEsse campo não é exibido na tela é uma informação interna, utilizada apenas nas APIs."},"cChaveNfe":{"type":"string","maxLength":44,"description":"Chave da NFe."},"cEtapa":{"type":"string","maxLength":2,"description":"Etapa da NFe."}}}}},"example":{"call":"ConcluirRecebimento","param":[{"nIdReceb":0,"cChaveNfe":"","cEtapa":""}]}},"produtos_recebimentonfe_ConcluirRecebimento_retorno":{"type":"object","properties":{"nIdReceb":{"type":"integer","description":"Id do recebimento."},"cCodStatus":{"type":"string","description":"Código do status."},"cDescStatus":{"type":"string","description":"Descrição do status."}},"title":"ConcluirRecebimento (retorno)"},"produtos_recebimentonfe_ConsultarRecebimento":{"type":"object","title":"ConsultarRecebimento","description":"Consultar recebimento de NFe.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarRecebimento"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdReceb":{"type":"integer","maxLength":15,"description":"ID do recebimento\n\n\nEsse campo não é exibido na tela é uma informação interna, utilizada apenas nas APIs."},"cChaveNfe":{"type":"string","maxLength":44,"description":"Chave da NFe."}}}}},"example":{"call":"ConsultarRecebimento","param":[{"nIdReceb":0,"cChaveNfe":""}]}},"produtos_recebimentonfe_ConsultarRecebimento_retorno":{"type":"object","properties":{"cabec":{"type":"object","properties":{"nIdReceb":{"type":"integer","description":"ID do Recebimento Esse campo não é exibido na tela é uma informação interna, utilizada apenas nas APIs."},"nIdFornecedor":{"type":"integer","description":"Id do fornecedor. Utilize a tag \"codigo_cliente_omie\" do método \"ListarClientes\" da API /api/v1/geral/clientes/ para obter essa informação."},"cPessoaFisica":{"type":"string","description":"Indica se o fornecedor é pessoa física. Pode ser: S = Sim N = Não."},"cNome":{"type":"string","description":"Nome do fornecedor."},"cRazaoSocial":{"type":"string","description":"Razão social do fornecedor."},"cInscricao":{"type":"string","description":"Inscrição estadual do fornecedor."},"cCNPJ_CPF":{"type":"string","description":"CNPJ ou CPF do fornecedor."},"cChaveNfe":{"type":"string","description":"Chave da NFe."},"cEtapa":{"type":"string","description":"Etapa da NFe Esse campo indica em que coluna o recebimento da NFe irá figurar no processo de recebimento do Omie."},"cNumeroNFe":{"type":"string","description":"Número da NFe."},"cSerieNFe":{"type":"string","description":"Série da NFe."},"cModeloNFe":{"type":"string","description":"Modelo da NFe."},"dEmissaoNFe":{"type":"string","description":"Data de emissão da NFe."},"nValorNFe":{"type":"decimal","description":"Valor da NFe."},"cAmbienteNFe":{"type":"string","description":"Ambiente da NFe Pode ser: P = Produção H = Homologação."},"cNaturezaOperacao":{"type":"string","description":"Natureza da operação da NFe."}},"description":"Cabeçalho da NFe de recebimento."},"itensRecebimento":{"type":"array","items":{"type":"object","properties":{"itensCabec":{"type":"object","properties":{"nIdItem":{"type":"integer","description":"Id do item da NFe de recebimento."},"nIdPedido":{"type":"integer"},"nIdItPedido":{"type":"integer"},"nIdProduto":{"type":"integer","description":"Id do produto. Esse campo não é exibido na tela de itens do recebimento da NFe. É uma informação interna, utilizada apenas nas APIs. Utilize a tag \"codigo_produto\" do método \"ListarProdutos\" da API /api/v1/geral/produtos/ para obter essa informação."},"nSequencia":{"type":"integer","description":"Número sequencial do item da NFe de recebimento."},"cCodigoProduto":{"type":"string","description":"Código do Produto na NFe exibido na tela de recebimento."},"cDescricaoProduto":{"type":"string","description":"Descrição do produto."},"cIgnorarItem":{"type":"string","description":"Ignorar a importação do item da NFe de recebimento Pode ser: S = Sim N = Não."},"cAdicionarNovo":{"type":"string","description":"Cadastrar como novo produto o item da NFe de recebimento Pode ser: S = Sim N = Não."},"cAssociarExistente":{"type":"string","description":"Associar a um produto ou pedido existente o item da NFe de recebimento Pode ser: S = Sim N = Não."},"cItemDevolvido":{"type":"string","description":"Item da NFe de recebimento devolvido Pode ser: S = Sim N = Não."},"cNCM":{"type":"string","description":"NCM - Nomenclatura Comum do Mercosul Utilize a tag \"cCodigo\" do método \"ListarNCM\" da API /api/v1/produtos/ncm/ para obter essa informação."},"cEAN":{"type":"string","description":"Código EAN - European Article Number."},"cCFOP":{"type":"string","description":"CFOP - Código Fiscal de Operações e Prestações. Utilize a tag \"nCodigo\" do método \"ListarCFOP\" da API /api/v1/produtos/cfop/ para obter essa informação."},"nQtdeNFe":{"type":"decimal","description":"Quantidade da Nota."},"cUnidadeNfe":{"type":"string","description":"Unidade da Nota."},"nPrecoUnit":{"type":"decimal","description":"Preço unitário."},"vDesconto":{"type":"decimal","description":"Valor do desconto."},"vFrete":{"type":"decimal","description":"Valor do Frete."},"vTotalItem":{"type":"decimal","description":"Valor total do item."}},"description":"Cabeçalho do item da NFe de recebimento."},"itensAjustes":{"type":"object","properties":{"cNaoGerarFinanceiro":{"type":"string","description":"Não deve gerar uma conta a pagar para o item da NFe de recebimento. Valores possíveis: S - Sim N - Não."},"cNaoGerarMovEstoque":{"type":"string","description":"Não deve gerar movimento de estoque para o item da NFe de recebimento. Valores possíveis: S - Sim N - Não."},"nQtdeRecebida":{"type":"decimal","description":"Quantidade recebida."},"codigo_local_estoque":{"type":"integer","description":"ID do local de estoque. Caso não preenchido assumirá o local de estoque padrão."},"cUnidade":{"type":"string","description":"Unidade."},"cCFOPEntrada":{"type":"string","description":"CFOP de entrada. Código Fiscal de Operações e Prestações. Utilize a tag \"nCodigo\" do método \"ListarCFOP\" da API /api/v1/produtos/cfop/ para obter essa informação."},"itensSitTribEnt":{"type":"object","properties":{"cSitTribICMSE":{"type":"string","description":"Situação Tributária do ICMS."},"cSitTribIPIE":{"type":"string","description":"Situação Tributária do IPI."},"cSitTribPISE":{"type":"string","description":"Situação Tributária do PIS."},"cSitTribCOFINSE":{"type":"string","description":"Situação Tributária do COFINS."},"nBCPISE":{"type":"decimal","description":"Base de Cálculo do PIS."},"nAliqPISE":{"type":"decimal","description":"Alíquota do PIS (%)."},"nValPISE":{"type":"decimal","description":"Valor do PIS."},"nBCCOFINSE":{"type":"decimal","description":"Base de Cálculo do COFINS."},"nAliqCOFINSE":{"type":"decimal","description":"Alíquota do COFINS (%)."},"nValCOFINSE":{"type":"decimal","description":"Valor do COFINS."},"cNaoCredICMSE":{"type":"string","description":"Não deve se creditar do ICMS na entrada desse item. Informar: S - Sim N - Não."},"itensSitTribICMSSTEnt":{"type":"object","properties":{"nMargVrAdE":{"type":"decimal","description":"Margem de Valor Adicional."},"nRedBCSTE":{"type":"decimal","description":"Redução da BC do ICMS ST (%)."},"nBCSTE":{"type":"decimal","description":"Base de Cálculo do ICMS ST."},"nAliqSTE":{"type":"decimal","description":"Alíquota do ICMS ST (%)."},"nValorST":{"type":"decimal","description":"Valor do ICMS ST."},"nBCFCPE":{"type":"decimal","description":"Base de Cálculo do Fundo de Combate a Pobreza."},"nAliqFCPE":{"type":"decimal","description":"% do Fundo de Combate a Pobreza (ICMS ST)."},"nValorFCPE":{"type":"decimal","description":"Valor do Fundo de Combate a Pobreza."}},"description":"ICMS ST (Substituição Tributária) Opcional. Trata-se do ICMS-ST a ser recolhido por antecipação, quando o fornecedor não calculou o ICMS-ST na NF-e."}},"description":"Situações Tributárias de Entrada do item."}},"description":"Ajustes do item da NFe de recebimento."},"itensInfoAdic":{"type":"object","properties":{"nPesoLiquidoIt":{"type":"decimal","description":"Peso Líquido (Kg)."},"nPesoBrutoIt":{"type":"decimal","description":"Peso Bruto (Kg)."},"cCategoriaItem":{"type":"string","description":"Categoria do item."},"nNumPedCompra":{"type":"string","description":"Número do Pedido de Compra."},"cNumItPedCompra":{"type":"integer","description":"Item do Pedido de Compra."},"cNumFCI":{"type":"string","description":"Número da FCI - informação relacionada com a Resolução 13/2012 do Senado Federal."},"vAproxTributosIt":{"type":"decimal","description":"Valor Aprox. dos Tributos."},"codigo_local_estoque_saida":{"type":"integer","description":"Id do local de estoque de saída."}},"description":"Informações adicionais do item da NFe de recebimento."},"itensICMS":{"type":"object","properties":{"cSitTrib":{"type":"string","description":"Situação Tributária do ICMS."},"cOrigem":{"type":"string","description":"Origem do ICMS."},"cModBC":{"type":"string","description":"Modalidade da Base de Cálculo do ICMS Substituição Tributária."},"nRedBC":{"type":"decimal","description":"Redução da Base de Cálculo do ICMS (%)."},"nBC":{"type":"decimal","description":"Base de Cálculo do ICMS."},"nAliq":{"type":"decimal","description":"Alíquota de ICMS."},"nValor":{"type":"decimal","description":"Valor do ICMS."},"nBCStRecAnt":{"type":"decimal","description":"Base do ICMS Substituição Tributária Recebido Anteriormente."},"nAliqStRecAnt":{"type":"decimal","description":"Alíquota do ICMS Substituição Tributária Recebido Anteriormente."},"nValorStRecAnt":{"type":"decimal","description":"Valor do ICMS Substituição Tributária Recebido Anteriormente."},"nPercDif":{"type":"decimal","description":"Percentual do Diferimento (%)."},"nValorDif":{"type":"decimal","description":"Valor do ICMS Diferido."},"nValorSubst":{"type":"decimal","description":"Valor do ICMS do Substituto."},"nValorOpProp":{"type":"decimal","description":"Valor do ICMS Operação Própria."}},"description":"Informações do ICMS."},"itensICMSST":{"type":"object","properties":{"cModBCST":{"type":"string","description":"Modalidade da Base de Cálculo do ICMS Substituição Tributária."},"nMargVrAd":{"type":"decimal","description":"Margem de Valor Adicionado (%)."},"nRedBCST":{"type":"decimal","description":"Redução da BC do ICMS ST (%)."},"nBCST":{"type":"decimal","description":"Base de Cálculo do ICMS ST."},"nAliqST":{"type":"decimal","description":"Alíquota do ICMS ST (%)."},"nAliqOP":{"type":"decimal","description":"Alíquota do ICMS Operação Própria (%)."},"nValorST":{"type":"decimal","description":"Valor do ICMS ST."},"cCEST":{"type":"string","description":"CEST (Código Especificador da Substituição Tributária)."}},"description":"Informações do ICMS Substituição Tributária."},"itensICMSSN":{"type":"object","properties":{"cSitTribSN":{"type":"string","description":"Situação Tributária do ICMS."},"cOrigem":{"type":"string","description":"Origem."},"nBCSNST":{"type":"decimal","description":"Base de Cálculo do ICMS Retido."},"nValorSNST":{"type":"decimal","description":"Valor do ICMS Retido por ST."},"nAliqCredSN":{"type":"decimal","description":"Alíq. de Cálculo de Crédito (%)."},"nCredSN":{"type":"decimal","description":"Crédito do ICMS Aproveitado."},"cModBCSN":{"type":"string","description":"Modalidade da BC do ICMS."},"nAliqRedBCSN":{"type":"decimal","description":"Redução da BC do ICMS (%)."},"nBCSN":{"type":"decimal","description":"Base de Cálculo do ICMS."},"nAliqSN":{"type":"decimal","description":"Alíquota do ICMS (%)."},"nValorSN":{"type":"decimal","description":"Valor do ICMS."}},"description":"Informações do ICMS Simples Nacional."},"itensIPI":{"type":"object","properties":{"cSitTribIPI":{"type":"string","description":"Situação Tributária do IPI."},"cTpCalcIPI":{"type":"string","description":"Tipo de Cálculo para obter o IPI."},"nBCIPI":{"type":"decimal","description":"Base de Cálculo do IPI."},"nAliqIPI":{"type":"decimal","description":"Alíquota do IPI (%)."},"nQtdUTIPI":{"type":"decimal","description":"Quantidade de Unidades Tributáveis."},"nValIPIUT":{"type":"decimal","description":"Valor do IPI por UnididadeTributável."},"cEnqIPI":{"type":"string","description":"Enquadramento do IPI."},"nValIPI":{"type":"decimal","description":"Valor do IPI."},"nValIPIDev":{"type":"decimal","description":"Valor do IPI Devolvido."}},"description":"Informações do IPI."},"itensPIS":{"type":"object","properties":{"cSitTribPIS":{"type":"string","description":"Situação Tributária do PIS."},"cTpCalcPIS":{"type":"string","description":"Tipo de Cálculo para obter o PIS."},"nBCPIS":{"type":"decimal","description":"Base de Cálculo do PIS."},"nAliqPIS":{"type":"decimal","description":"Alíquota do PIS (%)."},"nQtdUTPIS":{"type":"decimal","description":"Quantidade Unidades Tributáveis."},"nValPISUT":{"type":"decimal","description":"Valor do PIS por Unididade Tributável."},"nValPIS":{"type":"decimal","description":"Valor do PIS."}},"description":"Informações do PIS."},"itensCOFINS":{"type":"object","properties":{"cSitTribCOFINS":{"type":"string","description":"Situação Tributária do COFINS."},"cTpCalcCOFINS":{"type":"string","description":"Tipo de Cálculo para obter o COFINS."},"nBCCOFINS":{"type":"decimal","description":"Base de Cálculo do COFINS."},"nAliqCOFINS":{"type":"decimal","description":"Alíquota do COFINS (%)."},"nQtdUTCOFINS":{"type":"decimal","description":"Quantidade Unidades Tributáveis."},"nVaCOFINSSUT":{"type":"decimal","description":"Valor do COFINS Unidade Tributável."},"nValCOFINS":{"type":"decimal","description":"Valor do COFINS."}},"description":"Informações do COFINS."},"itensAtualPreco":{"type":"object","properties":{"cAtualizarAtuPre":{"type":"string","description":"Quero atualizar automaticamente o preço de venda deste produto no recebimento da compra Informar \"S\" ou \"N\"."},"nPercAtuPre":{"type":"decimal","description":"Percentual utilizado para a atualização."},"cAtualizarMaiorAtuPre":{"type":"string","description":"Atualizar apenas se o novo preço for maior que o preço de venda atual do produto. Informar \"S\" ou \"N\"."}},"description":"Informações de atualização do preço de venda."},"itensCustoEstoque":{"type":"object","properties":{"cICMSCusto":{"type":"string","description":"ICMS é custo de estoque. Informar \"S\" ou \"N\"."},"cPISCusto":{"type":"string","description":"PIS é custo de estoque. Informar \"S\" ou \"N\"."},"cICMSSTCusto":{"type":"string","description":"ICMS ST é custo de estoque. Informar \"S\" ou \"N\"."},"cCOFINSCusto":{"type":"string","description":"COFINS é custo de estoque. Informar \"S\" ou \"N\"."},"cIPICusto":{"type":"string","description":"IPI é custo de estoque. Informar \"S\" ou \"N\"."},"cFreteCusto":{"type":"string","description":"Frete é custo de estoque. Informar \"S\" ou \"N\"."},"cSeguroCusto":{"type":"string","description":"Seguro é custo de estoque. Informar \"S\" ou \"N\"."},"cOutrosDespCusto":{"type":"string","description":"Outras Desp. é custo de estoque. Informar \"S\" ou \"N\"."},"nValorICMSSTCusto":{"type":"decimal","description":"Valor do ICMS ST."},"nAliqCredPISCusto":{"type":"decimal","description":"% Alíquota de Crédito do PIS."},"nAliqCredCOFINSCusto":{"type":"decimal","description":"% Alíquota de Crédito do COFINS."}},"description":"Informações do custo."},"itensCBS":{"type":"object","properties":{"nAliqCbsReg":{"type":"decimal","description":"Valor da alíquota da CBS."},"nPercDiferimentoCbs":{"type":"decimal","description":"Percentual do diferimento - CBS."},"nValDiferimentoCbs":{"type":"decimal","description":"Valor do diferimento - CBS."},"nValCbs":{"type":"decimal","description":"Valor da CBS."},"nPercReducaoCbs":{"type":"decimal","description":"Percentual da redução de alíquota do cClassTrib - CBS."}},"description":"Informações doda CBS"},"itensIBS":{"type":"object","properties":{"nAliqIbsUfReg":{"type":"decimal","description":"Valor da alíquota do IBS da UF."},"nPercDiferimentoIbsUf":{"type":"decimal","description":"Percentual do Diferimento - IBS UF."},"nValDiferimentoIbsUf":{"type":"decimal","description":"Valor do diferimento - IBS."},"nPercReducaoIbsUf":{"type":"decimal","description":"Percentual da redução de alíquota do cClassTrib - IBS UF."},"nValIbsUf":{"type":"decimal","description":"Valor do IBS de competência da UF."},"nValDiferimentoIbsMun":{"type":"decimal","description":"Valor do Diferimento - IBS Município."},"nPercReducaoIbsMun":{"type":"decimal","description":"Percentual da redução de alíquota do cClassTrib - IBS Município."},"nAliqIbsMunReg":{"type":"decimal","description":"Valor da alíquota do IBS do Município."},"nValIbs":{"type":"decimal","description":"Valor do IBS."},"nValIbsMun":{"type":"decimal","description":"Valor do IBS de competência do Município."}},"description":"Informações do IBS."},"itensCbsIbs":{"type":"object","properties":{"cCstIbsCbs":{"type":"string","description":"Código de Situação Tributária do IBS e CBS."},"cClassTrib":{"type":"string","description":"Código de Classificação Tributária do IBS e CBS."},"nBaseIbsCbs":{"type":"decimal","description":"Base de cálculo do IBS e CBS."}},"description":"Informações unificadas sobre o IBS e CBS."}}},"description":"Itens da NFe de recebimento."},"infoAdicionais":{"type":"object","properties":{"cCategCompra":{"type":"string","description":"Código da categoria da compra. Informação localizada na Aba \"Informações Adicionais\" do recebimento de NFe. Utilize a tag \"codigo\" do método \"ListarCategorias\" da API /api/v1/geral/categorias/ para obter essa informação."},"nIdConta":{"type":"integer","description":"Id da conta corrente. Informação localizada na Aba \"Informações Adicionais\" do recebimento de NFe. Utilize a tag \"codigo\" do método \"PesquisarContaCorrente\" da API /api/v1/geral/contacorrente/ para obter essa informação."},"dRegistro":{"type":"string","description":"Data de registro."},"nIdComprador":{"type":"integer","description":"Id do comprador."},"nIdProjeto":{"type":"integer","description":"Id do projeto Informação localizada na Aba \"Informações Adicionais\" do Recebimento de NFe. Utilize a tag \"codigo\" do método \"ListarProjetos\" da API /api/v1/geral/projetos/ para obter essa informação."}},"description":"Informações adicionais da NFe de recebimento."},"transporte":{"type":"object","properties":{"cTipoFrete":{"type":"string","description":"Frete - Código do tipo."},"nIdTransportador":{"type":"integer","description":"Frete - Id do transportador."},"nQtdeVolume":{"type":"integer","description":"Frete/Volumes - Quantidade."},"cEspecieVolume":{"type":"string","description":"Frete/Volumes - Espécie."},"cMarcaVolume":{"type":"string","description":"Frete/Volumes - Marca."},"cNumeroVolume":{"type":"string","description":"Frete/Volumes - Numeração."},"nPesoLiquido":{"type":"decimal","description":"Frete/Volumes - Peso Líquido (Kg)."},"nPesoBruto":{"type":"decimal","description":"Frete/Volumes - Peso Bruto (Kg)."},"cNumeroLacre":{"type":"string","description":"Frete - Número do lacre."},"cPlacaVeiculo":{"type":"string","description":"Frete/Veículo - Placa."},"cUFVeiculo":{"type":"string","description":"Frete/Veículo - Unidade federativa."},"cRNTRC":{"type":"string","description":"Frete/Veículo - RNTRC (ANTT) - Registro Nacional de Transportador de Cargas."},"cNomeTransp":{"type":"string","description":"Nome da Transportadora."},"cRazaoTransp":{"type":"string","description":"Razao Social da Transportadora."},"cCnpjCpfTransp":{"type":"string","description":"CNPJ ou CPF da Transportadora."}},"description":"Transporte da NFe de recebimento."},"totais":{"type":"object","properties":{"bcICMS":{"type":"decimal","description":"Báse de Cálculo do ICMS."},"vICMS":{"type":"decimal","description":"Valor do ICMS."},"vICMSDesonerado":{"type":"decimal","description":"Valor do ICMS Desonerado."},"bcICMSST":{"type":"decimal","description":"Base de Cálculo ICMS ST."},"vICMSSubstituicao":{"type":"decimal","description":"Valor ICMS Substituição."},"vTotalProdutos":{"type":"decimal","description":"Valor Total dos Produtos."},"vFrete":{"type":"decimal","description":"Valor do Frete."},"vSeguro":{"type":"decimal","description":"Valor do Seguro."},"vOutrasDespesas":{"type":"decimal","description":"Valor Total de Outras Despesas Acessórias."},"vTotalIPI":{"type":"decimal","description":"Valor Total do IPI."},"vTotalNFe":{"type":"decimal","description":"Valot Total da Nota Fiscal."},"vTotalDescontos":{"type":"decimal","description":"Valor Total do Desconto."},"vTotalPIS":{"type":"decimal","description":"Valor Total do PIS."},"vTotalCOFINS":{"type":"decimal","description":"Valor Total do COFINS."},"vAproxTributos":{"type":"decimal","description":"Valor Aproximado dos Tributos."},"nBaseIbsCbs":{"type":"decimal","description":"Valor total da base de cálculo do IBS e da CBS."},"nValIBS":{"type":"decimal","description":"Valor total da IBS."},"nValCbs":{"type":"decimal","description":"Valor total da CBS."},"nValIbsMun":{"type":"decimal","description":"Valor total do IBS do município."},"nValIbsUf":{"type":"decimal","description":"Valor total do IBS da UF."},"nValDiferimentoIbsUf":{"type":"decimal","description":"Valor total do diferimento do IBS UF."},"nValDiferimentoIbsMun":{"type":"decimal","description":"Valor total do diferimento do IBS do município."}},"description":"Totais da NFe de recebimento."},"parcelas":{"type":"object","properties":{"cCodParcela":{"type":"string","description":"Código do número de parcelas Utilize a tag \"nCodigo\" do método \"ListarFormasPagVendas\" da API /api/v1/produtos/formaspagvendas/ para obter essa informação. O código \"999\" é o único que permite uma definição de forma de pagamento customizada. Caso você escolha essa opção, deve também informar a tag \"qtde_parcelas\" e a estrutura \"lista_parcelas\". Alguns dos valores disponíveis são: \"000\" - A Vista \"A03\" - Para 3 dias \"A05\" - Para 5 dias \"A07\" - Para 7 dias \"A08\" - Para 8 dias \"A09\" - Para 9 dias \"A10\" - Para 10 dias \"A13\" - Para 13 dias \"A14\" - Para 14 dias \"A15\" - Para 15 dias \"A17\" - Para 17 dias \"A20\" - Para 20 dias \"A21\" - Para 21 dias \"A25\" - Para 25 dias \"A26\" - Para 26 dias \"A28\" - Para 28 dias \"A35\" - Para 35 dias \"A36\" - Para 36 dias \"A40\" - Para 40 dias \"A42\" - Para 42 dias \"A45\" - Para 45 dias \"A50\" - Para 50 dias \"A56\" - Para 56 dias \"A60\" - Para 60 dias \"A70\" - Para 70 dias \"A75\" - Para 75 dias \"A90\" - Para 90 dias \"A98\" - Para 98 dias \"B20\" - Para 120 dias \"001\" - 1 Parcela (para 30 dias) \"002\" - 2 Parcelas \"003\" - 3 Parcelas \"004\" - 4 Parcelas \"005\" - 5 Parcelas \"006\" - 6 Parcelas \"007\" - 7 Parcelas \"010\" - 10 Parcelas \"012\" - 12 Parcelas \"024\" - 24 Parcelas \"036\" - 36 Parcelas \"048\" - 48 Parcelas \"S01\" - 30/60 \"S02\" - 45/60 \"S03\" - 21/28/35 \"S04\" - 21/28/35/42 \"S05\" - 28/35/42 \"S06\" - 28/35/42/49 \"S07\" - 30/45/60/75/90 \"S08\" - 25/56 \"S09\" - 30/45 \"S10\" - 28/56 \"S11\" - 10/30/60 \"S12\" - 15/30/60 \"S13\" - 28/35 \"S14\" - 7/14/21 \"S15\" - 10/30/60/90 \"S16\" - 60/90/120 \"S17\" - 45/60/90 \"S18\" - 30/60/90 \"S19\" - 14/21 \"S20\" - 7/14 \"S21\" - 14/21/28 \"S22\" - 45/75 \"S23\" - 30/45/60 \"S24\" - 3/20/40 \"S25\" - 30/60/90/120 \"S26\" - 21/28 \"S27\" - a Vista/15 \"S28\" - a Vista/30 \"S29\" - a Vista/30/60 \"S30\" - a Vista/30/60/90 \"S31\" - a Vista/30/60/90/120/150 \"S41\" - 28/42/56 \"S32\" - 15/45/75 \"S33\" - 14/28/42 \"S34\" - 14/21/28/35/42 \"S35\" - 30/42/54/66/78/90 \"S36\" - 14/21/28/35 \"S37\" - 28/42 \"S38\" - 30/45/60 \"S39\" - 35/42/49/56 \"S40\" - 28/42/56/70 \"S42\" - 30/40/50/60 \"S43\" - 30/50/70/90 \"S44\" - 14/28 \"S45\" - 45/60/75/90 \"S46\" - a Vista/30/60/90/120 \"S47\" - a vista/20/40/60 \"S48\" - 21/42 \"S49\" - 15/30/45 \"S50\" - 14/42 \"S51\" - 21/35 \"S52\" - 28/56/84 \"S53\" - 28/42/56/70/84 \"S54\" - a Vista/30/45 \"S55\" - 21/45 \"S56\" - a Vista/28 \"S57\" - a Vista/60/90 \"S58\" - 35/45/55 \"S59\" - 28/35/42/56 \"S60\" - 30/45/60/75 \"S61\" - 28/35/42/49/56 \"S62\" - 40/70/100 \"S63\" - 42/56 \"S64\" - a Vista/28/35 \"S65\" - 35/42 \"S66\" - 20/40 \"S67\" - a Vista/28/35/42 \"S68\" - a vista/20/40/60/80 \"S69\" - a vista/20/40/60/80/100 \"S70\" - a vista/20/40/60/80/100/120 \"S71\" - a vista/30/60/90/120/150/180/210/240/270/300/330/360 \"S72\" - a vista/30/60/90/120/150/180/210/240/270/300 \"S73\" - 28/56/84/112 \"S74\" - 14/28/42/56 \"S75\" - 28/42/56/70/84/98 \"S76\" - 15/30/45/60/75 \"S77\" - a Vista/15/30 \"S78\" - a Vista/20/40 \"S79\" - 35/42/56 \"S80\" - 10/30/60/90/120 \"S81\" - 15/30/45/75/90/105/120 \"S82\" - 30/45/75/90/105/120 \"S83\" - 42/49/56 \"S84\" - 35/42/49 \"S85\" - a Vista/60/90/120/150 \"S86\" - a Vista/30/45/60 \"S87\" - 20/40/60/80/100 \"S89\" - 15/30 \"S90\" - 10/30/50 \"S91\" - 45/52/60 \"S92\" - 10/30 \"S93\" - 20/30/40/50/60/70 \"S94\" - 45/52/59/66 \"S95\" - 15/30/45/60 \"S96\" - 40/50 \"S97\" - 21/42/56 \"S98\" - a vista/60/90/120/150/180/240/300/330 \"S99\" - a vista/180 \"T01\" - 30/40/50 \"T02\" - 21/28/35/42/49 \"T03\" - 30/37/45/60 \"T04\" - a vista/30/60/90/120/150/180/210/240/270 \"T05\" - a vista/30/60/90/120/150/180/210 \"T06\" - 30/60/90/120/150/180/210/240 \"T07\" - 56/84/112 \"T08\" - 15/30/45/60/75/90/105 \"T09\" - 21/35/42 \"T10\" - 35/49 \"T11\" - 30/45/60/75/90/105/120 \"T12\" - 45/75/105/135 \"T13\" - 35/60/75 \"T14\" - 10/40/70/100/130 \"T15\" - 45/60/75 \"T16\" - 40/55/70 \"T17\" - 40/70 \"T18\" - 20/40/60 \"T19\" - 60/90 \"T20\" - 25/35/45/55 \"T21\" - 15/45 \"T22\" - 7/30/45 \"T23\" - 7/30/60 \"T24\" - 64/71 \"T25\" - 20/30/40 \"999\" - Informar o número de parcelas."},"nQtdParcela":{"type":"integer","description":"Número de Parcelas."},"parcelasLista":{"type":"array","items":{"type":"object","properties":{"dVencimento":{"type":"string","description":"Data de vencimento da parcela."},"nIdTitulo":{"type":"integer","description":"ID da Conta a Receber ou a Pagar."},"nSequencia":{"type":"integer","description":"Número da Parcela."},"vParcela":{"type":"decimal","description":"Valor da parcela."},"pParcela":{"type":"decimal","description":"Percentual da parcela."},"cTipoDocumento":{"type":"string","description":"Código para o Tipo de Documento. Valores possíveis: 13S - 13o. Salário 99999 - Outros ACO - Acordo ACOB - Acordo - Boleto ACOT - Acordo - Transferência ADI - Adiantamento ANT - Antecipação APL - Aplicação APO - Apólice BIL - Bilhete BOL - Boleto BOLV - Boleto à Vista BONUS - Bonus CAP - Capitalização CF - Cupom Fiscal CHD - Cheque Devolvido CHP - Cheque Pré CHQ - Cheque CHT - Cheque de Terceiros CNT - Crédito em Conta COB - Cobrança COM - Comissão CON - Convênios CONC - Cobrança de Concessionária COND - Condicional CONS - Consignado CONSO - Consórcio CRC - Cartão de Crédito CRD - Cartão de Débito CRE - Crediário CRT - Cartão CTE - CT-e CTR - Contrato CUSJ - Custos Judiciais DACTE - DACTE DAE - DAE DAJE - DAJE DAM - DAM DANFE - DANFE DAR - DAR DARE - DARE DARJ - DARJ DARM - DARM DAS - DAS DDA - DDA DEB - Débito em Conta DEBA - Débito Automático DEP - Depósito DEV - Devolução DFE - Documento Fiscal Equivalente DIN - Dinheiro DLC - Distribuição de Lucros DNF - Documento não fiscal DNFSE - DANFSE DOC - DOC DPVAT - DPVAT DRF - DARF DUA - DUA DUAM - DUAM DUP - Duplicata EMP - Empréstimo ENC - Encargos FAT - Fatura FER - Férias FIA - Fiado FIN - Financiamento FPGT - Folha de Pagamento GARE - GARE GNRE - GNRE GPS - GPS GRCS - GRCS GRCSU - GRCSU GRF - Guia de Recolhimento do FGTS GRU - GRU GUIA - Guia de Recolhimento HOL - Holerite IMP - Imposto INV - Invoice IPTU - IPTU IPVA - IPVA JUROS - Juros Limite MED - Medição MULTA - Multas MUTUO - Mútuo NC - Nota de Crédito ND - Nota de Débito NF - Nota Fiscal NFA - Nota Fiscal de Abastecimento NFC - Nota Fiscal de Consumidor NFCE - Nota Fiscal de Consumidor Eletrônica NFD - Nota Fiscal de Devolução NFE - Nota Fiscal Eletrônica NFS - Nota Fiscal de Serviço NFST - Nota Fiscal de Telecomunicações PED - Pedido PEN - Pensão Alimentícia PER - Permuta PIX - Pix PROL - Pro-Labore PROT - Protesto PROV - Provisão REC - Recibo REE - Reembolso REND - Rendimentos RES - Resgate RET - Rescisão Trabalhista RPA - RPA SAQ - Saque TAR - Tarifa TED - TED TFE - Taxa de Fiscalização de Estabelecimentos TIC - Ticket TID - Título Descontado TRA - Transferência TRAV - Transferência à Vista TRLAV - Licenciamento TX - Taxa VIST - A Vista VOU - Voucher WSITE - Website Listagem completa disponível na API: /api/v1/geral/tiposdoc/."},"cFormaPagamento":{"type":"string","description":"Código da Forma de Pagamento. Valores possíveis: 01 - Dinheiro 02 - Cheque 03 - Cartão de Crédito 04 - Cartão de Débito 05 - Crédito Loja 10 - Vale Alimentação 11 - Vale Refeição 12 - Vale Presente 13 - Vale Combustível 14 - Duplicata Mercantil 15 - Boleto Bancário 16 - Depósito Bancário 17 - Pagamento Instantâneo (PIX) 18 - Transferência bancária, Carteira Digital 19 - Programa de fidelidade, Cashback, Crédito Virtual. 90 - Sem Pagamento 99 - Outros Listagem completa disponível na API: /api/v1/geral/meiospagamento/."}}},"description":"Dados das parcelas."}},"description":"Parcelas da NFe de recebimento."},"departamentos":{"type":"array","items":{"type":"object","properties":{"cCodDepartamento":{"type":"string","description":"Código do departamento. Informação localizada na Aba \"Departamentos\" do recebimento de NFe. Utilize a tag \"codigo\" do método \"ListarDepatartamentos\" da API /api/v1/geral/departamentos/ para obter essa informação."},"vDepartamento":{"type":"decimal","description":"Valor do rateio. Informação localizada na Aba \"Departamentos\" do recebimento de NFe."},"pDepartamento":{"type":"decimal","description":"Percentual de rateio. Informação localizada na Aba \"Departamentos\" do recebimento de NFe."}}},"description":"Departamentos da NFe de recebimento."},"categorias":{"type":"array","items":{"type":"object","properties":{"cCategoria":{"type":"string","description":"Código da categoria. Utilize a tag \"codigo\" do método \"ListarCategorias\" da API /api/v1/geral/categorias/ para obter essa informação."},"vCategoria":{"type":"decimal","description":"Valor do Rateio."},"pCategoria":{"type":"decimal","description":"Percentual de Rateio."}}},"description":"Categorias da NFe de recebimento."},"infoCadastro":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão."},"hInc":{"type":"string","description":"Hora da Inclusão."},"cUsuarioInc":{"type":"string","description":"Usuário da inclusão."},"dAlt":{"type":"string","description":"Data da Alteração."},"hAlt":{"type":"string","description":"Hora da Alteração."},"cUsuarioAlt":{"type":"string","description":"Usuário da alteração."},"cFaturado":{"type":"string","description":"Indica se a NFe foi faturada. Pode ser: S = Sim N = Não."},"dFat":{"type":"string","description":"Data do faturamento."},"hFat":{"type":"string","description":"Hora do faturamento."},"cUsuarioFat":{"type":"string","description":"Usuário do faturamento."},"cDevolvido":{"type":"string","description":"Indica se a NFe foi devolvida. Pode ser: S = Sim N = Não."},"cDevolvidoParc":{"type":"string","description":"Indica se a NFe foi devolvida parcialmente. Pode ser: S = Sim N = Não."},"dDev":{"type":"string","description":"Data da devolução da NFe."},"hDev":{"type":"string","description":"Hora da devolução da NFe."},"cUsuarioDev":{"type":"string","description":"Usuário da devolução da NFe."},"cRecebido":{"type":"string","description":"Indica se a NFe foi recebida. Pode ser: S = Sim N = Não."},"dRec":{"type":"string","description":"Data do recebimento da NFe."},"hRec":{"type":"string","description":"Hora do recebimento da NFe."},"cUsuarioRec":{"type":"string","description":"Usuário do recebimento da NFe."},"cAutorizado":{"type":"string","description":"Indica se a NFe foi autorizada. Pode ser: S = Sim N = Não."},"cBloqueado":{"type":"string","description":"Indica se a NFe foi bloqueada. Pode ser: S = Sim N = Não."},"cCancelada":{"type":"string","description":"Indica se a NFe foi cancelada. Pode ser: S = Sim N = Não."},"dCanc":{"type":"string","description":"Data de cancelamento da NFe."},"hCanc":{"type":"string","description":"Hora de cancelamento da NFe."},"cUsuarioCanc":{"type":"string","description":"Usuário do cancelamento da NFe."},"cDenegado":{"type":"string","description":"Indica se a NFe foi denegada. Pode ser: S = Sim N = Não."},"cOperacao":{"type":"string","description":"Indica o tipo de operacao de compra."}},"description":"Informações do cadastro da NFe."},"observacoes":{"type":"object","properties":{"cObs":{"type":"string","description":"Observações do recebimento (não serão exibidas na Nota Fiscal). Informação localizada na Aba \"Observações\" do Recebimento de NFe."}},"description":"Dados da Aba \"Observações\" do Recebimento de NFe."},"cteCfopEntrada":{"type":"object","properties":{"cCFOPEntrada":{"type":"string","description":"CFOP de entrada. Código Fiscal de Operações e Prestações. Utilize a tag \"nCodigo\" do método \"ListarCFOP\" da API /api/v1/produtos/cfop/ para obter essa informação."}},"description":"Dados da Aba \"CFOP de Entrada e Mais Detalhes\" do Recebimento de CT-e."}},"title":"ConsultarRecebimento (retorno)"},"produtos_recebimentonfe_ExcluirRecebimento":{"type":"object","title":"ExcluirRecebimento","description":"Excluir recebimento NFe.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirRecebimento"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdReceb":{"type":"integer","maxLength":15,"description":"ID do Recebimento."}},"required":["nIdReceb"]}}},"example":{"call":"ExcluirRecebimento","param":[{"nIdReceb":0}]}},"produtos_recebimentonfe_ExcluirRecebimento_retorno":{"type":"object","properties":{"nIdReceb":{"type":"integer","description":"Id do recebimento."},"cCodStatus":{"type":"string","description":"Código do status."},"cDescStatus":{"type":"string","description":"Descrição do status."}},"title":"ExcluirRecebimento (retorno)"},"produtos_recebimentonfe_ListarRecebimentos":{"type":"object","title":"ListarRecebimentos","description":"Listar recebimento de NFe.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarRecebimentos"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página."},"nRegistrosPorPagina":{"type":"integer","maxLength":15,"description":"Quantidade de registros por página."},"cOrdenarPor":{"type":"string","maxLength":100,"description":"Ordenar o resultado da página por:\n\nCODIGO - Id do recebimento;\nCHAVE - Chave de acesso da NF-e."},"dtAltDe":{"type":"string","maxLength":10,"description":"Filtra os registros a partir da data específicada."},"dtAltAte":{"type":"string","maxLength":10,"description":"Filtra os registros até a data específicada."},"hrAltDe":{"type":"string","maxLength":8,"description":"Filtra os registros a partir da hora específicada."},"hrAltAte":{"type":"string","maxLength":8,"description":"Filtra os registros até a hora específicada."},"dtEmissaoDe":{"type":"string","maxLength":10,"description":"Filtra os registros a partir da data de emissão específicada."},"dtEmissaoAte":{"type":"string","maxLength":10,"description":"Filtra os registros até a data de emissão específicada."},"nIdFornecedor":{"type":"integer","maxLength":15,"description":"Filtra os registros do fornecedor específicado."},"cEtapa":{"type":"string","maxLength":2,"description":"Filtra os registros da etapa específicada."},"cExibirDetalhes":{"type":"string","maxLength":1,"description":"Exibir os detalhes da nota de recebimento.\n\nPreencher com \"S\" ou \"N\"."}}}}},"example":{"call":"ListarRecebimentos","param":[{"nPagina":1,"nRegistrosPorPagina":50}]}},"produtos_recebimentonfe_ListarRecebimentos_retorno":{"type":"object","properties":{"nPagina":{"type":"integer"},"nTotalPaginas":{"type":"integer"},"nRegistros":{"type":"integer"},"nTotalRegistros":{"type":"integer"},"recebimentos":{"type":"array","items":{"type":"object","properties":{"cabec":{"type":"object","properties":{"nIdReceb":{"type":"integer","description":"ID do Recebimento Esse campo não é exibido na tela é uma informação interna, utilizada apenas nas APIs."},"nIdFornecedor":{"type":"integer","description":"Id do fornecedor. Utilize a tag \"codigo_cliente_omie\" do método \"ListarClientes\" da API /api/v1/geral/clientes/ para obter essa informação."},"cPessoaFisica":{"type":"string","description":"Indica se o fornecedor é pessoa física. Pode ser: S = Sim N = Não."},"cNome":{"type":"string","description":"Nome do fornecedor."},"cRazaoSocial":{"type":"string","description":"Razão social do fornecedor."},"cInscricao":{"type":"string","description":"Inscrição estadual do fornecedor."},"cCNPJ_CPF":{"type":"string","description":"CNPJ ou CPF do fornecedor."},"cChaveNfe":{"type":"string","description":"Chave da NFe."},"cEtapa":{"type":"string","description":"Etapa da NFe Esse campo indica em que coluna o recebimento da NFe irá figurar no processo de recebimento do Omie."},"cNumeroNFe":{"type":"string","description":"Número da NFe."},"cSerieNFe":{"type":"string","description":"Série da NFe."},"cModeloNFe":{"type":"string","description":"Modelo da NFe."},"dEmissaoNFe":{"type":"string","description":"Data de emissão da NFe."},"nValorNFe":{"type":"decimal","description":"Valor da NFe."},"cAmbienteNFe":{"type":"string","description":"Ambiente da NFe Pode ser: P = Produção H = Homologação."},"cNaturezaOperacao":{"type":"string","description":"Natureza da operação da NFe."}},"description":"Cabeçalho da NFe de recebimento."},"itensRecebimento":{"type":"array","items":{"type":"object","properties":{"itensCabec":{"type":"object","properties":{"nIdItem":{"type":"integer","description":"Id do item da NFe de recebimento."},"nIdPedido":{"type":"integer"},"nIdItPedido":{"type":"integer"},"nIdProduto":{"type":"integer","description":"Id do produto. Esse campo não é exibido na tela de itens do recebimento da NFe. É uma informação interna, utilizada apenas nas APIs. Utilize a tag \"codigo_produto\" do método \"ListarProdutos\" da API /api/v1/geral/produtos/ para obter essa informação."},"nSequencia":{"type":"integer","description":"Número sequencial do item da NFe de recebimento."},"cCodigoProduto":{"type":"string","description":"Código do Produto na NFe exibido na tela de recebimento."},"cDescricaoProduto":{"type":"string","description":"Descrição do produto."},"cIgnorarItem":{"type":"string","description":"Ignorar a importação do item da NFe de recebimento Pode ser: S = Sim N = Não."},"cAdicionarNovo":{"type":"string","description":"Cadastrar como novo produto o item da NFe de recebimento Pode ser: S = Sim N = Não."},"cAssociarExistente":{"type":"string","description":"Associar a um produto ou pedido existente o item da NFe de recebimento Pode ser: S = Sim N = Não."},"cItemDevolvido":{"type":"string","description":"Item da NFe de recebimento devolvido Pode ser: S = Sim N = Não."},"cNCM":{"type":"string","description":"NCM - Nomenclatura Comum do Mercosul Utilize a tag \"cCodigo\" do método \"ListarNCM\" da API /api/v1/produtos/ncm/ para obter essa informação."},"cEAN":{"type":"string","description":"Código EAN - European Article Number."},"cCFOP":{"type":"string","description":"CFOP - Código Fiscal de Operações e Prestações. Utilize a tag \"nCodigo\" do método \"ListarCFOP\" da API /api/v1/produtos/cfop/ para obter essa informação."},"nQtdeNFe":{"type":"decimal","description":"Quantidade da Nota."},"cUnidadeNfe":{"type":"string","description":"Unidade da Nota."},"nPrecoUnit":{"type":"decimal","description":"Preço unitário."},"vDesconto":{"type":"decimal","description":"Valor do desconto."},"vFrete":{"type":"decimal","description":"Valor do Frete."},"vTotalItem":{"type":"decimal","description":"Valor total do item."}},"description":"Cabeçalho do item da NFe de recebimento."},"itensAjustes":{"type":"object","properties":{"cNaoGerarFinanceiro":{"type":"string","description":"Não deve gerar uma conta a pagar para o item da NFe de recebimento. Valores possíveis: S - Sim N - Não."},"cNaoGerarMovEstoque":{"type":"string","description":"Não deve gerar movimento de estoque para o item da NFe de recebimento. Valores possíveis: S - Sim N - Não."},"nQtdeRecebida":{"type":"decimal","description":"Quantidade recebida."},"codigo_local_estoque":{"type":"integer","description":"ID do local de estoque. Caso não preenchido assumirá o local de estoque padrão."},"cUnidade":{"type":"string","description":"Unidade."},"cCFOPEntrada":{"type":"string","description":"CFOP de entrada. Código Fiscal de Operações e Prestações. Utilize a tag \"nCodigo\" do método \"ListarCFOP\" da API /api/v1/produtos/cfop/ para obter essa informação."},"itensSitTribEnt":{"type":"object","properties":{"cSitTribICMSE":{"type":"string","description":"Situação Tributária do ICMS."},"cSitTribIPIE":{"type":"string","description":"Situação Tributária do IPI."},"cSitTribPISE":{"type":"string","description":"Situação Tributária do PIS."},"cSitTribCOFINSE":{"type":"string","description":"Situação Tributária do COFINS."},"nBCPISE":{"type":"decimal","description":"Base de Cálculo do PIS."},"nAliqPISE":{"type":"decimal","description":"Alíquota do PIS (%)."},"nValPISE":{"type":"decimal","description":"Valor do PIS."},"nBCCOFINSE":{"type":"decimal","description":"Base de Cálculo do COFINS."},"nAliqCOFINSE":{"type":"decimal","description":"Alíquota do COFINS (%)."},"nValCOFINSE":{"type":"decimal","description":"Valor do COFINS."},"cNaoCredICMSE":{"type":"string","description":"Não deve se creditar do ICMS na entrada desse item. Informar: S - Sim N - Não."},"itensSitTribICMSSTEnt":{"type":"object","properties":{"nMargVrAdE":{"type":"decimal","description":"Margem de Valor Adicional."},"nRedBCSTE":{"type":"decimal","description":"Redução da BC do ICMS ST (%)."},"nBCSTE":{"type":"decimal","description":"Base de Cálculo do ICMS ST."},"nAliqSTE":{"type":"decimal","description":"Alíquota do ICMS ST (%)."},"nValorST":{"type":"decimal","description":"Valor do ICMS ST."},"nBCFCPE":{"type":"decimal","description":"Base de Cálculo do Fundo de Combate a Pobreza."},"nAliqFCPE":{"type":"decimal","description":"% do Fundo de Combate a Pobreza (ICMS ST)."},"nValorFCPE":{"type":"decimal","description":"Valor do Fundo de Combate a Pobreza."}},"description":"ICMS ST (Substituição Tributária) Opcional. Trata-se do ICMS-ST a ser recolhido por antecipação, quando o fornecedor não calculou o ICMS-ST na NF-e."}},"description":"Situações Tributárias de Entrada do item."}},"description":"Ajustes do item da NFe de recebimento."},"itensInfoAdic":{"type":"object","properties":{"nPesoLiquidoIt":{"type":"decimal","description":"Peso Líquido (Kg)."},"nPesoBrutoIt":{"type":"decimal","description":"Peso Bruto (Kg)."},"cCategoriaItem":{"type":"string","description":"Categoria do item."},"nNumPedCompra":{"type":"string","description":"Número do Pedido de Compra."},"cNumItPedCompra":{"type":"integer","description":"Item do Pedido de Compra."},"cNumFCI":{"type":"string","description":"Número da FCI - informação relacionada com a Resolução 13/2012 do Senado Federal."},"vAproxTributosIt":{"type":"decimal","description":"Valor Aprox. dos Tributos."},"codigo_local_estoque_saida":{"type":"integer","description":"Id do local de estoque de saída."}},"description":"Informações adicionais do item da NFe de recebimento."},"itensICMS":{"type":"object","properties":{"cSitTrib":{"type":"string","description":"Situação Tributária do ICMS."},"cOrigem":{"type":"string","description":"Origem do ICMS."},"cModBC":{"type":"string","description":"Modalidade da Base de Cálculo do ICMS Substituição Tributária."},"nRedBC":{"type":"decimal","description":"Redução da Base de Cálculo do ICMS (%)."},"nBC":{"type":"decimal","description":"Base de Cálculo do ICMS."},"nAliq":{"type":"decimal","description":"Alíquota de ICMS."},"nValor":{"type":"decimal","description":"Valor do ICMS."},"nBCStRecAnt":{"type":"decimal","description":"Base do ICMS Substituição Tributária Recebido Anteriormente."},"nAliqStRecAnt":{"type":"decimal","description":"Alíquota do ICMS Substituição Tributária Recebido Anteriormente."},"nValorStRecAnt":{"type":"decimal","description":"Valor do ICMS Substituição Tributária Recebido Anteriormente."},"nPercDif":{"type":"decimal","description":"Percentual do Diferimento (%)."},"nValorDif":{"type":"decimal","description":"Valor do ICMS Diferido."},"nValorSubst":{"type":"decimal","description":"Valor do ICMS do Substituto."},"nValorOpProp":{"type":"decimal","description":"Valor do ICMS Operação Própria."}},"description":"Informações do ICMS."},"itensICMSST":{"type":"object","properties":{"cModBCST":{"type":"string","description":"Modalidade da Base de Cálculo do ICMS Substituição Tributária."},"nMargVrAd":{"type":"decimal","description":"Margem de Valor Adicionado (%)."},"nRedBCST":{"type":"decimal","description":"Redução da BC do ICMS ST (%)."},"nBCST":{"type":"decimal","description":"Base de Cálculo do ICMS ST."},"nAliqST":{"type":"decimal","description":"Alíquota do ICMS ST (%)."},"nAliqOP":{"type":"decimal","description":"Alíquota do ICMS Operação Própria (%)."},"nValorST":{"type":"decimal","description":"Valor do ICMS ST."},"cCEST":{"type":"string","description":"CEST (Código Especificador da Substituição Tributária)."}},"description":"Informações do ICMS Substituição Tributária."},"itensICMSSN":{"type":"object","properties":{"cSitTribSN":{"type":"string","description":"Situação Tributária do ICMS."},"cOrigem":{"type":"string","description":"Origem."},"nBCSNST":{"type":"decimal","description":"Base de Cálculo do ICMS Retido."},"nValorSNST":{"type":"decimal","description":"Valor do ICMS Retido por ST."},"nAliqCredSN":{"type":"decimal","description":"Alíq. de Cálculo de Crédito (%)."},"nCredSN":{"type":"decimal","description":"Crédito do ICMS Aproveitado."},"cModBCSN":{"type":"string","description":"Modalidade da BC do ICMS."},"nAliqRedBCSN":{"type":"decimal","description":"Redução da BC do ICMS (%)."},"nBCSN":{"type":"decimal","description":"Base de Cálculo do ICMS."},"nAliqSN":{"type":"decimal","description":"Alíquota do ICMS (%)."},"nValorSN":{"type":"decimal","description":"Valor do ICMS."}},"description":"Informações do ICMS Simples Nacional."},"itensIPI":{"type":"object","properties":{"cSitTribIPI":{"type":"string","description":"Situação Tributária do IPI."},"cTpCalcIPI":{"type":"string","description":"Tipo de Cálculo para obter o IPI."},"nBCIPI":{"type":"decimal","description":"Base de Cálculo do IPI."},"nAliqIPI":{"type":"decimal","description":"Alíquota do IPI (%)."},"nQtdUTIPI":{"type":"decimal","description":"Quantidade de Unidades Tributáveis."},"nValIPIUT":{"type":"decimal","description":"Valor do IPI por UnididadeTributável."},"cEnqIPI":{"type":"string","description":"Enquadramento do IPI."},"nValIPI":{"type":"decimal","description":"Valor do IPI."},"nValIPIDev":{"type":"decimal","description":"Valor do IPI Devolvido."}},"description":"Informações do IPI."},"itensPIS":{"type":"object","properties":{"cSitTribPIS":{"type":"string","description":"Situação Tributária do PIS."},"cTpCalcPIS":{"type":"string","description":"Tipo de Cálculo para obter o PIS."},"nBCPIS":{"type":"decimal","description":"Base de Cálculo do PIS."},"nAliqPIS":{"type":"decimal","description":"Alíquota do PIS (%)."},"nQtdUTPIS":{"type":"decimal","description":"Quantidade Unidades Tributáveis."},"nValPISUT":{"type":"decimal","description":"Valor do PIS por Unididade Tributável."},"nValPIS":{"type":"decimal","description":"Valor do PIS."}},"description":"Informações do PIS."},"itensCOFINS":{"type":"object","properties":{"cSitTribCOFINS":{"type":"string","description":"Situação Tributária do COFINS."},"cTpCalcCOFINS":{"type":"string","description":"Tipo de Cálculo para obter o COFINS."},"nBCCOFINS":{"type":"decimal","description":"Base de Cálculo do COFINS."},"nAliqCOFINS":{"type":"decimal","description":"Alíquota do COFINS (%)."},"nQtdUTCOFINS":{"type":"decimal","description":"Quantidade Unidades Tributáveis."},"nVaCOFINSSUT":{"type":"decimal","description":"Valor do COFINS Unidade Tributável."},"nValCOFINS":{"type":"decimal","description":"Valor do COFINS."}},"description":"Informações do COFINS."},"itensAtualPreco":{"type":"object","properties":{"cAtualizarAtuPre":{"type":"string","description":"Quero atualizar automaticamente o preço de venda deste produto no recebimento da compra Informar \"S\" ou \"N\"."},"nPercAtuPre":{"type":"decimal","description":"Percentual utilizado para a atualização."},"cAtualizarMaiorAtuPre":{"type":"string","description":"Atualizar apenas se o novo preço for maior que o preço de venda atual do produto. Informar \"S\" ou \"N\"."}},"description":"Informações de atualização do preço de venda."},"itensCustoEstoque":{"type":"object","properties":{"cICMSCusto":{"type":"string","description":"ICMS é custo de estoque. Informar \"S\" ou \"N\"."},"cPISCusto":{"type":"string","description":"PIS é custo de estoque. Informar \"S\" ou \"N\"."},"cICMSSTCusto":{"type":"string","description":"ICMS ST é custo de estoque. Informar \"S\" ou \"N\"."},"cCOFINSCusto":{"type":"string","description":"COFINS é custo de estoque. Informar \"S\" ou \"N\"."},"cIPICusto":{"type":"string","description":"IPI é custo de estoque. Informar \"S\" ou \"N\"."},"cFreteCusto":{"type":"string","description":"Frete é custo de estoque. Informar \"S\" ou \"N\"."},"cSeguroCusto":{"type":"string","description":"Seguro é custo de estoque. Informar \"S\" ou \"N\"."},"cOutrosDespCusto":{"type":"string","description":"Outras Desp. é custo de estoque. Informar \"S\" ou \"N\"."},"nValorICMSSTCusto":{"type":"decimal","description":"Valor do ICMS ST."},"nAliqCredPISCusto":{"type":"decimal","description":"% Alíquota de Crédito do PIS."},"nAliqCredCOFINSCusto":{"type":"decimal","description":"% Alíquota de Crédito do COFINS."}},"description":"Informações do custo."},"itensCBS":{"type":"object","properties":{"nAliqCbsReg":{"type":"decimal","description":"Valor da alíquota da CBS."},"nPercDiferimentoCbs":{"type":"decimal","description":"Percentual do diferimento - CBS."},"nValDiferimentoCbs":{"type":"decimal","description":"Valor do diferimento - CBS."},"nValCbs":{"type":"decimal","description":"Valor da CBS."},"nPercReducaoCbs":{"type":"decimal","description":"Percentual da redução de alíquota do cClassTrib - CBS."}},"description":"Informações doda CBS"},"itensIBS":{"type":"object","properties":{"nAliqIbsUfReg":{"type":"decimal","description":"Valor da alíquota do IBS da UF."},"nPercDiferimentoIbsUf":{"type":"decimal","description":"Percentual do Diferimento - IBS UF."},"nValDiferimentoIbsUf":{"type":"decimal","description":"Valor do diferimento - IBS."},"nPercReducaoIbsUf":{"type":"decimal","description":"Percentual da redução de alíquota do cClassTrib - IBS UF."},"nValIbsUf":{"type":"decimal","description":"Valor do IBS de competência da UF."},"nValDiferimentoIbsMun":{"type":"decimal","description":"Valor do Diferimento - IBS Município."},"nPercReducaoIbsMun":{"type":"decimal","description":"Percentual da redução de alíquota do cClassTrib - IBS Município."},"nAliqIbsMunReg":{"type":"decimal","description":"Valor da alíquota do IBS do Município."},"nValIbs":{"type":"decimal","description":"Valor do IBS."},"nValIbsMun":{"type":"decimal","description":"Valor do IBS de competência do Município."}},"description":"Informações do IBS."},"itensCbsIbs":{"type":"object","properties":{"cCstIbsCbs":{"type":"string","description":"Código de Situação Tributária do IBS e CBS."},"cClassTrib":{"type":"string","description":"Código de Classificação Tributária do IBS e CBS."},"nBaseIbsCbs":{"type":"decimal","description":"Base de cálculo do IBS e CBS."}},"description":"Informações unificadas sobre o IBS e CBS."}}},"description":"Itens da NFe de recebimento."},"infoAdicionais":{"type":"object","properties":{"cCategCompra":{"type":"string","description":"Código da categoria da compra. Informação localizada na Aba \"Informações Adicionais\" do recebimento de NFe. Utilize a tag \"codigo\" do método \"ListarCategorias\" da API /api/v1/geral/categorias/ para obter essa informação."},"nIdConta":{"type":"integer","description":"Id da conta corrente. Informação localizada na Aba \"Informações Adicionais\" do recebimento de NFe. Utilize a tag \"codigo\" do método \"PesquisarContaCorrente\" da API /api/v1/geral/contacorrente/ para obter essa informação."},"dRegistro":{"type":"string","description":"Data de registro."},"nIdComprador":{"type":"integer","description":"Id do comprador."},"nIdProjeto":{"type":"integer","description":"Id do projeto Informação localizada na Aba \"Informações Adicionais\" do Recebimento de NFe. Utilize a tag \"codigo\" do método \"ListarProjetos\" da API /api/v1/geral/projetos/ para obter essa informação."}},"description":"Informações adicionais da NFe de recebimento."},"transporte":{"type":"object","properties":{"cTipoFrete":{"type":"string","description":"Frete - Código do tipo."},"nIdTransportador":{"type":"integer","description":"Frete - Id do transportador."},"nQtdeVolume":{"type":"integer","description":"Frete/Volumes - Quantidade."},"cEspecieVolume":{"type":"string","description":"Frete/Volumes - Espécie."},"cMarcaVolume":{"type":"string","description":"Frete/Volumes - Marca."},"cNumeroVolume":{"type":"string","description":"Frete/Volumes - Numeração."},"nPesoLiquido":{"type":"decimal","description":"Frete/Volumes - Peso Líquido (Kg)."},"nPesoBruto":{"type":"decimal","description":"Frete/Volumes - Peso Bruto (Kg)."},"cNumeroLacre":{"type":"string","description":"Frete - Número do lacre."},"cPlacaVeiculo":{"type":"string","description":"Frete/Veículo - Placa."},"cUFVeiculo":{"type":"string","description":"Frete/Veículo - Unidade federativa."},"cRNTRC":{"type":"string","description":"Frete/Veículo - RNTRC (ANTT) - Registro Nacional de Transportador de Cargas."},"cNomeTransp":{"type":"string","description":"Nome da Transportadora."},"cRazaoTransp":{"type":"string","description":"Razao Social da Transportadora."},"cCnpjCpfTransp":{"type":"string","description":"CNPJ ou CPF da Transportadora."}},"description":"Transporte da NFe de recebimento."},"totais":{"type":"object","properties":{"bcICMS":{"type":"decimal","description":"Báse de Cálculo do ICMS."},"vICMS":{"type":"decimal","description":"Valor do ICMS."},"vICMSDesonerado":{"type":"decimal","description":"Valor do ICMS Desonerado."},"bcICMSST":{"type":"decimal","description":"Base de Cálculo ICMS ST."},"vICMSSubstituicao":{"type":"decimal","description":"Valor ICMS Substituição."},"vTotalProdutos":{"type":"decimal","description":"Valor Total dos Produtos."},"vFrete":{"type":"decimal","description":"Valor do Frete."},"vSeguro":{"type":"decimal","description":"Valor do Seguro."},"vOutrasDespesas":{"type":"decimal","description":"Valor Total de Outras Despesas Acessórias."},"vTotalIPI":{"type":"decimal","description":"Valor Total do IPI."},"vTotalNFe":{"type":"decimal","description":"Valot Total da Nota Fiscal."},"vTotalDescontos":{"type":"decimal","description":"Valor Total do Desconto."},"vTotalPIS":{"type":"decimal","description":"Valor Total do PIS."},"vTotalCOFINS":{"type":"decimal","description":"Valor Total do COFINS."},"vAproxTributos":{"type":"decimal","description":"Valor Aproximado dos Tributos."},"nBaseIbsCbs":{"type":"decimal","description":"Valor total da base de cálculo do IBS e da CBS."},"nValIBS":{"type":"decimal","description":"Valor total da IBS."},"nValCbs":{"type":"decimal","description":"Valor total da CBS."},"nValIbsMun":{"type":"decimal","description":"Valor total do IBS do município."},"nValIbsUf":{"type":"decimal","description":"Valor total do IBS da UF."},"nValDiferimentoIbsUf":{"type":"decimal","description":"Valor total do diferimento do IBS UF."},"nValDiferimentoIbsMun":{"type":"decimal","description":"Valor total do diferimento do IBS do município."}},"description":"Totais da NFe de recebimento."},"parcelas":{"type":"object","properties":{"cCodParcela":{"type":"string","description":"Código do número de parcelas Utilize a tag \"nCodigo\" do método \"ListarFormasPagVendas\" da API /api/v1/produtos/formaspagvendas/ para obter essa informação. O código \"999\" é o único que permite uma definição de forma de pagamento customizada. Caso você escolha essa opção, deve também informar a tag \"qtde_parcelas\" e a estrutura \"lista_parcelas\". Alguns dos valores disponíveis são: \"000\" - A Vista \"A03\" - Para 3 dias \"A05\" - Para 5 dias \"A07\" - Para 7 dias \"A08\" - Para 8 dias \"A09\" - Para 9 dias \"A10\" - Para 10 dias \"A13\" - Para 13 dias \"A14\" - Para 14 dias \"A15\" - Para 15 dias \"A17\" - Para 17 dias \"A20\" - Para 20 dias \"A21\" - Para 21 dias \"A25\" - Para 25 dias \"A26\" - Para 26 dias \"A28\" - Para 28 dias \"A35\" - Para 35 dias \"A36\" - Para 36 dias \"A40\" - Para 40 dias \"A42\" - Para 42 dias \"A45\" - Para 45 dias \"A50\" - Para 50 dias \"A56\" - Para 56 dias \"A60\" - Para 60 dias \"A70\" - Para 70 dias \"A75\" - Para 75 dias \"A90\" - Para 90 dias \"A98\" - Para 98 dias \"B20\" - Para 120 dias \"001\" - 1 Parcela (para 30 dias) \"002\" - 2 Parcelas \"003\" - 3 Parcelas \"004\" - 4 Parcelas \"005\" - 5 Parcelas \"006\" - 6 Parcelas \"007\" - 7 Parcelas \"010\" - 10 Parcelas \"012\" - 12 Parcelas \"024\" - 24 Parcelas \"036\" - 36 Parcelas \"048\" - 48 Parcelas \"S01\" - 30/60 \"S02\" - 45/60 \"S03\" - 21/28/35 \"S04\" - 21/28/35/42 \"S05\" - 28/35/42 \"S06\" - 28/35/42/49 \"S07\" - 30/45/60/75/90 \"S08\" - 25/56 \"S09\" - 30/45 \"S10\" - 28/56 \"S11\" - 10/30/60 \"S12\" - 15/30/60 \"S13\" - 28/35 \"S14\" - 7/14/21 \"S15\" - 10/30/60/90 \"S16\" - 60/90/120 \"S17\" - 45/60/90 \"S18\" - 30/60/90 \"S19\" - 14/21 \"S20\" - 7/14 \"S21\" - 14/21/28 \"S22\" - 45/75 \"S23\" - 30/45/60 \"S24\" - 3/20/40 \"S25\" - 30/60/90/120 \"S26\" - 21/28 \"S27\" - a Vista/15 \"S28\" - a Vista/30 \"S29\" - a Vista/30/60 \"S30\" - a Vista/30/60/90 \"S31\" - a Vista/30/60/90/120/150 \"S41\" - 28/42/56 \"S32\" - 15/45/75 \"S33\" - 14/28/42 \"S34\" - 14/21/28/35/42 \"S35\" - 30/42/54/66/78/90 \"S36\" - 14/21/28/35 \"S37\" - 28/42 \"S38\" - 30/45/60 \"S39\" - 35/42/49/56 \"S40\" - 28/42/56/70 \"S42\" - 30/40/50/60 \"S43\" - 30/50/70/90 \"S44\" - 14/28 \"S45\" - 45/60/75/90 \"S46\" - a Vista/30/60/90/120 \"S47\" - a vista/20/40/60 \"S48\" - 21/42 \"S49\" - 15/30/45 \"S50\" - 14/42 \"S51\" - 21/35 \"S52\" - 28/56/84 \"S53\" - 28/42/56/70/84 \"S54\" - a Vista/30/45 \"S55\" - 21/45 \"S56\" - a Vista/28 \"S57\" - a Vista/60/90 \"S58\" - 35/45/55 \"S59\" - 28/35/42/56 \"S60\" - 30/45/60/75 \"S61\" - 28/35/42/49/56 \"S62\" - 40/70/100 \"S63\" - 42/56 \"S64\" - a Vista/28/35 \"S65\" - 35/42 \"S66\" - 20/40 \"S67\" - a Vista/28/35/42 \"S68\" - a vista/20/40/60/80 \"S69\" - a vista/20/40/60/80/100 \"S70\" - a vista/20/40/60/80/100/120 \"S71\" - a vista/30/60/90/120/150/180/210/240/270/300/330/360 \"S72\" - a vista/30/60/90/120/150/180/210/240/270/300 \"S73\" - 28/56/84/112 \"S74\" - 14/28/42/56 \"S75\" - 28/42/56/70/84/98 \"S76\" - 15/30/45/60/75 \"S77\" - a Vista/15/30 \"S78\" - a Vista/20/40 \"S79\" - 35/42/56 \"S80\" - 10/30/60/90/120 \"S81\" - 15/30/45/75/90/105/120 \"S82\" - 30/45/75/90/105/120 \"S83\" - 42/49/56 \"S84\" - 35/42/49 \"S85\" - a Vista/60/90/120/150 \"S86\" - a Vista/30/45/60 \"S87\" - 20/40/60/80/100 \"S89\" - 15/30 \"S90\" - 10/30/50 \"S91\" - 45/52/60 \"S92\" - 10/30 \"S93\" - 20/30/40/50/60/70 \"S94\" - 45/52/59/66 \"S95\" - 15/30/45/60 \"S96\" - 40/50 \"S97\" - 21/42/56 \"S98\" - a vista/60/90/120/150/180/240/300/330 \"S99\" - a vista/180 \"T01\" - 30/40/50 \"T02\" - 21/28/35/42/49 \"T03\" - 30/37/45/60 \"T04\" - a vista/30/60/90/120/150/180/210/240/270 \"T05\" - a vista/30/60/90/120/150/180/210 \"T06\" - 30/60/90/120/150/180/210/240 \"T07\" - 56/84/112 \"T08\" - 15/30/45/60/75/90/105 \"T09\" - 21/35/42 \"T10\" - 35/49 \"T11\" - 30/45/60/75/90/105/120 \"T12\" - 45/75/105/135 \"T13\" - 35/60/75 \"T14\" - 10/40/70/100/130 \"T15\" - 45/60/75 \"T16\" - 40/55/70 \"T17\" - 40/70 \"T18\" - 20/40/60 \"T19\" - 60/90 \"T20\" - 25/35/45/55 \"T21\" - 15/45 \"T22\" - 7/30/45 \"T23\" - 7/30/60 \"T24\" - 64/71 \"T25\" - 20/30/40 \"999\" - Informar o número de parcelas."},"nQtdParcela":{"type":"integer","description":"Número de Parcelas."},"parcelasLista":{"type":"array","items":{"type":"object","properties":{"dVencimento":{"type":"string","description":"Data de vencimento da parcela."},"nIdTitulo":{"type":"integer","description":"ID da Conta a Receber ou a Pagar."},"nSequencia":{"type":"integer","description":"Número da Parcela."},"vParcela":{"type":"decimal","description":"Valor da parcela."},"pParcela":{"type":"decimal","description":"Percentual da parcela."},"cTipoDocumento":{"type":"string","description":"Código para o Tipo de Documento. Valores possíveis: 13S - 13o. Salário 99999 - Outros ACO - Acordo ACOB - Acordo - Boleto ACOT - Acordo - Transferência ADI - Adiantamento ANT - Antecipação APL - Aplicação APO - Apólice BIL - Bilhete BOL - Boleto BOLV - Boleto à Vista BONUS - Bonus CAP - Capitalização CF - Cupom Fiscal CHD - Cheque Devolvido CHP - Cheque Pré CHQ - Cheque CHT - Cheque de Terceiros CNT - Crédito em Conta COB - Cobrança COM - Comissão CON - Convênios CONC - Cobrança de Concessionária COND - Condicional CONS - Consignado CONSO - Consórcio CRC - Cartão de Crédito CRD - Cartão de Débito CRE - Crediário CRT - Cartão CTE - CT-e CTR - Contrato CUSJ - Custos Judiciais DACTE - DACTE DAE - DAE DAJE - DAJE DAM - DAM DANFE - DANFE DAR - DAR DARE - DARE DARJ - DARJ DARM - DARM DAS - DAS DDA - DDA DEB - Débito em Conta DEBA - Débito Automático DEP - Depósito DEV - Devolução DFE - Documento Fiscal Equivalente DIN - Dinheiro DLC - Distribuição de Lucros DNF - Documento não fiscal DNFSE - DANFSE DOC - DOC DPVAT - DPVAT DRF - DARF DUA - DUA DUAM - DUAM DUP - Duplicata EMP - Empréstimo ENC - Encargos FAT - Fatura FER - Férias FIA - Fiado FIN - Financiamento FPGT - Folha de Pagamento GARE - GARE GNRE - GNRE GPS - GPS GRCS - GRCS GRCSU - GRCSU GRF - Guia de Recolhimento do FGTS GRU - GRU GUIA - Guia de Recolhimento HOL - Holerite IMP - Imposto INV - Invoice IPTU - IPTU IPVA - IPVA JUROS - Juros Limite MED - Medição MULTA - Multas MUTUO - Mútuo NC - Nota de Crédito ND - Nota de Débito NF - Nota Fiscal NFA - Nota Fiscal de Abastecimento NFC - Nota Fiscal de Consumidor NFCE - Nota Fiscal de Consumidor Eletrônica NFD - Nota Fiscal de Devolução NFE - Nota Fiscal Eletrônica NFS - Nota Fiscal de Serviço NFST - Nota Fiscal de Telecomunicações PED - Pedido PEN - Pensão Alimentícia PER - Permuta PIX - Pix PROL - Pro-Labore PROT - Protesto PROV - Provisão REC - Recibo REE - Reembolso REND - Rendimentos RES - Resgate RET - Rescisão Trabalhista RPA - RPA SAQ - Saque TAR - Tarifa TED - TED TFE - Taxa de Fiscalização de Estabelecimentos TIC - Ticket TID - Título Descontado TRA - Transferência TRAV - Transferência à Vista TRLAV - Licenciamento TX - Taxa VIST - A Vista VOU - Voucher WSITE - Website Listagem completa disponível na API: /api/v1/geral/tiposdoc/."},"cFormaPagamento":{"type":"string","description":"Código da Forma de Pagamento. Valores possíveis: 01 - Dinheiro 02 - Cheque 03 - Cartão de Crédito 04 - Cartão de Débito 05 - Crédito Loja 10 - Vale Alimentação 11 - Vale Refeição 12 - Vale Presente 13 - Vale Combustível 14 - Duplicata Mercantil 15 - Boleto Bancário 16 - Depósito Bancário 17 - Pagamento Instantâneo (PIX) 18 - Transferência bancária, Carteira Digital 19 - Programa de fidelidade, Cashback, Crédito Virtual. 90 - Sem Pagamento 99 - Outros Listagem completa disponível na API: /api/v1/geral/meiospagamento/."}}},"description":"Dados das parcelas."}},"description":"Parcelas da NFe de recebimento."},"departamentos":{"type":"array","items":{"type":"object","properties":{"cCodDepartamento":{"type":"string","description":"Código do departamento. Informação localizada na Aba \"Departamentos\" do recebimento de NFe. Utilize a tag \"codigo\" do método \"ListarDepatartamentos\" da API /api/v1/geral/departamentos/ para obter essa informação."},"vDepartamento":{"type":"decimal","description":"Valor do rateio. Informação localizada na Aba \"Departamentos\" do recebimento de NFe."},"pDepartamento":{"type":"decimal","description":"Percentual de rateio. Informação localizada na Aba \"Departamentos\" do recebimento de NFe."}}},"description":"Departamentos da NFe de recebimento."},"categorias":{"type":"array","items":{"type":"object","properties":{"cCategoria":{"type":"string","description":"Código da categoria. Utilize a tag \"codigo\" do método \"ListarCategorias\" da API /api/v1/geral/categorias/ para obter essa informação."},"vCategoria":{"type":"decimal","description":"Valor do Rateio."},"pCategoria":{"type":"decimal","description":"Percentual de Rateio."}}},"description":"Categorias da NFe de recebimento."},"infoCadastro":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão."},"hInc":{"type":"string","description":"Hora da Inclusão."},"cUsuarioInc":{"type":"string","description":"Usuário da inclusão."},"dAlt":{"type":"string","description":"Data da Alteração."},"hAlt":{"type":"string","description":"Hora da Alteração."},"cUsuarioAlt":{"type":"string","description":"Usuário da alteração."},"cFaturado":{"type":"string","description":"Indica se a NFe foi faturada. Pode ser: S = Sim N = Não."},"dFat":{"type":"string","description":"Data do faturamento."},"hFat":{"type":"string","description":"Hora do faturamento."},"cUsuarioFat":{"type":"string","description":"Usuário do faturamento."},"cDevolvido":{"type":"string","description":"Indica se a NFe foi devolvida. Pode ser: S = Sim N = Não."},"cDevolvidoParc":{"type":"string","description":"Indica se a NFe foi devolvida parcialmente. Pode ser: S = Sim N = Não."},"dDev":{"type":"string","description":"Data da devolução da NFe."},"hDev":{"type":"string","description":"Hora da devolução da NFe."},"cUsuarioDev":{"type":"string","description":"Usuário da devolução da NFe."},"cRecebido":{"type":"string","description":"Indica se a NFe foi recebida. Pode ser: S = Sim N = Não."},"dRec":{"type":"string","description":"Data do recebimento da NFe."},"hRec":{"type":"string","description":"Hora do recebimento da NFe."},"cUsuarioRec":{"type":"string","description":"Usuário do recebimento da NFe."},"cAutorizado":{"type":"string","description":"Indica se a NFe foi autorizada. Pode ser: S = Sim N = Não."},"cBloqueado":{"type":"string","description":"Indica se a NFe foi bloqueada. Pode ser: S = Sim N = Não."},"cCancelada":{"type":"string","description":"Indica se a NFe foi cancelada. Pode ser: S = Sim N = Não."},"dCanc":{"type":"string","description":"Data de cancelamento da NFe."},"hCanc":{"type":"string","description":"Hora de cancelamento da NFe."},"cUsuarioCanc":{"type":"string","description":"Usuário do cancelamento da NFe."},"cDenegado":{"type":"string","description":"Indica se a NFe foi denegada. Pode ser: S = Sim N = Não."},"cOperacao":{"type":"string","description":"Indica o tipo de operacao de compra."}},"description":"Informações do cadastro da NFe."},"observacoes":{"type":"object","properties":{"cObs":{"type":"string","description":"Observações do recebimento (não serão exibidas na Nota Fiscal). Informação localizada na Aba \"Observações\" do Recebimento de NFe."}},"description":"Dados da Aba \"Observações\" do Recebimento de NFe."}}}}},"title":"ListarRecebimentos (retorno)"},"produtos_recebimentonfe_ReverterRecebimento":{"type":"object","title":"ReverterRecebimento","description":"Reverter recebimento NFe.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ReverterRecebimento"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdReceb":{"type":"integer","maxLength":15,"description":"ID do recebimento\n\n\nEsse campo não é exibido na tela é uma informação interna, utilizada apenas nas APIs."},"cChaveNfe":{"type":"string","maxLength":44,"description":"Chave da NFe."},"cEtapa":{"type":"string","maxLength":2,"description":"Etapa da NFe."}}}}},"example":{"call":"ReverterRecebimento","param":[{"nIdReceb":0,"cChaveNfe":"","cEtapa":""}]}},"produtos_recebimentonfe_ReverterRecebimento_retorno":{"type":"object","properties":{"nIdReceb":{"type":"integer","description":"Id do recebimento."},"cCodStatus":{"type":"string","description":"Código do status."},"cDescStatus":{"type":"string","description":"Descrição do status."}},"title":"ReverterRecebimento (retorno)"},"produtos_remessa_AlterarRemessa":{"type":"object","title":"AlterarRemessa","description":"Altera uma remessa.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarRemessa"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cabec":{"type":"object","properties":{"nCodRem":{"type":"integer","maxLength":15,"description":"Código da Remessa no Omie"},"cCodIntRem":{"type":"string","maxLength":60,"description":"Código de Integração da Remessa"},"nCodCli":{"type":"integer","maxLength":15,"description":"Código do Cliente"},"cCodIntCli":{"type":"string","maxLength":60,"description":"Código de Integração do Cliente"},"dPrevisao":{"type":"string","maxLength":10,"description":"Data da Previsão"},"nCodVend":{"type":"integer","maxLength":15,"description":"Código do Vendedor"},"cNumeroRemessa":{"type":"string","maxLength":15,"description":"Número da Remessa exibido na tela."},"codigo_cenario_impostos":{"type":"integer","maxLength":15,"description":"Código do cenário de impostos.\n\nSe não informado, será assumido o cenário padrão."},"cCancelado":{"type":"string","maxLength":1,"example":"S","description":"Indica se a remessa está cancelada (S/N).\n\nUtilizado apenas nos métodos de Consulta/Listagem."}}},"frete":{"type":"object","properties":{"nCodTransp":{"type":"integer","maxLength":15,"description":"Código da Transportadora"},"cTpFrete":{"type":"string","maxLength":1,"description":"Tipo de Frete\n\nPode ser:\n\n0 - Contratação do Frete por conta do Remetente (CIF)\n1 - Contratação do Frete por conta do Destinatário (FOB)\n2 - Contratação do Frete por conta de Terceiros\n3 - Transporte Próprio por conta do Remetente\n4 - Transporte Próprio por conta do Destinatário\n9 - Sem Ocorrência de Transporte"},"cPlaca":{"type":"string","maxLength":7,"description":"Placa do Veículo"},"cUF":{"type":"string","maxLength":2,"description":"UF da Placa"},"nQtdVol":{"type":"integer","maxLength":15,"description":"Quantidade de Volumes"},"cEspVol":{"type":"string","maxLength":60,"description":"Espécie de Volume.\n\nCampo livre, podendo ser o tipo de carga, como: caixa, fardo, palete, entre outros."},"cMarVol":{"type":"string","maxLength":60,"description":"Marca dos Volumes"},"cNumVol":{"type":"string","maxLength":60,"description":"Numeração dos Volumes"},"nPesoLiq":{"type":"number","maxLength":18,"description":"Peso Liquído (Kg)"},"nPesoBruto":{"type":"number","maxLength":18,"description":"Peso Bruto (Kg)"},"nValFrete":{"type":"number","maxLength":18,"description":"Valor do Frete"},"nValSeguro":{"type":"number","maxLength":18,"description":"Valor do Seguro"},"nValOutras":{"type":"number","maxLength":18,"description":"Valor de Outras Despesas Acessórias"}}},"infAdic":{"type":"object","properties":{"cCodCateg":{"type":"string","maxLength":20,"description":"Código da Categoria"},"cContato":{"type":"string","maxLength":100,"description":"Contato"},"nCodProj":{"type":"integer","maxLength":15,"description":"Código do Projeto"},"cPedido":{"type":"string","maxLength":30,"description":"Número do Pedido do cliente"},"cNumCtr":{"type":"string","maxLength":20,"description":"Número do Contrato de Venda"},"cDadosAdic":{"type":"string","description":"Dados Adicionais para a Nota Fiscal"},"cConsFinal":{"type":"string","maxLength":1,"description":"Nota Fiscal para Consumidor Final (S/N)"},"outros_detalhes":{"type":"object","properties":{"cNatOperacaoOd":{"type":"string","maxLength":60,"description":"Natureza da Operação.\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cIndicadorOd":{"type":"string","maxLength":1,"description":"Indicador de Presença da Operação.\n\n1 - Operação presencial.\n2 - Operação não presencial, pela Internet.\n3 - Operação não presencial, Teleatendimento.\n4 - NFC-e em operação com entrega a domicílio.\n9 -Operação não presencial, outros.\n\n\nSe não informado, utilizaremos automaticamente o \"9 - Outros\".\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cIndicadorIntOd":{"type":"string","maxLength":1,"description":"Indicador de Intermediador.\n\n\nEsta informação deverá ser enviada quando se tratar de uma operação não presencial.\n\nOpções disponíveis:\n0=Operação sem intermediador(em site ou plataforma própria)\n1=Operação em site ou plataforma de terceiros(intermediadores/marketplace)\n\nSe não informado, utilizaremos automaticamente a opção \"0-Operação sem intermediador(em site ou plataforma própria)\".\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cCnpjIntOd":{"type":"string","maxLength":20,"description":"CNPJ do Intermediador.\n\nPreencimento obrigatório caso o Indicador de Intermediador seja igual a opção \"1-Operação em site ou plataforma de terceiros(intermediadores/marketplace)\".\n\nEste campo representa o CNPJ do Intermediador da Transação.\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cIdentificadorIntOd":{"type":"string","maxLength":60,"description":"Identificação no Intermediador.\n\n\nEste identificador pode ser o nome do usuário ou identificação do perfil do vendedor no site do intermediador.\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"dDataSaidaOd":{"type":"string","maxLength":10,"description":"Data de Saída.\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cHoraSaidaOd":{"type":"string","maxLength":8,"description":"Hora de Saída.\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cCnpjCpfOd":{"type":"string","maxLength":20,"description":"CNPJ / CPF (do recebedor).\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cNomeOd":{"type":"string","maxLength":60,"description":"Nome / Razão Social.\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cInscrEstadualOd":{"type":"string","maxLength":20,"description":"Inscrição Estadual.\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cEnderecoOd":{"type":"string","maxLength":60,"description":"Endereço.\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cNumeroOd":{"type":"string","maxLength":10,"description":"Número do endereço.\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cComplementoOd":{"type":"string","maxLength":60,"description":"Complemento do endereço.\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cBairroOd":{"type":"string","maxLength":60,"description":"Bairro.\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cEstadoOd":{"type":"string","maxLength":2,"description":"Estado.\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cCidadeOd":{"type":"string","maxLength":40,"description":"Cidade.\n\nUtilize o padrão: CIDADE (UF), como no exemplo:\n\n\"SAO PAULO (SP)\"\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa.\n\nUtilize a tag \"cCod\" do método \"PesquisarCidades\" da API\nhttp://app.omie.com.br/api/v1/geral/cidades/\npara obter essa informação."},"cCEPOd":{"type":"string","maxLength":10,"description":"CEP.\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cSepararEnderecoOd":{"type":"string","maxLength":1,"description":"Separar endereço.\nValores possível S ou N, sendo N o padrão.\nQuando igual S separa do endereço o número o e complemento, caso existirem."},"cTelefoneOd":{"type":"string","maxLength":15,"description":"Telefone.\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cCnpjCpfOdRet":{"type":"string","maxLength":20,"description":"CPF/CNPJ (Local de Retirada).\n\nPreencimento opcional quando a mercadoria não está com o Emitente e deve ser retirada em outro local.\n\nEste campo representa o CPF/CNPJ do responsável pela retirada da mercadoria.\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cNomeOdRet":{"type":"string","maxLength":60,"description":"Nome / Razão Social (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cInscrEstadualOdRet":{"type":"string","maxLength":20,"description":"Inscrição Estadual (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cEnderecoOdRet":{"type":"string","maxLength":60,"description":"Endereço (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cNumeroOdRet":{"type":"string","maxLength":10,"description":"Número do endereço (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cComplementoOdRet":{"type":"string","maxLength":60,"description":"Complemento do endereço (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cBairroOdRet":{"type":"string","maxLength":60,"description":"Bairro (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cEstadoOdRet":{"type":"string","maxLength":2,"description":"Estado (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cCidadeOdRet":{"type":"string","maxLength":40,"description":"Cidade (Local de Retirada).\n\nUtilize o padrão: CIDADE (UF), como no exemplo:\n\n\"SAO PAULO (SP)\"\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa.\n\nUtilize a tag \"cCod\" do método \"PesquisarCidades\" da API\nhttp://app.omie.com.br/api/v1/geral/cidades/\npara obter essa informação."},"cCEPOdRet":{"type":"string","maxLength":10,"description":"CEP (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cSepararEnderecoOdRet":{"type":"string","maxLength":1,"description":"Separar endereço.\nValores possível S ou N, sendo N o padrão.\nQuando igual S separa do endereço o número o e complemento, caso existirem."},"cTelefoneOdRet":{"type":"string","maxLength":15,"description":"Telefone (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"}},"description":"Outros detalhes da NF-e."},"nfRelacionada":{"type":"object","properties":{"cChaveRef":{"type":"string","maxLength":44,"description":"Chave da NF-e (ou NFC-e ou SAT) Relacionada."},"nNFRef":{"type":"string","maxLength":9,"description":"Número da Nota Fiscal\n\nNota Fiscal Relacionada Modelo 1/1A"},"cSerieRef":{"type":"string","maxLength":3,"description":"Série da NF Referenciada.\n\nNota Fiscal Relacionada Modelo 1/1A"},"dtEmissaoRef":{"type":"string","maxLength":10,"description":"Data de emissão da NF Referenciada.\n\nNota Fiscal Relacionada Modelo 1/1A"},"cnpjEmitRef":{"type":"string","maxLength":20,"description":"CNPJ da Emitente da NF Referenciada.\n\nNota Fiscal Relacionada Modelo 1/1A"},"cUfRef":{"type":"string","maxLength":2,"description":"Estado do Emitente da NF Referenciada.\n\nNota Fiscal Relacionada Modelo 1/1A"},"nNfPR":{"type":"string","maxLength":9,"description":"Número da Nota Fiscal relacionada do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural"},"cSeriePR":{"type":"string","maxLength":3,"description":"Série da NF do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural"},"dtEmissaoPR":{"type":"string","maxLength":10,"description":"Data de emissão da NF do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural"},"cnpjPR":{"type":"string","maxLength":20,"description":"CNPJ/CPF do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural"},"InscrEstPR":{"type":"string","maxLength":20,"description":"Inscrição Estadual do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural"},"cUfPR":{"type":"string","maxLength":2,"description":"Estado do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural"},"nCOORef":{"type":"string","maxLength":6,"description":"Número do COO - Contador de Ordem de Operação.\n\nCupom Fiscal Relacionado"},"nECFRef":{"type":"string","maxLength":3,"description":"Número de Ordem Sequencial do ECF."},"indPresenca":{"type":"string","maxLength":1,"description":"Indicador de Presença da Operação.\n\n1 - Operação presencial.\n2 - Operação não presencial, pela Internet.\n3 - Operação não presencial, Teleatendimento.\n4 - NFC-e em operação com entrega a domicílio.\n5 - Operação presencial, fora do estabelecimento.\n9 - Operação não presencial, outros.\n\n\nSe não informado, utilizaremos automaticamente o \"9 - Outros\".\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"indIntermediario":{"type":"string","maxLength":1,"description":"Indicador de Intermediador.\n\n\nEsta informação deverá ser enviada quando se tratar de uma operação não presencial.\n\nOpções disponíveis:\n0=Operação sem intermediador(em site ou plataforma própria)\n1=Operação em site ou plataforma de terceiros(intermediadores/marketplace)\n\nSe não informado, utilizaremos automaticamente a opção \"0-Operação sem intermediador(em site ou plataforma própria)\".\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cnpjIntermediario":{"type":"string","maxLength":20,"description":"CNPJ do Intermediador.\n\nPreencimento obrigatório caso o Indicador de Intermediador seja igual a opção \"1-Operação em site ou plataforma de terceiros(intermediadores/marketplace)\".\n\nEste campo representa o CNPJ do Intermediador da Transação.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"identIntermediario":{"type":"string","maxLength":60,"description":"Identificação no Intermediador.\n\n\nEste identificador pode ser o nome do usuário ou identificação do perfil do vendedor no site do intermediador.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"nrProdutorRural":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","maxLength":1,"description":"Ação a ser realizada no item na alteração.\n\nPode ser:\n\n\"I\" - Incluir o item.\n\"E\" - Excluir o item."},"nrNumero":{"type":"string","maxLength":9,"description":"Número da NF relacionada"},"nrSerie":{"type":"string","maxLength":3,"description":"Série da NF relacionada"},"nrDtEmissao":{"type":"string","maxLength":10,"description":"Data de emissão da NF relacionada"},"nrCnpjCpf":{"type":"string","maxLength":20,"description":"CNPJ/CPF do emitente da NF relacionada"},"nrIE":{"type":"string","maxLength":20,"description":"Inscrição Estadual do emitente da NF relacionada"},"nrUF":{"type":"string","maxLength":2,"description":"Unidade federativa do emitente da NF relacionada"}}},"description":"Outras notas de produtor rural relacionadas"},"nrNF":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","maxLength":1,"description":"Ação a ser realizada no item na alteração.\n\nPode ser:\n\n\"I\" - Incluir o item.\n\"E\" - Excluir o item."},"nrChave":{"type":"string","maxLength":44,"description":"Chave da NF-e, NFC-e ou SAT relacionada"}}},"description":"Outras NF-e, NFC-e ou SAT relacionadas"},"nrCupomFiscal":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","maxLength":1,"description":"Ação a ser realizada no item na alteração.\n\nPode ser:\n\n\"I\" - Incluir o item.\n\"E\" - Excluir o item."},"nrCOO":{"type":"string","maxLength":6,"description":"Contador de Ordem de Operação (COO)"},"nrNumeroECF":{"type":"string","maxLength":3,"description":"Número do ECF"}}},"description":"Outros cupons fiscais relacionados"},"nrModelo1_1A":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","maxLength":1,"description":"Ação a ser realizada no item na alteração.\n\nPode ser:\n\n\"I\" - Incluir o item.\n\"E\" - Excluir o item."},"nrNumero":{"type":"string","maxLength":9,"description":"Número da NF relacionada"},"nrSerie":{"type":"string","maxLength":3,"description":"Série da NF relacionada"},"nrDtEmissao":{"type":"string","maxLength":10,"description":"Data de emissão da NF relacionada"},"nrCnpjCpf":{"type":"string","maxLength":20,"description":"CNPJ/CPF do emitente da NF relacionada"},"nrUF":{"type":"string","maxLength":2,"description":"Unidade federativa do emitente da NF relacionada"}}},"description":"Outras notas modelo 1/1A relacionadas"},"cSigNFRef":{"type":"string","maxLength":1,"description":"Manter o sigilo da NF-e referenciada.\n\nPreencher com \"S\" ou \"N\".\n\nDefault \"N\""}},"description":"Detalhes da NF referenciada."}}},"email":{"type":"object","properties":{"cEmail":{"type":"string","description":"E-Mail do cliente"}}},"obs":{"type":"object","properties":{"cObs":{"type":"string","description":"Observações da Remessa"}}},"produtos":{"type":"array","items":{"type":"object","properties":{"nCodIt":{"type":"integer","maxLength":15,"description":"Código do item da remessa"},"cCodItInt":{"type":"string","maxLength":30,"description":"Código de Integração do Item"},"nCodProd":{"type":"integer","maxLength":15,"description":"Código do Produto"},"cCodProdInt":{"type":"string","maxLength":60,"description":"Código de Integração do Produto"},"cCFOP":{"type":"string","maxLength":10,"description":"Código da CFOP"},"nQtde":{"type":"number","maxLength":18,"description":"Quantidade"},"nValUnit":{"type":"number","maxLength":18,"description":"Valor do Item"},"cNCM":{"type":"string","maxLength":13,"description":"Código NCM"},"cEAN":{"type":"string","maxLength":14,"description":"Código EAN (GTIN)"},"nDesconto":{"type":"number","maxLength":18,"description":"Valor do Desconto"},"ICMS":{"type":"object","properties":{"cSitTrib":{"type":"string","maxLength":2,"description":"Situação Tributária do ICMS"},"cOrigem":{"type":"string","maxLength":1,"description":"Origem"},"cModBC":{"type":"string","maxLength":1,"description":"Modalidade da BC do ICMS"},"nRedBC":{"type":"number","maxLength":10,"description":"Redução da BC do ICMS (%)"},"nBC":{"type":"number","maxLength":18,"description":"Base de Calculo do ICMS"},"nAliq":{"type":"number","maxLength":10,"description":"Alíquota de ICMS"},"nValor":{"type":"number","maxLength":18,"description":"Valor do ICMS"}}},"ICMS_ST":{"type":"object","properties":{"cModBCST":{"type":"string","maxLength":1,"description":"Modalidade da Base de Cálculo do ICMS Substituição Tributária"},"nMargVrAd":{"type":"number","maxLength":10,"description":"Margem de Valor Adicionado (%)"},"nRedBCST":{"type":"number","maxLength":10,"description":"Redução da BC do ICMS ST (%)"},"nBCST":{"type":"number","maxLength":18,"description":"Base de Cálculo do ICMS ST"},"nAliqST":{"type":"number","maxLength":10,"description":"Alíquota do ICMS ST (%)"},"nAliqOP":{"type":"number","maxLength":10,"description":"Alíq. do ICMS Oper. Própria (%)"},"nValorST":{"type":"number","maxLength":18,"description":"Valor do ICMS ST"}}},"ICMS_SN":{"type":"object","properties":{"cSitTribSN":{"type":"string","maxLength":3,"description":"Situação Tributária do ICMS"},"cOrigem":{"type":"string","maxLength":1,"description":"Origem"},"nAliqSN":{"type":"number","maxLength":10,"description":"Alíq. de Cálculo de Crédito (%)"},"nCredSN":{"type":"number","maxLength":18,"description":"Crédito do ICMS Aproveitado"},"nBCSN":{"type":"number","maxLength":18,"description":"Base de Calculo do ICMS"},"nValorSN":{"type":"number","maxLength":18,"description":"Valor do ICMS"}}},"IPI":{"type":"object","properties":{"cSitTribIPI":{"type":"string","maxLength":2,"description":"Situação Tributária do IPI"},"cTpCalcIPI":{"type":"string","maxLength":1,"description":"Tipo de Cálculo para obter o IPI"},"nBCIPI":{"type":"number","maxLength":18,"description":"Base de Cálculo do IPI"},"cEnqIPI":{"type":"string","description":"Enquadramento do IPI"},"nAliqIPI":{"type":"number","maxLength":10,"description":"Alíquota do IPI (%)"},"nQtdUTIPI":{"type":"number","maxLength":18,"description":"Qtd Unidades Tributáveis"},"nValIPIUT":{"type":"number","maxLength":18,"description":"Valor do IPI por Unid. Tributável"},"nValIPI":{"type":"number","maxLength":18,"description":"Valor do IPI"}}},"PIS":{"type":"object","properties":{"cSitTribPIS":{"type":"string","maxLength":2,"description":"Situação Tributária doPIS"},"cTpCalcPIS":{"type":"string","maxLength":1,"description":"Tipo de Cálculo para obter o PIS"},"nBCPIS":{"type":"number","maxLength":18,"description":"Base de Cálculo do PIS"},"nAliqPIS":{"type":"number","maxLength":10,"description":"Alíquota do PIS (%)"},"nQtdUTPIS":{"type":"number","maxLength":18,"description":"Qtd Unidades Tributáveis"},"nValPISUT":{"type":"number","maxLength":18,"description":"Valor do PIS por Unid. Tributável"},"nValPIS":{"type":"number","maxLength":18,"description":"Valor do PIS"}}},"COFINS":{"type":"object","properties":{"cSitTribCOFINS":{"type":"string","maxLength":2,"description":"Situação Tributária do COFINS"},"cTpCalcCOFINS":{"type":"string","maxLength":1,"description":"Tipo de Cálculo para obter o COFINS"},"nBCCOFINS":{"type":"number","maxLength":18,"description":"Base de Cálculo do COFINS"},"nAliqCOFINS":{"type":"number","maxLength":10,"description":"Alíquota do COFINS (%)"},"nQtdUTCOFINS":{"type":"number","maxLength":18,"description":"Qtd Unidades Tributáveis"},"nVaCOFINSSUT":{"type":"number","maxLength":18,"description":"Valor do COFINS Unid. Tributável"},"nValCOFINS":{"type":"number","maxLength":18,"description":"Valor do COFINS"}}},"infAdicItem":{"type":"object","properties":{"nPesoLiq":{"type":"number","maxLength":18,"description":"Peso Líquido (Kg)"},"nPesoBruto":{"type":"number","maxLength":18,"description":"Peso Bruto (Kg)"},"nAliqIBPT":{"type":"number","maxLength":18,"description":"Alíquota IBPT"},"cPedCompra":{"type":"string","maxLength":15,"description":"Número do Pedido de Compra"},"nItemPedCompra":{"type":"integer","maxLength":6,"description":"Item do Pedido de Compra"},"cInfItemNF":{"type":"string","description":"Informações para a Nota Fiscal"},"cNaoMovEstoque":{"type":"string","maxLength":1,"example":"S","description":"Não gerar a saída de estoque deste item ao emitir a NF-e (S/N)"},"codigo_cenario_impostos_item":{"type":"integer","maxLength":15,"description":"Código do cenário fiscal de impostos."},"codigo_local_estoque_entrada":{"type":"integer","maxLength":15,"description":"Código do Local do Estoque de Entrada."},"numero_recopi":{"type":"string","maxLength":20,"description":"Número do registro gerado pelo sistema RECOPI Nacional (Reconhecimento e Controle das Operações com Papel Imune)."},"codigo_benef":{"type":"string","maxLength":10,"description":"Código de Beneficiário Fiscal na UF aplicado ao item."}},"description":"Informações Adicionais da Remessa"},"cCest":{"type":"string","description":"CEST"},"rastreabilidade":{"type":"object","properties":{"numeroLote":{"type":"string","maxLength":20,"description":"Número do Lote"},"qtdeProdutoLote":{"type":"number","maxLength":12,"description":"Quantidade de Produto"},"dataFabricacaoLote":{"type":"string","maxLength":10,"description":"Data de Fabricação/Produção"},"dataValidadeLote":{"type":"string","maxLength":10,"description":"Data de Validade"},"codigoAgregacaoLote":{"type":"string","maxLength":20,"description":"Código de Agregação"}},"description":"Rastreabilidade do produto"},"lote_validade":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","maxLength":15,"description":"Id do Lote do produto.\n\nObrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.."},"nQtdLote":{"type":"number","maxLength":18,"description":"Informe aqui a quantidade do Lote para o produto.\n\nÉ obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações."}},"required":["nQtdLote"]},"description":"Informações referentes ao lote e validade do produto.\n\nA tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes \"manualmente\" por API."},"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do Local do Estoque.\n\n\nCaso não preenchido assumirá o Local de Estoque padrão."},"reservado":{"type":"string","maxLength":1,"description":"Indica se o item está com o estoque reservado [S/N]"},"IBS_CBS":{"type":"object","properties":{"cCstIbsCbs":{"type":"string","maxLength":3,"description":"Código de Situação Tributária do IBS e CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"cClassTrib":{"type":"string","maxLength":6,"description":"Código de Classificação Tributária do IBS e CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nBaseIbsCbs":{"type":"number","maxLength":15,"description":"Base de cálculo do IBS e CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."}}},"IBS":{"type":"object","properties":{"nAliqIbsUf":{"type":"number","maxLength":7,"description":"Alíquota do IBS de competência das UF.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído."},"nPercDiferimentoIbsUf":{"type":"number","maxLength":7,"description":"Percentual do Diferimento - IBS UF.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído."},"nPercReducaoIbsUf":{"type":"number","maxLength":7,"description":"Percentual da redução de alíquota - IBS UF.\n\nNão deve ser informado na Inclusão/Alteração. Campos disponíveis apenas para consulta.\n\nPara os métodos de inclusão e alteração, esses campos serão alimentados conforme cenário fiscal."},"nValDiferimentoIbsUf":{"type":"number","maxLength":15,"description":"Valor do Diferimento - IBS UF.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nValIbsUf":{"type":"number","maxLength":15,"description":"Valor do IBS de competência da UF.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal.."},"nAliqIbsMun":{"type":"number","maxLength":7,"description":"Alíquota do IBS de competência do Município.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nPercDiferimentoIbsMun":{"type":"number","maxLength":7,"description":"Percentual do diferimento - UBS Município.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nPercReducaoIbsMun":{"type":"number","maxLength":7,"description":"Percentual da redução de alíquota - IBS Município.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nValDiferimentoIbsMun":{"type":"number","maxLength":15,"description":"Valor do Diferimento - IBS Município.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nValIbsMun":{"type":"number","maxLength":15,"description":"Valor do IBS de competência do Município.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nValIbs":{"type":"number","maxLength":15,"description":"Valor total do IBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."}}},"CBS":{"type":"object","properties":{"nAliqCbs":{"type":"number","maxLength":7,"description":"Alíquota da CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nPercDiferimentoCbs":{"type":"number","maxLength":7,"description":"Percentual do diferimento - CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nPercReducaoCbs":{"type":"number","maxLength":7,"description":"Percentual da redução de alíquota - CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal ."},"nValDiferimentoCbs":{"type":"number","maxLength":15,"description":"Valor do diferimento - CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nValCbs":{"type":"number","maxLength":15,"description":"Valor da CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."}}},"TRIB_REG":{"type":"object","properties":{"cCstIbsCbsReg":{"type":"string","maxLength":3,"description":"Código da Situação Tributária do IBS e CBS (Tributação Regular).\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"cClassTribReg":{"type":"string","maxLength":6,"description":"Código de Classificação Tributária do IBS e CBS (Tributação Regular).\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nAliqIbsUfReg":{"type":"number","maxLength":7,"description":"Valor da alíquota do IBS da UF na tributação regular.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nAliqIbsMunReg":{"type":"number","maxLength":7,"description":"Valor da alíquota do IBS do Município na tributação regular.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nAliqCbsReg":{"type":"number","maxLength":7,"description":"Valor da alíquota da CBS na tributação regular.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nValIbsUfReg":{"type":"number","maxLength":15,"description":"Valor do Tributo do IBS da UF na tributação regular.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nValIbsMunReg":{"type":"number","maxLength":15,"description":"Valor do Tributo do IBS do Município na tributação regular.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nValCbsReg":{"type":"number","maxLength":15,"description":"Valor do Tributo da CBS na tributação regular.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."}}}}}},"agropecuario":{"type":"object","properties":{"cNumReceita":{"type":"string","maxLength":20,"description":"Número da receita ou receituário do agrotóxico/defensivo agrícola"},"cCpfResponsavel":{"type":"string","maxLength":14,"description":"CPF do responsá¡vel técnico legalmente habilitado"},"nTipoGuia":{"type":"integer","maxLength":1,"description":"Tipo da Guia\n\n1 - Corresponde ao GTA\n2 - Corresponde ao TTA\n3 - Corresponde ao DTA\n4 - Corresponde ao ATV\n5 - Corresponde ao PTV\n6 - Corresponde ao GTV\n7 - Corresponde ao Guia Florestal (DOF, SisFlora - PA e MT, SIAM - MG)"},"cUFGuia":{"type":"string","maxLength":2,"description":"UF de emissão da Guia"},"cSerieGuia":{"type":"string","maxLength":9,"description":"Número de série da guia"},"nNumGuia":{"type":"integer","maxLength":9,"description":"Número da guia"}}}}}}},"example":{"call":"AlterarRemessa","param":[{"cabec":{"cCodIntRem":"","dPrevisao":"","nCodCli":0,"nCodRem":0,"nCodVend":""},"email":{"cEmail":""},"frete":{"cEspVol":"","cMarVol":"","cNumVol":"","cPlaca":"","cTpFrete":"","cUF":"","nCodTransp":0,"nPesoBruto":0,"nPesoLiq":0,"nQtdVol":0,"nValFrete":0,"nValOutras":0,"nValSeguro":0},"agropecuario":{"cNumReceita":"","cCpfResponsavel":"","nTipoGuia":1,"cUFGuia":"","cSerieGuia":"","nNumGuia":1},"infAdic":{"cCodCateg":"","cConsFinal":"","cContato":"","cDadosAdic":"","cNumCtr":"","cPedido":"","nCodProj":0},"obs":{"cObs":""},"produtos":[{"cCodItInt":"","nCodIt":0,"nCodProd":0,"nQtde":0,"nValUnit":0}]}]}},"produtos_remessa_AlterarRemessa_retorno":{"type":"object","properties":{"nCodRem":{"type":"integer","description":"Código da Remessa"},"cCodIntRem":{"type":"string","description":"Código de Integração da Remessa"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDesStatus":{"type":"string","description":"Descrição do Status da Remessa"},"cNumeroRemessa":{"type":"string","description":"Número da Remessa exibido na tela."}},"title":"AlterarRemessa (retorno)"},"produtos_remessa_ConsultarRemessa":{"type":"object","title":"ConsultarRemessa","description":"Consulta uma remessa.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarRemessa"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodRem":{"type":"integer","maxLength":15,"description":"Código da Remessa"},"cCodIntRem":{"type":"string","maxLength":60,"description":"Código de Integração da Remessa"}}}}},"example":{"call":"ConsultarRemessa","param":[{"nCodRem":0,"cCodIntRem":""}]}},"produtos_remessa_ConsultarRemessa_retorno":{"type":"object","properties":{"cabec":{"type":"object","properties":{"nCodRem":{"type":"integer","description":"Código da Remessa no Omie"},"cCodIntRem":{"type":"string","description":"Código de Integração da Remessa"},"nCodCli":{"type":"integer","description":"Código do Cliente"},"cCodIntCli":{"type":"string","description":"Código de Integração do Cliente"},"dPrevisao":{"type":"string","description":"Data da Previsão"},"nCodVend":{"type":"integer","description":"Código do Vendedor"},"cNumeroRemessa":{"type":"string","description":"Número da Remessa exibido na tela."},"codigo_cenario_impostos":{"type":"integer","description":"Código do cenário de impostos. Se não informado, será assumido o cenário padrão."},"cCancelado":{"type":"string","description":"Indica se a remessa está cancelada (S/N). Utilizado apenas nos métodos de Consulta/Listagem."}}},"frete":{"type":"object","properties":{"nCodTransp":{"type":"integer","description":"Código da Transportadora"},"cTpFrete":{"type":"string","description":"Tipo de Frete Pode ser: 0 - Contratação do Frete por conta do Remetente (CIF) 1 - Contratação do Frete por conta do Destinatário (FOB) 2 - Contratação do Frete por conta de Terceiros 3 - Transporte Próprio por conta do Remetente 4 - Transporte Próprio por conta do Destinatário 9 - Sem Ocorrência de Transporte"},"cPlaca":{"type":"string","description":"Placa do Veículo"},"cUF":{"type":"string","description":"UF da Placa"},"nQtdVol":{"type":"integer","description":"Quantidade de Volumes"},"cEspVol":{"type":"string","description":"Espécie de Volume. Campo livre, podendo ser o tipo de carga, como: caixa, fardo, palete, entre outros."},"cMarVol":{"type":"string","description":"Marca dos Volumes"},"cNumVol":{"type":"string","description":"Numeração dos Volumes"},"nPesoLiq":{"type":"decimal","description":"Peso Liquído (Kg)"},"nPesoBruto":{"type":"decimal","description":"Peso Bruto (Kg)"},"nValFrete":{"type":"decimal","description":"Valor do Frete"},"nValSeguro":{"type":"decimal","description":"Valor do Seguro"},"nValOutras":{"type":"decimal","description":"Valor de Outras Despesas Acessórias"}}},"infAdic":{"type":"object","properties":{"cCodCateg":{"type":"string","description":"Código da Categoria"},"cContato":{"type":"string","description":"Contato"},"nCodProj":{"type":"integer","description":"Código do Projeto"},"cPedido":{"type":"string","description":"Número do Pedido do cliente"},"cNumCtr":{"type":"string","description":"Número do Contrato de Venda"},"cDadosAdic":{"type":"string","description":"Dados Adicionais para a Nota Fiscal"},"cConsFinal":{"type":"string","description":"Nota Fiscal para Consumidor Final (S/N)"},"outros_detalhes":{"type":"object","properties":{"cNatOperacaoOd":{"type":"string","description":"Natureza da Operação. Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cIndicadorOd":{"type":"string","description":"Indicador de Presença da Operação. 1 - Operação presencial. 2 - Operação não presencial, pela Internet. 3 - Operação não presencial, Teleatendimento. 4 - NFC-e em operação com entrega a domicílio. 9 -Operação não presencial, outros. Se não informado, utilizaremos automaticamente o \"9 - Outros\". Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cIndicadorIntOd":{"type":"string","description":"Indicador de Intermediador. Esta informação deverá ser enviada quando se tratar de uma operação não presencial. Opções disponíveis: 0=Operação sem intermediador(em site ou plataforma própria) 1=Operação em site ou plataforma de terceiros(intermediadores/marketplace) Se não informado, utilizaremos automaticamente a opção \"0-Operação sem intermediador(em site ou plataforma própria)\". Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cCnpjIntOd":{"type":"string","description":"CNPJ do Intermediador. Preencimento obrigatório caso o Indicador de Intermediador seja igual a opção \"1-Operação em site ou plataforma de terceiros(intermediadores/marketplace)\". Este campo representa o CNPJ do Intermediador da Transação. Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cIdentificadorIntOd":{"type":"string","description":"Identificação no Intermediador. Este identificador pode ser o nome do usuário ou identificação do perfil do vendedor no site do intermediador. Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"dDataSaidaOd":{"type":"string","description":"Data de Saída. Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cHoraSaidaOd":{"type":"string","description":"Hora de Saída. Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cCnpjCpfOd":{"type":"string","description":"CNPJ / CPF (do recebedor). Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cNomeOd":{"type":"string","description":"Nome / Razão Social. Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cInscrEstadualOd":{"type":"string","description":"Inscrição Estadual. Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cEnderecoOd":{"type":"string","description":"Endereço. Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cNumeroOd":{"type":"string","description":"Número do endereço. Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cComplementoOd":{"type":"string","description":"Complemento do endereço. Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cBairroOd":{"type":"string","description":"Bairro. Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cEstadoOd":{"type":"string","description":"Estado. Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cCidadeOd":{"type":"string","description":"Cidade. Utilize o padrão: CIDADE (UF), como no exemplo: \"SAO PAULO (SP)\" Informação localizada na Aba \"Informações Adicionais\" da Remessa. Utilize a tag \"cCod\" do método \"PesquisarCidades\" da API http://app.omie.com.br/api/v1/geral/cidades/ para obter essa informação."},"cCEPOd":{"type":"string","description":"CEP. Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cSepararEnderecoOd":{"type":"string","description":"Separar endereço. Valores possível S ou N, sendo N o padrão. Quando igual S separa do endereço o número o e complemento, caso existirem."},"cTelefoneOd":{"type":"string","description":"Telefone. Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cCnpjCpfOdRet":{"type":"string","description":"CPF/CNPJ (Local de Retirada). Preencimento opcional quando a mercadoria não está com o Emitente e deve ser retirada em outro local. Este campo representa o CPF/CNPJ do responsável pela retirada da mercadoria. Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cNomeOdRet":{"type":"string","description":"Nome / Razão Social (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cInscrEstadualOdRet":{"type":"string","description":"Inscrição Estadual (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cEnderecoOdRet":{"type":"string","description":"Endereço (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cNumeroOdRet":{"type":"string","description":"Número do endereço (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cComplementoOdRet":{"type":"string","description":"Complemento do endereço (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cBairroOdRet":{"type":"string","description":"Bairro (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cEstadoOdRet":{"type":"string","description":"Estado (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cCidadeOdRet":{"type":"string","description":"Cidade (Local de Retirada). Utilize o padrão: CIDADE (UF), como no exemplo: \"SAO PAULO (SP)\" Informação localizada na Aba \"Informações Adicionais\" da Remessa. Utilize a tag \"cCod\" do método \"PesquisarCidades\" da API http://app.omie.com.br/api/v1/geral/cidades/ para obter essa informação."},"cCEPOdRet":{"type":"string","description":"CEP (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cSepararEnderecoOdRet":{"type":"string","description":"Separar endereço. Valores possível S ou N, sendo N o padrão. Quando igual S separa do endereço o número o e complemento, caso existirem."},"cTelefoneOdRet":{"type":"string","description":"Telefone (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" da Remessa"}},"description":"Outros detalhes da NF-e."},"nfRelacionada":{"type":"object","properties":{"cChaveRef":{"type":"string","description":"Chave da NF-e (ou NFC-e ou SAT) Relacionada."},"nNFRef":{"type":"string","description":"Número da Nota Fiscal Nota Fiscal Relacionada Modelo 1/1A"},"cSerieRef":{"type":"string","description":"Série da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A"},"dtEmissaoRef":{"type":"string","description":"Data de emissão da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A"},"cnpjEmitRef":{"type":"string","description":"CNPJ da Emitente da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A"},"cUfRef":{"type":"string","description":"Estado do Emitente da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A"},"nNfPR":{"type":"string","description":"Número da Nota Fiscal relacionada do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural"},"cSeriePR":{"type":"string","description":"Série da NF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural"},"dtEmissaoPR":{"type":"string","description":"Data de emissão da NF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural"},"cnpjPR":{"type":"string","description":"CNPJ/CPF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural"},"InscrEstPR":{"type":"string","description":"Inscrição Estadual do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural"},"cUfPR":{"type":"string","description":"Estado do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural"},"nCOORef":{"type":"string","description":"Número do COO - Contador de Ordem de Operação. Cupom Fiscal Relacionado"},"nECFRef":{"type":"string","description":"Número de Ordem Sequencial do ECF."},"indPresenca":{"type":"string","description":"Indicador de Presença da Operação. 1 - Operação presencial. 2 - Operação não presencial, pela Internet. 3 - Operação não presencial, Teleatendimento. 4 - NFC-e em operação com entrega a domicílio. 5 - Operação presencial, fora do estabelecimento. 9 - Operação não presencial, outros. Se não informado, utilizaremos automaticamente o \"9 - Outros\". Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"indIntermediario":{"type":"string","description":"Indicador de Intermediador. Esta informação deverá ser enviada quando se tratar de uma operação não presencial. Opções disponíveis: 0=Operação sem intermediador(em site ou plataforma própria) 1=Operação em site ou plataforma de terceiros(intermediadores/marketplace) Se não informado, utilizaremos automaticamente a opção \"0-Operação sem intermediador(em site ou plataforma própria)\". Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cnpjIntermediario":{"type":"string","description":"CNPJ do Intermediador. Preencimento obrigatório caso o Indicador de Intermediador seja igual a opção \"1-Operação em site ou plataforma de terceiros(intermediadores/marketplace)\". Este campo representa o CNPJ do Intermediador da Transação. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"identIntermediario":{"type":"string","description":"Identificação no Intermediador. Este identificador pode ser o nome do usuário ou identificação do perfil do vendedor no site do intermediador. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"nrProdutorRural":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","description":"Ação a ser realizada no item na alteração. Pode ser: \"I\" - Incluir o item. \"E\" - Excluir o item."},"nrNumero":{"type":"string","description":"Número da NF relacionada"},"nrSerie":{"type":"string","description":"Série da NF relacionada"},"nrDtEmissao":{"type":"string","description":"Data de emissão da NF relacionada"},"nrCnpjCpf":{"type":"string","description":"CNPJ/CPF do emitente da NF relacionada"},"nrIE":{"type":"string","description":"Inscrição Estadual do emitente da NF relacionada"},"nrUF":{"type":"string","description":"Unidade federativa do emitente da NF relacionada"}}},"description":"Outras notas de produtor rural relacionadas"},"nrNF":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","description":"Ação a ser realizada no item na alteração. Pode ser: \"I\" - Incluir o item. \"E\" - Excluir o item."},"nrChave":{"type":"string","description":"Chave da NF-e, NFC-e ou SAT relacionada"}}},"description":"Outras NF-e, NFC-e ou SAT relacionadas"},"nrCupomFiscal":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","description":"Ação a ser realizada no item na alteração. Pode ser: \"I\" - Incluir o item. \"E\" - Excluir o item."},"nrCOO":{"type":"string","description":"Contador de Ordem de Operação (COO)"},"nrNumeroECF":{"type":"string","description":"Número do ECF"}}},"description":"Outros cupons fiscais relacionados"},"nrModelo1_1A":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","description":"Ação a ser realizada no item na alteração. Pode ser: \"I\" - Incluir o item. \"E\" - Excluir o item."},"nrNumero":{"type":"string","description":"Número da NF relacionada"},"nrSerie":{"type":"string","description":"Série da NF relacionada"},"nrDtEmissao":{"type":"string","description":"Data de emissão da NF relacionada"},"nrCnpjCpf":{"type":"string","description":"CNPJ/CPF do emitente da NF relacionada"},"nrUF":{"type":"string","description":"Unidade federativa do emitente da NF relacionada"}}},"description":"Outras notas modelo 1/1A relacionadas"},"cSigNFRef":{"type":"string","description":"Manter o sigilo da NF-e referenciada. Preencher com \"S\" ou \"N\". Default \"N\""}},"description":"Detalhes da NF referenciada."}}},"email":{"type":"object","properties":{"cEmail":{"type":"string","description":"E-Mail do cliente"}}},"obs":{"type":"object","properties":{"cObs":{"type":"string","description":"Observações da Remessa"}}},"produtos":{"type":"array","items":{"type":"object","properties":{"nCodIt":{"type":"integer","description":"Código do item da remessa"},"cCodItInt":{"type":"string","description":"Código de Integração do Item"},"nCodProd":{"type":"integer","description":"Código do Produto"},"cCodProdInt":{"type":"string","description":"Código de Integração do Produto"},"cCFOP":{"type":"string","description":"Código da CFOP"},"nQtde":{"type":"decimal","description":"Quantidade"},"nValUnit":{"type":"decimal","description":"Valor do Item"},"cNCM":{"type":"string","description":"Código NCM"},"cEAN":{"type":"string","description":"Código EAN (GTIN)"},"nDesconto":{"type":"decimal","description":"Valor do Desconto"},"ICMS":{"type":"object","properties":{"cSitTrib":{"type":"string","description":"Situação Tributária do ICMS"},"cOrigem":{"type":"string","description":"Origem"},"cModBC":{"type":"string","description":"Modalidade da BC do ICMS"},"nRedBC":{"type":"decimal","description":"Redução da BC do ICMS (%)"},"nBC":{"type":"decimal","description":"Base de Calculo do ICMS"},"nAliq":{"type":"decimal","description":"Alíquota de ICMS"},"nValor":{"type":"decimal","description":"Valor do ICMS"}}},"ICMS_ST":{"type":"object","properties":{"cModBCST":{"type":"string","description":"Modalidade da Base de Cálculo do ICMS Substituição Tributária"},"nMargVrAd":{"type":"decimal","description":"Margem de Valor Adicionado (%)"},"nRedBCST":{"type":"decimal","description":"Redução da BC do ICMS ST (%)"},"nBCST":{"type":"decimal","description":"Base de Cálculo do ICMS ST"},"nAliqST":{"type":"decimal","description":"Alíquota do ICMS ST (%)"},"nAliqOP":{"type":"decimal","description":"Alíq. do ICMS Oper. Própria (%)"},"nValorST":{"type":"decimal","description":"Valor do ICMS ST"}}},"ICMS_SN":{"type":"object","properties":{"cSitTribSN":{"type":"string","description":"Situação Tributária do ICMS"},"cOrigem":{"type":"string","description":"Origem"},"nAliqSN":{"type":"decimal","description":"Alíq. de Cálculo de Crédito (%)"},"nCredSN":{"type":"decimal","description":"Crédito do ICMS Aproveitado"},"nBCSN":{"type":"decimal","description":"Base de Calculo do ICMS"},"nValorSN":{"type":"decimal","description":"Valor do ICMS"}}},"IPI":{"type":"object","properties":{"cSitTribIPI":{"type":"string","description":"Situação Tributária do IPI"},"cTpCalcIPI":{"type":"string","description":"Tipo de Cálculo para obter o IPI"},"nBCIPI":{"type":"decimal","description":"Base de Cálculo do IPI"},"cEnqIPI":{"type":"string","description":"Enquadramento do IPI"},"nAliqIPI":{"type":"decimal","description":"Alíquota do IPI (%)"},"nQtdUTIPI":{"type":"decimal","description":"Qtd Unidades Tributáveis"},"nValIPIUT":{"type":"decimal","description":"Valor do IPI por Unid. Tributável"},"nValIPI":{"type":"decimal","description":"Valor do IPI"}}},"PIS":{"type":"object","properties":{"cSitTribPIS":{"type":"string","description":"Situação Tributária doPIS"},"cTpCalcPIS":{"type":"string","description":"Tipo de Cálculo para obter o PIS"},"nBCPIS":{"type":"decimal","description":"Base de Cálculo do PIS"},"nAliqPIS":{"type":"decimal","description":"Alíquota do PIS (%)"},"nQtdUTPIS":{"type":"decimal","description":"Qtd Unidades Tributáveis"},"nValPISUT":{"type":"decimal","description":"Valor do PIS por Unid. Tributável"},"nValPIS":{"type":"decimal","description":"Valor do PIS"}}},"COFINS":{"type":"object","properties":{"cSitTribCOFINS":{"type":"string","description":"Situação Tributária do COFINS"},"cTpCalcCOFINS":{"type":"string","description":"Tipo de Cálculo para obter o COFINS"},"nBCCOFINS":{"type":"decimal","description":"Base de Cálculo do COFINS"},"nAliqCOFINS":{"type":"decimal","description":"Alíquota do COFINS (%)"},"nQtdUTCOFINS":{"type":"decimal","description":"Qtd Unidades Tributáveis"},"nVaCOFINSSUT":{"type":"decimal","description":"Valor do COFINS Unid. Tributável"},"nValCOFINS":{"type":"decimal","description":"Valor do COFINS"}}},"infAdicItem":{"type":"object","properties":{"nPesoLiq":{"type":"decimal","description":"Peso Líquido (Kg)"},"nPesoBruto":{"type":"decimal","description":"Peso Bruto (Kg)"},"nAliqIBPT":{"type":"decimal","description":"Alíquota IBPT"},"cPedCompra":{"type":"string","description":"Número do Pedido de Compra"},"nItemPedCompra":{"type":"integer","description":"Item do Pedido de Compra"},"cInfItemNF":{"type":"string","description":"Informações para a Nota Fiscal"},"cNaoMovEstoque":{"type":"string","description":"Não gerar a saída de estoque deste item ao emitir a NF-e (S/N)"},"codigo_cenario_impostos_item":{"type":"integer","description":"Código do cenário fiscal de impostos."},"codigo_local_estoque_entrada":{"type":"integer","description":"Código do Local do Estoque de Entrada."},"numero_recopi":{"type":"string","description":"Número do registro gerado pelo sistema RECOPI Nacional (Reconhecimento e Controle das Operações com Papel Imune)."},"codigo_benef":{"type":"string","description":"Código de Beneficiário Fiscal na UF aplicado ao item."}},"description":"Informações Adicionais da Remessa"},"cCest":{"type":"string","description":"CEST"},"rastreabilidade":{"type":"object","properties":{"numeroLote":{"type":"string","description":"Número do Lote"},"qtdeProdutoLote":{"type":"decimal","description":"Quantidade de Produto"},"dataFabricacaoLote":{"type":"string","description":"Data de Fabricação/Produção"},"dataValidadeLote":{"type":"string","description":"Data de Validade"},"codigoAgregacaoLote":{"type":"string","description":"Código de Agregação"}},"description":"Rastreabilidade do produto"},"lote_validade":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","description":"Id do Lote do produto. Obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.."},"nQtdLote":{"type":"decimal","description":"Informe aqui a quantidade do Lote para o produto. É obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações."}}},"description":"Informações referentes ao lote e validade do produto. A tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes \"manualmente\" por API."},"codigo_local_estoque":{"type":"integer","description":"Código do Local do Estoque. Caso não preenchido assumirá o Local de Estoque padrão."},"reservado":{"type":"string","description":"Indica se o item está com o estoque reservado [S/N]"},"IBS_CBS":{"type":"object","properties":{"cCstIbsCbs":{"type":"string","description":"Código de Situação Tributária do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"cClassTrib":{"type":"string","description":"Código de Classificação Tributária do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nBaseIbsCbs":{"type":"decimal","description":"Base de cálculo do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."}}},"IBS":{"type":"object","properties":{"nAliqIbsUf":{"type":"decimal","description":"Alíquota do IBS de competência das UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído."},"nPercDiferimentoIbsUf":{"type":"decimal","description":"Percentual do Diferimento - IBS UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído."},"nPercReducaoIbsUf":{"type":"decimal","description":"Percentual da redução de alíquota - IBS UF. Não deve ser informado na Inclusão/Alteração. Campos disponíveis apenas para consulta. Para os métodos de inclusão e alteração, esses campos serão alimentados conforme cenário fiscal."},"nValDiferimentoIbsUf":{"type":"decimal","description":"Valor do Diferimento - IBS UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nValIbsUf":{"type":"decimal","description":"Valor do IBS de competência da UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal.."},"nAliqIbsMun":{"type":"decimal","description":"Alíquota do IBS de competência do Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nPercDiferimentoIbsMun":{"type":"decimal","description":"Percentual do diferimento - UBS Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nPercReducaoIbsMun":{"type":"decimal","description":"Percentual da redução de alíquota - IBS Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nValDiferimentoIbsMun":{"type":"decimal","description":"Valor do Diferimento - IBS Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nValIbsMun":{"type":"decimal","description":"Valor do IBS de competência do Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nValIbs":{"type":"decimal","description":"Valor total do IBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."}}},"CBS":{"type":"object","properties":{"nAliqCbs":{"type":"decimal","description":"Alíquota da CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nPercDiferimentoCbs":{"type":"decimal","description":"Percentual do diferimento - CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nPercReducaoCbs":{"type":"decimal","description":"Percentual da redução de alíquota - CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal ."},"nValDiferimentoCbs":{"type":"decimal","description":"Valor do diferimento - CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nValCbs":{"type":"decimal","description":"Valor da CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."}}},"TRIB_REG":{"type":"object","properties":{"cCstIbsCbsReg":{"type":"string","description":"Código da Situação Tributária do IBS e CBS (Tributação Regular). Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"cClassTribReg":{"type":"string","description":"Código de Classificação Tributária do IBS e CBS (Tributação Regular). Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nAliqIbsUfReg":{"type":"decimal","description":"Valor da alíquota do IBS da UF na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nAliqIbsMunReg":{"type":"decimal","description":"Valor da alíquota do IBS do Município na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nAliqCbsReg":{"type":"decimal","description":"Valor da alíquota da CBS na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nValIbsUfReg":{"type":"decimal","description":"Valor do Tributo do IBS da UF na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nValIbsMunReg":{"type":"decimal","description":"Valor do Tributo do IBS do Município na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nValCbsReg":{"type":"decimal","description":"Valor do Tributo da CBS na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."}}}}}},"agropecuario":{"type":"object","properties":{"cNumReceita":{"type":"string","description":"Número da receita ou receituário do agrotóxico/defensivo agrícola"},"cCpfResponsavel":{"type":"string","description":"CPF do responsá¡vel técnico legalmente habilitado"},"nTipoGuia":{"type":"integer","description":"Tipo da Guia 1 - Corresponde ao GTA 2 - Corresponde ao TTA 3 - Corresponde ao DTA 4 - Corresponde ao ATV 5 - Corresponde ao PTV 6 - Corresponde ao GTV 7 - Corresponde ao Guia Florestal (DOF, SisFlora - PA e MT, SIAM - MG)"},"cUFGuia":{"type":"string","description":"UF de emissão da Guia"},"cSerieGuia":{"type":"string","description":"Número de série da guia"},"nNumGuia":{"type":"integer","description":"Número da guia"}}}},"title":"ConsultarRemessa (retorno)"},"produtos_remessa_DevolverRemessa":{"type":"object","title":"DevolverRemessa","description":"Devolução de uma remessa.","required":["call","param"],"properties":{"call":{"type":"string","enum":["DevolverRemessa"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodRem":{"type":"integer","maxLength":15,"description":"Código da Remessa"},"itens":{"type":"array","items":{"type":"object","properties":{"nIdProd":{"type":"integer","maxLength":15,"description":"Id do produto."},"nQuant":{"type":"integer","maxLength":6,"description":"Quantidade do item a ser devolvida.\n\n\nCaso não seja preenchida será feita a devolução integral do produto."}},"required":["nIdProd"]},"description":"Informações dos itens que serão devolvidos.\n\nCaso essa tag não seja preenchida será realizado a devolução integral de todos os itens da remessa."}},"required":["nCodRem"]}}},"example":{"call":"DevolverRemessa","param":[{"nCodRem":0,"itens":[{"nIdProd":0,"nQuant":0}]}]}},"produtos_remessa_DevolverRemessa_retorno":{"type":"object","properties":{"nIdDevolucao":{"type":"integer","description":"ID da devolução."},"cCodStatus":{"type":"string","description":"Código do Status do processamento."},"cDesStatus":{"type":"string","description":"Descrição do status de processamento."}},"title":"DevolverRemessa (retorno)"},"produtos_remessa_IncluirRemessa":{"type":"object","title":"IncluirRemessa","description":"Inclui uma nova remessa.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirRemessa"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cabec":{"type":"object","properties":{"nCodRem":{"type":"integer","maxLength":15,"description":"Código da Remessa no Omie"},"cCodIntRem":{"type":"string","maxLength":60,"description":"Código de Integração da Remessa"},"nCodCli":{"type":"integer","maxLength":15,"description":"Código do Cliente"},"cCodIntCli":{"type":"string","maxLength":60,"description":"Código de Integração do Cliente"},"dPrevisao":{"type":"string","maxLength":10,"description":"Data da Previsão"},"nCodVend":{"type":"integer","maxLength":15,"description":"Código do Vendedor"},"cNumeroRemessa":{"type":"string","maxLength":15,"description":"Número da Remessa exibido na tela."},"codigo_cenario_impostos":{"type":"integer","maxLength":15,"description":"Código do cenário de impostos.\n\nSe não informado, será assumido o cenário padrão."},"cCancelado":{"type":"string","maxLength":1,"example":"S","description":"Indica se a remessa está cancelada (S/N).\n\nUtilizado apenas nos métodos de Consulta/Listagem."}}},"frete":{"type":"object","properties":{"nCodTransp":{"type":"integer","maxLength":15,"description":"Código da Transportadora"},"cTpFrete":{"type":"string","maxLength":1,"description":"Tipo de Frete\n\nPode ser:\n\n0 - Contratação do Frete por conta do Remetente (CIF)\n1 - Contratação do Frete por conta do Destinatário (FOB)\n2 - Contratação do Frete por conta de Terceiros\n3 - Transporte Próprio por conta do Remetente\n4 - Transporte Próprio por conta do Destinatário\n9 - Sem Ocorrência de Transporte"},"cPlaca":{"type":"string","maxLength":7,"description":"Placa do Veículo"},"cUF":{"type":"string","maxLength":2,"description":"UF da Placa"},"nQtdVol":{"type":"integer","maxLength":15,"description":"Quantidade de Volumes"},"cEspVol":{"type":"string","maxLength":60,"description":"Espécie de Volume.\n\nCampo livre, podendo ser o tipo de carga, como: caixa, fardo, palete, entre outros."},"cMarVol":{"type":"string","maxLength":60,"description":"Marca dos Volumes"},"cNumVol":{"type":"string","maxLength":60,"description":"Numeração dos Volumes"},"nPesoLiq":{"type":"number","maxLength":18,"description":"Peso Liquído (Kg)"},"nPesoBruto":{"type":"number","maxLength":18,"description":"Peso Bruto (Kg)"},"nValFrete":{"type":"number","maxLength":18,"description":"Valor do Frete"},"nValSeguro":{"type":"number","maxLength":18,"description":"Valor do Seguro"},"nValOutras":{"type":"number","maxLength":18,"description":"Valor de Outras Despesas Acessórias"}}},"infAdic":{"type":"object","properties":{"cCodCateg":{"type":"string","maxLength":20,"description":"Código da Categoria"},"cContato":{"type":"string","maxLength":100,"description":"Contato"},"nCodProj":{"type":"integer","maxLength":15,"description":"Código do Projeto"},"cPedido":{"type":"string","maxLength":30,"description":"Número do Pedido do cliente"},"cNumCtr":{"type":"string","maxLength":20,"description":"Número do Contrato de Venda"},"cDadosAdic":{"type":"string","description":"Dados Adicionais para a Nota Fiscal"},"cConsFinal":{"type":"string","maxLength":1,"description":"Nota Fiscal para Consumidor Final (S/N)"},"outros_detalhes":{"type":"object","properties":{"cNatOperacaoOd":{"type":"string","maxLength":60,"description":"Natureza da Operação.\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cIndicadorOd":{"type":"string","maxLength":1,"description":"Indicador de Presença da Operação.\n\n1 - Operação presencial.\n2 - Operação não presencial, pela Internet.\n3 - Operação não presencial, Teleatendimento.\n4 - NFC-e em operação com entrega a domicílio.\n9 -Operação não presencial, outros.\n\n\nSe não informado, utilizaremos automaticamente o \"9 - Outros\".\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cIndicadorIntOd":{"type":"string","maxLength":1,"description":"Indicador de Intermediador.\n\n\nEsta informação deverá ser enviada quando se tratar de uma operação não presencial.\n\nOpções disponíveis:\n0=Operação sem intermediador(em site ou plataforma própria)\n1=Operação em site ou plataforma de terceiros(intermediadores/marketplace)\n\nSe não informado, utilizaremos automaticamente a opção \"0-Operação sem intermediador(em site ou plataforma própria)\".\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cCnpjIntOd":{"type":"string","maxLength":20,"description":"CNPJ do Intermediador.\n\nPreencimento obrigatório caso o Indicador de Intermediador seja igual a opção \"1-Operação em site ou plataforma de terceiros(intermediadores/marketplace)\".\n\nEste campo representa o CNPJ do Intermediador da Transação.\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cIdentificadorIntOd":{"type":"string","maxLength":60,"description":"Identificação no Intermediador.\n\n\nEste identificador pode ser o nome do usuário ou identificação do perfil do vendedor no site do intermediador.\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"dDataSaidaOd":{"type":"string","maxLength":10,"description":"Data de Saída.\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cHoraSaidaOd":{"type":"string","maxLength":8,"description":"Hora de Saída.\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cCnpjCpfOd":{"type":"string","maxLength":20,"description":"CNPJ / CPF (do recebedor).\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cNomeOd":{"type":"string","maxLength":60,"description":"Nome / Razão Social.\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cInscrEstadualOd":{"type":"string","maxLength":20,"description":"Inscrição Estadual.\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cEnderecoOd":{"type":"string","maxLength":60,"description":"Endereço.\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cNumeroOd":{"type":"string","maxLength":10,"description":"Número do endereço.\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cComplementoOd":{"type":"string","maxLength":60,"description":"Complemento do endereço.\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cBairroOd":{"type":"string","maxLength":60,"description":"Bairro.\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cEstadoOd":{"type":"string","maxLength":2,"description":"Estado.\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cCidadeOd":{"type":"string","maxLength":40,"description":"Cidade.\n\nUtilize o padrão: CIDADE (UF), como no exemplo:\n\n\"SAO PAULO (SP)\"\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa.\n\nUtilize a tag \"cCod\" do método \"PesquisarCidades\" da API\nhttp://app.omie.com.br/api/v1/geral/cidades/\npara obter essa informação."},"cCEPOd":{"type":"string","maxLength":10,"description":"CEP.\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cSepararEnderecoOd":{"type":"string","maxLength":1,"description":"Separar endereço.\nValores possível S ou N, sendo N o padrão.\nQuando igual S separa do endereço o número o e complemento, caso existirem."},"cTelefoneOd":{"type":"string","maxLength":15,"description":"Telefone.\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cCnpjCpfOdRet":{"type":"string","maxLength":20,"description":"CPF/CNPJ (Local de Retirada).\n\nPreencimento opcional quando a mercadoria não está com o Emitente e deve ser retirada em outro local.\n\nEste campo representa o CPF/CNPJ do responsável pela retirada da mercadoria.\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cNomeOdRet":{"type":"string","maxLength":60,"description":"Nome / Razão Social (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cInscrEstadualOdRet":{"type":"string","maxLength":20,"description":"Inscrição Estadual (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cEnderecoOdRet":{"type":"string","maxLength":60,"description":"Endereço (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cNumeroOdRet":{"type":"string","maxLength":10,"description":"Número do endereço (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cComplementoOdRet":{"type":"string","maxLength":60,"description":"Complemento do endereço (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cBairroOdRet":{"type":"string","maxLength":60,"description":"Bairro (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cEstadoOdRet":{"type":"string","maxLength":2,"description":"Estado (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cCidadeOdRet":{"type":"string","maxLength":40,"description":"Cidade (Local de Retirada).\n\nUtilize o padrão: CIDADE (UF), como no exemplo:\n\n\"SAO PAULO (SP)\"\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa.\n\nUtilize a tag \"cCod\" do método \"PesquisarCidades\" da API\nhttp://app.omie.com.br/api/v1/geral/cidades/\npara obter essa informação."},"cCEPOdRet":{"type":"string","maxLength":10,"description":"CEP (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"},"cSepararEnderecoOdRet":{"type":"string","maxLength":1,"description":"Separar endereço.\nValores possível S ou N, sendo N o padrão.\nQuando igual S separa do endereço o número o e complemento, caso existirem."},"cTelefoneOdRet":{"type":"string","maxLength":15,"description":"Telefone (Local de Retirada).\n\nInformação localizada na Aba \"Informações Adicionais\" da Remessa"}},"description":"Outros detalhes da NF-e."},"nfRelacionada":{"type":"object","properties":{"cChaveRef":{"type":"string","maxLength":44,"description":"Chave da NF-e (ou NFC-e ou SAT) Relacionada."},"nNFRef":{"type":"string","maxLength":9,"description":"Número da Nota Fiscal\n\nNota Fiscal Relacionada Modelo 1/1A"},"cSerieRef":{"type":"string","maxLength":3,"description":"Série da NF Referenciada.\n\nNota Fiscal Relacionada Modelo 1/1A"},"dtEmissaoRef":{"type":"string","maxLength":10,"description":"Data de emissão da NF Referenciada.\n\nNota Fiscal Relacionada Modelo 1/1A"},"cnpjEmitRef":{"type":"string","maxLength":20,"description":"CNPJ da Emitente da NF Referenciada.\n\nNota Fiscal Relacionada Modelo 1/1A"},"cUfRef":{"type":"string","maxLength":2,"description":"Estado do Emitente da NF Referenciada.\n\nNota Fiscal Relacionada Modelo 1/1A"},"nNfPR":{"type":"string","maxLength":9,"description":"Número da Nota Fiscal relacionada do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural"},"cSeriePR":{"type":"string","maxLength":3,"description":"Série da NF do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural"},"dtEmissaoPR":{"type":"string","maxLength":10,"description":"Data de emissão da NF do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural"},"cnpjPR":{"type":"string","maxLength":20,"description":"CNPJ/CPF do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural"},"InscrEstPR":{"type":"string","maxLength":20,"description":"Inscrição Estadual do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural"},"cUfPR":{"type":"string","maxLength":2,"description":"Estado do Produtor Rural.\n\nNota Fiscal Relacionada do Produtor Rural"},"nCOORef":{"type":"string","maxLength":6,"description":"Número do COO - Contador de Ordem de Operação.\n\nCupom Fiscal Relacionado"},"nECFRef":{"type":"string","maxLength":3,"description":"Número de Ordem Sequencial do ECF."},"indPresenca":{"type":"string","maxLength":1,"description":"Indicador de Presença da Operação.\n\n1 - Operação presencial.\n2 - Operação não presencial, pela Internet.\n3 - Operação não presencial, Teleatendimento.\n4 - NFC-e em operação com entrega a domicílio.\n5 - Operação presencial, fora do estabelecimento.\n9 - Operação não presencial, outros.\n\n\nSe não informado, utilizaremos automaticamente o \"9 - Outros\".\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"indIntermediario":{"type":"string","maxLength":1,"description":"Indicador de Intermediador.\n\n\nEsta informação deverá ser enviada quando se tratar de uma operação não presencial.\n\nOpções disponíveis:\n0=Operação sem intermediador(em site ou plataforma própria)\n1=Operação em site ou plataforma de terceiros(intermediadores/marketplace)\n\nSe não informado, utilizaremos automaticamente a opção \"0-Operação sem intermediador(em site ou plataforma própria)\".\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cnpjIntermediario":{"type":"string","maxLength":20,"description":"CNPJ do Intermediador.\n\nPreencimento obrigatório caso o Indicador de Intermediador seja igual a opção \"1-Operação em site ou plataforma de terceiros(intermediadores/marketplace)\".\n\nEste campo representa o CNPJ do Intermediador da Transação.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"identIntermediario":{"type":"string","maxLength":60,"description":"Identificação no Intermediador.\n\n\nEste identificador pode ser o nome do usuário ou identificação do perfil do vendedor no site do intermediador.\n\nInformação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"nrProdutorRural":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","maxLength":1,"description":"Ação a ser realizada no item na alteração.\n\nPode ser:\n\n\"I\" - Incluir o item.\n\"E\" - Excluir o item."},"nrNumero":{"type":"string","maxLength":9,"description":"Número da NF relacionada"},"nrSerie":{"type":"string","maxLength":3,"description":"Série da NF relacionada"},"nrDtEmissao":{"type":"string","maxLength":10,"description":"Data de emissão da NF relacionada"},"nrCnpjCpf":{"type":"string","maxLength":20,"description":"CNPJ/CPF do emitente da NF relacionada"},"nrIE":{"type":"string","maxLength":20,"description":"Inscrição Estadual do emitente da NF relacionada"},"nrUF":{"type":"string","maxLength":2,"description":"Unidade federativa do emitente da NF relacionada"}}},"description":"Outras notas de produtor rural relacionadas"},"nrNF":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","maxLength":1,"description":"Ação a ser realizada no item na alteração.\n\nPode ser:\n\n\"I\" - Incluir o item.\n\"E\" - Excluir o item."},"nrChave":{"type":"string","maxLength":44,"description":"Chave da NF-e, NFC-e ou SAT relacionada"}}},"description":"Outras NF-e, NFC-e ou SAT relacionadas"},"nrCupomFiscal":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","maxLength":1,"description":"Ação a ser realizada no item na alteração.\n\nPode ser:\n\n\"I\" - Incluir o item.\n\"E\" - Excluir o item."},"nrCOO":{"type":"string","maxLength":6,"description":"Contador de Ordem de Operação (COO)"},"nrNumeroECF":{"type":"string","maxLength":3,"description":"Número do ECF"}}},"description":"Outros cupons fiscais relacionados"},"nrModelo1_1A":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","maxLength":1,"description":"Ação a ser realizada no item na alteração.\n\nPode ser:\n\n\"I\" - Incluir o item.\n\"E\" - Excluir o item."},"nrNumero":{"type":"string","maxLength":9,"description":"Número da NF relacionada"},"nrSerie":{"type":"string","maxLength":3,"description":"Série da NF relacionada"},"nrDtEmissao":{"type":"string","maxLength":10,"description":"Data de emissão da NF relacionada"},"nrCnpjCpf":{"type":"string","maxLength":20,"description":"CNPJ/CPF do emitente da NF relacionada"},"nrUF":{"type":"string","maxLength":2,"description":"Unidade federativa do emitente da NF relacionada"}}},"description":"Outras notas modelo 1/1A relacionadas"},"cSigNFRef":{"type":"string","maxLength":1,"description":"Manter o sigilo da NF-e referenciada.\n\nPreencher com \"S\" ou \"N\".\n\nDefault \"N\""}},"description":"Detalhes da NF referenciada."}}},"email":{"type":"object","properties":{"cEmail":{"type":"string","description":"E-Mail do cliente"}}},"obs":{"type":"object","properties":{"cObs":{"type":"string","description":"Observações da Remessa"}}},"produtos":{"type":"array","items":{"type":"object","properties":{"nCodIt":{"type":"integer","maxLength":15,"description":"Código do item da remessa"},"cCodItInt":{"type":"string","maxLength":30,"description":"Código de Integração do Item"},"nCodProd":{"type":"integer","maxLength":15,"description":"Código do Produto"},"cCodProdInt":{"type":"string","maxLength":60,"description":"Código de Integração do Produto"},"cCFOP":{"type":"string","maxLength":10,"description":"Código da CFOP"},"nQtde":{"type":"number","maxLength":18,"description":"Quantidade"},"nValUnit":{"type":"number","maxLength":18,"description":"Valor do Item"},"cNCM":{"type":"string","maxLength":13,"description":"Código NCM"},"cEAN":{"type":"string","maxLength":14,"description":"Código EAN (GTIN)"},"nDesconto":{"type":"number","maxLength":18,"description":"Valor do Desconto"},"ICMS":{"type":"object","properties":{"cSitTrib":{"type":"string","maxLength":2,"description":"Situação Tributária do ICMS"},"cOrigem":{"type":"string","maxLength":1,"description":"Origem"},"cModBC":{"type":"string","maxLength":1,"description":"Modalidade da BC do ICMS"},"nRedBC":{"type":"number","maxLength":10,"description":"Redução da BC do ICMS (%)"},"nBC":{"type":"number","maxLength":18,"description":"Base de Calculo do ICMS"},"nAliq":{"type":"number","maxLength":10,"description":"Alíquota de ICMS"},"nValor":{"type":"number","maxLength":18,"description":"Valor do ICMS"}}},"ICMS_ST":{"type":"object","properties":{"cModBCST":{"type":"string","maxLength":1,"description":"Modalidade da Base de Cálculo do ICMS Substituição Tributária"},"nMargVrAd":{"type":"number","maxLength":10,"description":"Margem de Valor Adicionado (%)"},"nRedBCST":{"type":"number","maxLength":10,"description":"Redução da BC do ICMS ST (%)"},"nBCST":{"type":"number","maxLength":18,"description":"Base de Cálculo do ICMS ST"},"nAliqST":{"type":"number","maxLength":10,"description":"Alíquota do ICMS ST (%)"},"nAliqOP":{"type":"number","maxLength":10,"description":"Alíq. do ICMS Oper. Própria (%)"},"nValorST":{"type":"number","maxLength":18,"description":"Valor do ICMS ST"}}},"ICMS_SN":{"type":"object","properties":{"cSitTribSN":{"type":"string","maxLength":3,"description":"Situação Tributária do ICMS"},"cOrigem":{"type":"string","maxLength":1,"description":"Origem"},"nAliqSN":{"type":"number","maxLength":10,"description":"Alíq. de Cálculo de Crédito (%)"},"nCredSN":{"type":"number","maxLength":18,"description":"Crédito do ICMS Aproveitado"},"nBCSN":{"type":"number","maxLength":18,"description":"Base de Calculo do ICMS"},"nValorSN":{"type":"number","maxLength":18,"description":"Valor do ICMS"}}},"IPI":{"type":"object","properties":{"cSitTribIPI":{"type":"string","maxLength":2,"description":"Situação Tributária do IPI"},"cTpCalcIPI":{"type":"string","maxLength":1,"description":"Tipo de Cálculo para obter o IPI"},"nBCIPI":{"type":"number","maxLength":18,"description":"Base de Cálculo do IPI"},"cEnqIPI":{"type":"string","description":"Enquadramento do IPI"},"nAliqIPI":{"type":"number","maxLength":10,"description":"Alíquota do IPI (%)"},"nQtdUTIPI":{"type":"number","maxLength":18,"description":"Qtd Unidades Tributáveis"},"nValIPIUT":{"type":"number","maxLength":18,"description":"Valor do IPI por Unid. Tributável"},"nValIPI":{"type":"number","maxLength":18,"description":"Valor do IPI"}}},"PIS":{"type":"object","properties":{"cSitTribPIS":{"type":"string","maxLength":2,"description":"Situação Tributária doPIS"},"cTpCalcPIS":{"type":"string","maxLength":1,"description":"Tipo de Cálculo para obter o PIS"},"nBCPIS":{"type":"number","maxLength":18,"description":"Base de Cálculo do PIS"},"nAliqPIS":{"type":"number","maxLength":10,"description":"Alíquota do PIS (%)"},"nQtdUTPIS":{"type":"number","maxLength":18,"description":"Qtd Unidades Tributáveis"},"nValPISUT":{"type":"number","maxLength":18,"description":"Valor do PIS por Unid. Tributável"},"nValPIS":{"type":"number","maxLength":18,"description":"Valor do PIS"}}},"COFINS":{"type":"object","properties":{"cSitTribCOFINS":{"type":"string","maxLength":2,"description":"Situação Tributária do COFINS"},"cTpCalcCOFINS":{"type":"string","maxLength":1,"description":"Tipo de Cálculo para obter o COFINS"},"nBCCOFINS":{"type":"number","maxLength":18,"description":"Base de Cálculo do COFINS"},"nAliqCOFINS":{"type":"number","maxLength":10,"description":"Alíquota do COFINS (%)"},"nQtdUTCOFINS":{"type":"number","maxLength":18,"description":"Qtd Unidades Tributáveis"},"nVaCOFINSSUT":{"type":"number","maxLength":18,"description":"Valor do COFINS Unid. Tributável"},"nValCOFINS":{"type":"number","maxLength":18,"description":"Valor do COFINS"}}},"infAdicItem":{"type":"object","properties":{"nPesoLiq":{"type":"number","maxLength":18,"description":"Peso Líquido (Kg)"},"nPesoBruto":{"type":"number","maxLength":18,"description":"Peso Bruto (Kg)"},"nAliqIBPT":{"type":"number","maxLength":18,"description":"Alíquota IBPT"},"cPedCompra":{"type":"string","maxLength":15,"description":"Número do Pedido de Compra"},"nItemPedCompra":{"type":"integer","maxLength":6,"description":"Item do Pedido de Compra"},"cInfItemNF":{"type":"string","description":"Informações para a Nota Fiscal"},"cNaoMovEstoque":{"type":"string","maxLength":1,"example":"S","description":"Não gerar a saída de estoque deste item ao emitir a NF-e (S/N)"},"codigo_cenario_impostos_item":{"type":"integer","maxLength":15,"description":"Código do cenário fiscal de impostos."},"codigo_local_estoque_entrada":{"type":"integer","maxLength":15,"description":"Código do Local do Estoque de Entrada."},"numero_recopi":{"type":"string","maxLength":20,"description":"Número do registro gerado pelo sistema RECOPI Nacional (Reconhecimento e Controle das Operações com Papel Imune)."},"codigo_benef":{"type":"string","maxLength":10,"description":"Código de Beneficiário Fiscal na UF aplicado ao item."}},"description":"Informações Adicionais da Remessa"},"cCest":{"type":"string","description":"CEST"},"rastreabilidade":{"type":"object","properties":{"numeroLote":{"type":"string","maxLength":20,"description":"Número do Lote"},"qtdeProdutoLote":{"type":"number","maxLength":12,"description":"Quantidade de Produto"},"dataFabricacaoLote":{"type":"string","maxLength":10,"description":"Data de Fabricação/Produção"},"dataValidadeLote":{"type":"string","maxLength":10,"description":"Data de Validade"},"codigoAgregacaoLote":{"type":"string","maxLength":20,"description":"Código de Agregação"}},"description":"Rastreabilidade do produto"},"lote_validade":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","maxLength":15,"description":"Id do Lote do produto.\n\nObrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.."},"nQtdLote":{"type":"number","maxLength":18,"description":"Informe aqui a quantidade do Lote para o produto.\n\nÉ obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações."}},"required":["nQtdLote"]},"description":"Informações referentes ao lote e validade do produto.\n\nA tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes \"manualmente\" por API."},"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do Local do Estoque.\n\n\nCaso não preenchido assumirá o Local de Estoque padrão."},"reservado":{"type":"string","maxLength":1,"description":"Indica se o item está com o estoque reservado [S/N]"},"IBS_CBS":{"type":"object","properties":{"cCstIbsCbs":{"type":"string","maxLength":3,"description":"Código de Situação Tributária do IBS e CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"cClassTrib":{"type":"string","maxLength":6,"description":"Código de Classificação Tributária do IBS e CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nBaseIbsCbs":{"type":"number","maxLength":15,"description":"Base de cálculo do IBS e CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."}}},"IBS":{"type":"object","properties":{"nAliqIbsUf":{"type":"number","maxLength":7,"description":"Alíquota do IBS de competência das UF.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído."},"nPercDiferimentoIbsUf":{"type":"number","maxLength":7,"description":"Percentual do Diferimento - IBS UF.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído."},"nPercReducaoIbsUf":{"type":"number","maxLength":7,"description":"Percentual da redução de alíquota - IBS UF.\n\nNão deve ser informado na Inclusão/Alteração. Campos disponíveis apenas para consulta.\n\nPara os métodos de inclusão e alteração, esses campos serão alimentados conforme cenário fiscal."},"nValDiferimentoIbsUf":{"type":"number","maxLength":15,"description":"Valor do Diferimento - IBS UF.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nValIbsUf":{"type":"number","maxLength":15,"description":"Valor do IBS de competência da UF.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal.."},"nAliqIbsMun":{"type":"number","maxLength":7,"description":"Alíquota do IBS de competência do Município.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nPercDiferimentoIbsMun":{"type":"number","maxLength":7,"description":"Percentual do diferimento - UBS Município.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nPercReducaoIbsMun":{"type":"number","maxLength":7,"description":"Percentual da redução de alíquota - IBS Município.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nValDiferimentoIbsMun":{"type":"number","maxLength":15,"description":"Valor do Diferimento - IBS Município.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nValIbsMun":{"type":"number","maxLength":15,"description":"Valor do IBS de competência do Município.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nValIbs":{"type":"number","maxLength":15,"description":"Valor total do IBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."}}},"CBS":{"type":"object","properties":{"nAliqCbs":{"type":"number","maxLength":7,"description":"Alíquota da CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nPercDiferimentoCbs":{"type":"number","maxLength":7,"description":"Percentual do diferimento - CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nPercReducaoCbs":{"type":"number","maxLength":7,"description":"Percentual da redução de alíquota - CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal ."},"nValDiferimentoCbs":{"type":"number","maxLength":15,"description":"Valor do diferimento - CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nValCbs":{"type":"number","maxLength":15,"description":"Valor da CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."}}},"TRIB_REG":{"type":"object","properties":{"cCstIbsCbsReg":{"type":"string","maxLength":3,"description":"Código da Situação Tributária do IBS e CBS (Tributação Regular).\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"cClassTribReg":{"type":"string","maxLength":6,"description":"Código de Classificação Tributária do IBS e CBS (Tributação Regular).\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nAliqIbsUfReg":{"type":"number","maxLength":7,"description":"Valor da alíquota do IBS da UF na tributação regular.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nAliqIbsMunReg":{"type":"number","maxLength":7,"description":"Valor da alíquota do IBS do Município na tributação regular.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nAliqCbsReg":{"type":"number","maxLength":7,"description":"Valor da alíquota da CBS na tributação regular.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nValIbsUfReg":{"type":"number","maxLength":15,"description":"Valor do Tributo do IBS da UF na tributação regular.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nValIbsMunReg":{"type":"number","maxLength":15,"description":"Valor do Tributo do IBS do Município na tributação regular.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nValCbsReg":{"type":"number","maxLength":15,"description":"Valor do Tributo da CBS na tributação regular.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."}}}}}},"agropecuario":{"type":"object","properties":{"cNumReceita":{"type":"string","maxLength":20,"description":"Número da receita ou receituário do agrotóxico/defensivo agrícola"},"cCpfResponsavel":{"type":"string","maxLength":14,"description":"CPF do responsá¡vel técnico legalmente habilitado"},"nTipoGuia":{"type":"integer","maxLength":1,"description":"Tipo da Guia\n\n1 - Corresponde ao GTA\n2 - Corresponde ao TTA\n3 - Corresponde ao DTA\n4 - Corresponde ao ATV\n5 - Corresponde ao PTV\n6 - Corresponde ao GTV\n7 - Corresponde ao Guia Florestal (DOF, SisFlora - PA e MT, SIAM - MG)"},"cUFGuia":{"type":"string","maxLength":2,"description":"UF de emissão da Guia"},"cSerieGuia":{"type":"string","maxLength":9,"description":"Número de série da guia"},"nNumGuia":{"type":"integer","maxLength":9,"description":"Número da guia"}}}}}}},"example":{"call":"IncluirRemessa","param":[{"cabec":{"cCodIntRem":"","dPrevisao":"","nCodCli":0,"nCodRem":0,"nCodVend":""},"email":{"cEmail":""},"frete":{"cEspVol":"","cMarVol":"","cNumVol":"","cPlaca":"","cTpFrete":"","cUF":"","nCodTransp":0,"nPesoBruto":0,"nPesoLiq":0,"nQtdVol":0,"nValFrete":0,"nValOutras":0,"nValSeguro":0},"agropecuario":{"cNumReceita":"","cCpfResponsavel":"","nTipoGuia":1,"cUFGuia":"","cSerieGuia":"","nNumGuia":1},"infAdic":{"cCodCateg":"","cConsFinal":"","cContato":"","cDadosAdic":"","cNumCtr":"","cPedido":"","nCodProj":0},"obs":{"cObs":""},"produtos":[{"cCodItInt":"","nCodIt":0,"nCodProd":0,"nQtde":0,"nValUnit":0}]}]}},"produtos_remessa_IncluirRemessa_retorno":{"type":"object","properties":{"nCodRem":{"type":"integer","description":"Código da Remessa"},"cCodIntRem":{"type":"string","description":"Código de Integração da Remessa"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDesStatus":{"type":"string","description":"Descrição do Status da Remessa"},"cNumeroRemessa":{"type":"string","description":"Número da Remessa exibido na tela."}},"title":"IncluirRemessa (retorno)"},"produtos_remessa_ListarRemessas":{"type":"object","title":"ListarRemessas","description":"Lista as remessas cadastradas.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarRemessas"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15},"nRegistrosPorPagina":{"type":"integer","maxLength":15},"cOrdenarPor":{"type":"string","maxLength":100},"dtAltDe":{"type":"string","maxLength":10},"dtAltAte":{"type":"string","maxLength":10},"hrAltDe":{"type":"string","maxLength":8,"description":"Filtra os registros a partir da hora específicada."},"hrAltAte":{"type":"string","maxLength":8,"description":"Filtra os registros até a hora específicada."},"nIdCliente":{"type":"integer","maxLength":15,"description":"Filtra os registros do cliente específicado."},"cExibirDetalhes":{"type":"string","maxLength":1,"description":"Exibir os detalhes da remessa.\n\nPreencher com \"S\" ou \"N\"."},"faturada":{"type":"string","maxLength":1,"description":"Nota Fiscal foi faturada.\n\nPreencher com \"S\" ou \"N\"."}}}}},"example":{"call":"ListarRemessas","param":[{"nPagina":1}]}},"produtos_remessa_ListarRemessas_retorno":{"type":"object","properties":{"nPagina":{"type":"integer"},"nTotalPaginas":{"type":"integer"},"nRegistros":{"type":"integer"},"nTotalRegistros":{"type":"integer"},"remessas":{"type":"array","items":{"type":"object","properties":{"cabec":{"type":"object","properties":{"nCodRem":{"type":"integer","description":"Código da Remessa no Omie"},"cCodIntRem":{"type":"string","description":"Código de Integração da Remessa"},"nCodCli":{"type":"integer","description":"Código do Cliente"},"cCodIntCli":{"type":"string","description":"Código de Integração do Cliente"},"dPrevisao":{"type":"string","description":"Data da Previsão"},"nCodVend":{"type":"integer","description":"Código do Vendedor"},"cNumeroRemessa":{"type":"string","description":"Número da Remessa exibido na tela."},"codigo_cenario_impostos":{"type":"integer","description":"Código do cenário de impostos. Se não informado, será assumido o cenário padrão."},"cCancelado":{"type":"string","description":"Indica se a remessa está cancelada (S/N). Utilizado apenas nos métodos de Consulta/Listagem."}}},"frete":{"type":"object","properties":{"nCodTransp":{"type":"integer","description":"Código da Transportadora"},"cTpFrete":{"type":"string","description":"Tipo de Frete Pode ser: 0 - Contratação do Frete por conta do Remetente (CIF) 1 - Contratação do Frete por conta do Destinatário (FOB) 2 - Contratação do Frete por conta de Terceiros 3 - Transporte Próprio por conta do Remetente 4 - Transporte Próprio por conta do Destinatário 9 - Sem Ocorrência de Transporte"},"cPlaca":{"type":"string","description":"Placa do Veículo"},"cUF":{"type":"string","description":"UF da Placa"},"nQtdVol":{"type":"integer","description":"Quantidade de Volumes"},"cEspVol":{"type":"string","description":"Espécie de Volume. Campo livre, podendo ser o tipo de carga, como: caixa, fardo, palete, entre outros."},"cMarVol":{"type":"string","description":"Marca dos Volumes"},"cNumVol":{"type":"string","description":"Numeração dos Volumes"},"nPesoLiq":{"type":"decimal","description":"Peso Liquído (Kg)"},"nPesoBruto":{"type":"decimal","description":"Peso Bruto (Kg)"},"nValFrete":{"type":"decimal","description":"Valor do Frete"},"nValSeguro":{"type":"decimal","description":"Valor do Seguro"},"nValOutras":{"type":"decimal","description":"Valor de Outras Despesas Acessórias"}}},"infAdic":{"type":"object","properties":{"cCodCateg":{"type":"string","description":"Código da Categoria"},"cContato":{"type":"string","description":"Contato"},"nCodProj":{"type":"integer","description":"Código do Projeto"},"cPedido":{"type":"string","description":"Número do Pedido do cliente"},"cNumCtr":{"type":"string","description":"Número do Contrato de Venda"},"cDadosAdic":{"type":"string","description":"Dados Adicionais para a Nota Fiscal"},"cConsFinal":{"type":"string","description":"Nota Fiscal para Consumidor Final (S/N)"},"outros_detalhes":{"type":"object","properties":{"cNatOperacaoOd":{"type":"string","description":"Natureza da Operação. Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cIndicadorOd":{"type":"string","description":"Indicador de Presença da Operação. 1 - Operação presencial. 2 - Operação não presencial, pela Internet. 3 - Operação não presencial, Teleatendimento. 4 - NFC-e em operação com entrega a domicílio. 9 -Operação não presencial, outros. Se não informado, utilizaremos automaticamente o \"9 - Outros\". Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cIndicadorIntOd":{"type":"string","description":"Indicador de Intermediador. Esta informação deverá ser enviada quando se tratar de uma operação não presencial. Opções disponíveis: 0=Operação sem intermediador(em site ou plataforma própria) 1=Operação em site ou plataforma de terceiros(intermediadores/marketplace) Se não informado, utilizaremos automaticamente a opção \"0-Operação sem intermediador(em site ou plataforma própria)\". Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cCnpjIntOd":{"type":"string","description":"CNPJ do Intermediador. Preencimento obrigatório caso o Indicador de Intermediador seja igual a opção \"1-Operação em site ou plataforma de terceiros(intermediadores/marketplace)\". Este campo representa o CNPJ do Intermediador da Transação. Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cIdentificadorIntOd":{"type":"string","description":"Identificação no Intermediador. Este identificador pode ser o nome do usuário ou identificação do perfil do vendedor no site do intermediador. Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"dDataSaidaOd":{"type":"string","description":"Data de Saída. Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cHoraSaidaOd":{"type":"string","description":"Hora de Saída. Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cCnpjCpfOd":{"type":"string","description":"CNPJ / CPF (do recebedor). Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cNomeOd":{"type":"string","description":"Nome / Razão Social. Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cInscrEstadualOd":{"type":"string","description":"Inscrição Estadual. Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cEnderecoOd":{"type":"string","description":"Endereço. Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cNumeroOd":{"type":"string","description":"Número do endereço. Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cComplementoOd":{"type":"string","description":"Complemento do endereço. Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cBairroOd":{"type":"string","description":"Bairro. Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cEstadoOd":{"type":"string","description":"Estado. Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cCidadeOd":{"type":"string","description":"Cidade. Utilize o padrão: CIDADE (UF), como no exemplo: \"SAO PAULO (SP)\" Informação localizada na Aba \"Informações Adicionais\" da Remessa. Utilize a tag \"cCod\" do método \"PesquisarCidades\" da API http://app.omie.com.br/api/v1/geral/cidades/ para obter essa informação."},"cCEPOd":{"type":"string","description":"CEP. Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cSepararEnderecoOd":{"type":"string","description":"Separar endereço. Valores possível S ou N, sendo N o padrão. Quando igual S separa do endereço o número o e complemento, caso existirem."},"cTelefoneOd":{"type":"string","description":"Telefone. Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cCnpjCpfOdRet":{"type":"string","description":"CPF/CNPJ (Local de Retirada). Preencimento opcional quando a mercadoria não está com o Emitente e deve ser retirada em outro local. Este campo representa o CPF/CNPJ do responsável pela retirada da mercadoria. Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cNomeOdRet":{"type":"string","description":"Nome / Razão Social (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cInscrEstadualOdRet":{"type":"string","description":"Inscrição Estadual (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cEnderecoOdRet":{"type":"string","description":"Endereço (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cNumeroOdRet":{"type":"string","description":"Número do endereço (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cComplementoOdRet":{"type":"string","description":"Complemento do endereço (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cBairroOdRet":{"type":"string","description":"Bairro (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cEstadoOdRet":{"type":"string","description":"Estado (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cCidadeOdRet":{"type":"string","description":"Cidade (Local de Retirada). Utilize o padrão: CIDADE (UF), como no exemplo: \"SAO PAULO (SP)\" Informação localizada na Aba \"Informações Adicionais\" da Remessa. Utilize a tag \"cCod\" do método \"PesquisarCidades\" da API http://app.omie.com.br/api/v1/geral/cidades/ para obter essa informação."},"cCEPOdRet":{"type":"string","description":"CEP (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" da Remessa"},"cSepararEnderecoOdRet":{"type":"string","description":"Separar endereço. Valores possível S ou N, sendo N o padrão. Quando igual S separa do endereço o número o e complemento, caso existirem."},"cTelefoneOdRet":{"type":"string","description":"Telefone (Local de Retirada). Informação localizada na Aba \"Informações Adicionais\" da Remessa"}},"description":"Outros detalhes da NF-e."},"nfRelacionada":{"type":"object","properties":{"cChaveRef":{"type":"string","description":"Chave da NF-e (ou NFC-e ou SAT) Relacionada."},"nNFRef":{"type":"string","description":"Número da Nota Fiscal Nota Fiscal Relacionada Modelo 1/1A"},"cSerieRef":{"type":"string","description":"Série da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A"},"dtEmissaoRef":{"type":"string","description":"Data de emissão da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A"},"cnpjEmitRef":{"type":"string","description":"CNPJ da Emitente da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A"},"cUfRef":{"type":"string","description":"Estado do Emitente da NF Referenciada. Nota Fiscal Relacionada Modelo 1/1A"},"nNfPR":{"type":"string","description":"Número da Nota Fiscal relacionada do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural"},"cSeriePR":{"type":"string","description":"Série da NF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural"},"dtEmissaoPR":{"type":"string","description":"Data de emissão da NF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural"},"cnpjPR":{"type":"string","description":"CNPJ/CPF do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural"},"InscrEstPR":{"type":"string","description":"Inscrição Estadual do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural"},"cUfPR":{"type":"string","description":"Estado do Produtor Rural. Nota Fiscal Relacionada do Produtor Rural"},"nCOORef":{"type":"string","description":"Número do COO - Contador de Ordem de Operação. Cupom Fiscal Relacionado"},"nECFRef":{"type":"string","description":"Número de Ordem Sequencial do ECF."},"indPresenca":{"type":"string","description":"Indicador de Presença da Operação. 1 - Operação presencial. 2 - Operação não presencial, pela Internet. 3 - Operação não presencial, Teleatendimento. 4 - NFC-e em operação com entrega a domicílio. 5 - Operação presencial, fora do estabelecimento. 9 - Operação não presencial, outros. Se não informado, utilizaremos automaticamente o \"9 - Outros\". Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"indIntermediario":{"type":"string","description":"Indicador de Intermediador. Esta informação deverá ser enviada quando se tratar de uma operação não presencial. Opções disponíveis: 0=Operação sem intermediador(em site ou plataforma própria) 1=Operação em site ou plataforma de terceiros(intermediadores/marketplace) Se não informado, utilizaremos automaticamente a opção \"0-Operação sem intermediador(em site ou plataforma própria)\". Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"cnpjIntermediario":{"type":"string","description":"CNPJ do Intermediador. Preencimento obrigatório caso o Indicador de Intermediador seja igual a opção \"1-Operação em site ou plataforma de terceiros(intermediadores/marketplace)\". Este campo representa o CNPJ do Intermediador da Transação. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"identIntermediario":{"type":"string","description":"Identificação no Intermediador. Este identificador pode ser o nome do usuário ou identificação do perfil do vendedor no site do intermediador. Informação localizada na Aba \"Informações Adicionais\" do Pedido de Venda."},"nrProdutorRural":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","description":"Ação a ser realizada no item na alteração. Pode ser: \"I\" - Incluir o item. \"E\" - Excluir o item."},"nrNumero":{"type":"string","description":"Número da NF relacionada"},"nrSerie":{"type":"string","description":"Série da NF relacionada"},"nrDtEmissao":{"type":"string","description":"Data de emissão da NF relacionada"},"nrCnpjCpf":{"type":"string","description":"CNPJ/CPF do emitente da NF relacionada"},"nrIE":{"type":"string","description":"Inscrição Estadual do emitente da NF relacionada"},"nrUF":{"type":"string","description":"Unidade federativa do emitente da NF relacionada"}}},"description":"Outras notas de produtor rural relacionadas"},"nrNF":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","description":"Ação a ser realizada no item na alteração. Pode ser: \"I\" - Incluir o item. \"E\" - Excluir o item."},"nrChave":{"type":"string","description":"Chave da NF-e, NFC-e ou SAT relacionada"}}},"description":"Outras NF-e, NFC-e ou SAT relacionadas"},"nrCupomFiscal":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","description":"Ação a ser realizada no item na alteração. Pode ser: \"I\" - Incluir o item. \"E\" - Excluir o item."},"nrCOO":{"type":"string","description":"Contador de Ordem de Operação (COO)"},"nrNumeroECF":{"type":"string","description":"Número do ECF"}}},"description":"Outros cupons fiscais relacionados"},"nrModelo1_1A":{"type":"array","items":{"type":"object","properties":{"cAcaoItem":{"type":"string","description":"Ação a ser realizada no item na alteração. Pode ser: \"I\" - Incluir o item. \"E\" - Excluir o item."},"nrNumero":{"type":"string","description":"Número da NF relacionada"},"nrSerie":{"type":"string","description":"Série da NF relacionada"},"nrDtEmissao":{"type":"string","description":"Data de emissão da NF relacionada"},"nrCnpjCpf":{"type":"string","description":"CNPJ/CPF do emitente da NF relacionada"},"nrUF":{"type":"string","description":"Unidade federativa do emitente da NF relacionada"}}},"description":"Outras notas modelo 1/1A relacionadas"},"cSigNFRef":{"type":"string","description":"Manter o sigilo da NF-e referenciada. Preencher com \"S\" ou \"N\". Default \"N\""}},"description":"Detalhes da NF referenciada."}}},"email":{"type":"object","properties":{"cEmail":{"type":"string","description":"E-Mail do cliente"}}},"obs":{"type":"object","properties":{"cObs":{"type":"string","description":"Observações da Remessa"}}},"produtos":{"type":"array","items":{"type":"object","properties":{"nCodIt":{"type":"integer","description":"Código do item da remessa"},"cCodItInt":{"type":"string","description":"Código de Integração do Item"},"nCodProd":{"type":"integer","description":"Código do Produto"},"cCodProdInt":{"type":"string","description":"Código de Integração do Produto"},"cCFOP":{"type":"string","description":"Código da CFOP"},"nQtde":{"type":"decimal","description":"Quantidade"},"nValUnit":{"type":"decimal","description":"Valor do Item"},"cNCM":{"type":"string","description":"Código NCM"},"cEAN":{"type":"string","description":"Código EAN (GTIN)"},"nDesconto":{"type":"decimal","description":"Valor do Desconto"},"ICMS":{"type":"object","properties":{"cSitTrib":{"type":"string","description":"Situação Tributária do ICMS"},"cOrigem":{"type":"string","description":"Origem"},"cModBC":{"type":"string","description":"Modalidade da BC do ICMS"},"nRedBC":{"type":"decimal","description":"Redução da BC do ICMS (%)"},"nBC":{"type":"decimal","description":"Base de Calculo do ICMS"},"nAliq":{"type":"decimal","description":"Alíquota de ICMS"},"nValor":{"type":"decimal","description":"Valor do ICMS"}}},"ICMS_ST":{"type":"object","properties":{"cModBCST":{"type":"string","description":"Modalidade da Base de Cálculo do ICMS Substituição Tributária"},"nMargVrAd":{"type":"decimal","description":"Margem de Valor Adicionado (%)"},"nRedBCST":{"type":"decimal","description":"Redução da BC do ICMS ST (%)"},"nBCST":{"type":"decimal","description":"Base de Cálculo do ICMS ST"},"nAliqST":{"type":"decimal","description":"Alíquota do ICMS ST (%)"},"nAliqOP":{"type":"decimal","description":"Alíq. do ICMS Oper. Própria (%)"},"nValorST":{"type":"decimal","description":"Valor do ICMS ST"}}},"ICMS_SN":{"type":"object","properties":{"cSitTribSN":{"type":"string","description":"Situação Tributária do ICMS"},"cOrigem":{"type":"string","description":"Origem"},"nAliqSN":{"type":"decimal","description":"Alíq. de Cálculo de Crédito (%)"},"nCredSN":{"type":"decimal","description":"Crédito do ICMS Aproveitado"},"nBCSN":{"type":"decimal","description":"Base de Calculo do ICMS"},"nValorSN":{"type":"decimal","description":"Valor do ICMS"}}},"IPI":{"type":"object","properties":{"cSitTribIPI":{"type":"string","description":"Situação Tributária do IPI"},"cTpCalcIPI":{"type":"string","description":"Tipo de Cálculo para obter o IPI"},"nBCIPI":{"type":"decimal","description":"Base de Cálculo do IPI"},"cEnqIPI":{"type":"string","description":"Enquadramento do IPI"},"nAliqIPI":{"type":"decimal","description":"Alíquota do IPI (%)"},"nQtdUTIPI":{"type":"decimal","description":"Qtd Unidades Tributáveis"},"nValIPIUT":{"type":"decimal","description":"Valor do IPI por Unid. Tributável"},"nValIPI":{"type":"decimal","description":"Valor do IPI"}}},"PIS":{"type":"object","properties":{"cSitTribPIS":{"type":"string","description":"Situação Tributária doPIS"},"cTpCalcPIS":{"type":"string","description":"Tipo de Cálculo para obter o PIS"},"nBCPIS":{"type":"decimal","description":"Base de Cálculo do PIS"},"nAliqPIS":{"type":"decimal","description":"Alíquota do PIS (%)"},"nQtdUTPIS":{"type":"decimal","description":"Qtd Unidades Tributáveis"},"nValPISUT":{"type":"decimal","description":"Valor do PIS por Unid. Tributável"},"nValPIS":{"type":"decimal","description":"Valor do PIS"}}},"COFINS":{"type":"object","properties":{"cSitTribCOFINS":{"type":"string","description":"Situação Tributária do COFINS"},"cTpCalcCOFINS":{"type":"string","description":"Tipo de Cálculo para obter o COFINS"},"nBCCOFINS":{"type":"decimal","description":"Base de Cálculo do COFINS"},"nAliqCOFINS":{"type":"decimal","description":"Alíquota do COFINS (%)"},"nQtdUTCOFINS":{"type":"decimal","description":"Qtd Unidades Tributáveis"},"nVaCOFINSSUT":{"type":"decimal","description":"Valor do COFINS Unid. Tributável"},"nValCOFINS":{"type":"decimal","description":"Valor do COFINS"}}},"infAdicItem":{"type":"object","properties":{"nPesoLiq":{"type":"decimal","description":"Peso Líquido (Kg)"},"nPesoBruto":{"type":"decimal","description":"Peso Bruto (Kg)"},"nAliqIBPT":{"type":"decimal","description":"Alíquota IBPT"},"cPedCompra":{"type":"string","description":"Número do Pedido de Compra"},"nItemPedCompra":{"type":"integer","description":"Item do Pedido de Compra"},"cInfItemNF":{"type":"string","description":"Informações para a Nota Fiscal"},"cNaoMovEstoque":{"type":"string","description":"Não gerar a saída de estoque deste item ao emitir a NF-e (S/N)"},"codigo_cenario_impostos_item":{"type":"integer","description":"Código do cenário fiscal de impostos."},"codigo_local_estoque_entrada":{"type":"integer","description":"Código do Local do Estoque de Entrada."},"numero_recopi":{"type":"string","description":"Número do registro gerado pelo sistema RECOPI Nacional (Reconhecimento e Controle das Operações com Papel Imune)."},"codigo_benef":{"type":"string","description":"Código de Beneficiário Fiscal na UF aplicado ao item."}},"description":"Informações Adicionais da Remessa"},"cCest":{"type":"string","description":"CEST"},"rastreabilidade":{"type":"object","properties":{"numeroLote":{"type":"string","description":"Número do Lote"},"qtdeProdutoLote":{"type":"decimal","description":"Quantidade de Produto"},"dataFabricacaoLote":{"type":"string","description":"Data de Fabricação/Produção"},"dataValidadeLote":{"type":"string","description":"Data de Validade"},"codigoAgregacaoLote":{"type":"string","description":"Código de Agregação"}},"description":"Rastreabilidade do produto"},"lote_validade":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","description":"Id do Lote do produto. Obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.."},"nQtdLote":{"type":"decimal","description":"Informe aqui a quantidade do Lote para o produto. É obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações."}}},"description":"Informações referentes ao lote e validade do produto. A tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes \"manualmente\" por API."},"codigo_local_estoque":{"type":"integer","description":"Código do Local do Estoque. Caso não preenchido assumirá o Local de Estoque padrão."},"reservado":{"type":"string","description":"Indica se o item está com o estoque reservado [S/N]"},"IBS_CBS":{"type":"object","properties":{"cCstIbsCbs":{"type":"string","description":"Código de Situação Tributária do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"cClassTrib":{"type":"string","description":"Código de Classificação Tributária do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nBaseIbsCbs":{"type":"decimal","description":"Base de cálculo do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."}}},"IBS":{"type":"object","properties":{"nAliqIbsUf":{"type":"decimal","description":"Alíquota do IBS de competência das UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído."},"nPercDiferimentoIbsUf":{"type":"decimal","description":"Percentual do Diferimento - IBS UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal atribuído."},"nPercReducaoIbsUf":{"type":"decimal","description":"Percentual da redução de alíquota - IBS UF. Não deve ser informado na Inclusão/Alteração. Campos disponíveis apenas para consulta. Para os métodos de inclusão e alteração, esses campos serão alimentados conforme cenário fiscal."},"nValDiferimentoIbsUf":{"type":"decimal","description":"Valor do Diferimento - IBS UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nValIbsUf":{"type":"decimal","description":"Valor do IBS de competência da UF. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal.."},"nAliqIbsMun":{"type":"decimal","description":"Alíquota do IBS de competência do Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nPercDiferimentoIbsMun":{"type":"decimal","description":"Percentual do diferimento - UBS Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nPercReducaoIbsMun":{"type":"decimal","description":"Percentual da redução de alíquota - IBS Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nValDiferimentoIbsMun":{"type":"decimal","description":"Valor do Diferimento - IBS Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nValIbsMun":{"type":"decimal","description":"Valor do IBS de competência do Município. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nValIbs":{"type":"decimal","description":"Valor total do IBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."}}},"CBS":{"type":"object","properties":{"nAliqCbs":{"type":"decimal","description":"Alíquota da CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nPercDiferimentoCbs":{"type":"decimal","description":"Percentual do diferimento - CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nPercReducaoCbs":{"type":"decimal","description":"Percentual da redução de alíquota - CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal ."},"nValDiferimentoCbs":{"type":"decimal","description":"Valor do diferimento - CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nValCbs":{"type":"decimal","description":"Valor da CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."}}},"TRIB_REG":{"type":"object","properties":{"cCstIbsCbsReg":{"type":"string","description":"Código da Situação Tributária do IBS e CBS (Tributação Regular). Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"cClassTribReg":{"type":"string","description":"Código de Classificação Tributária do IBS e CBS (Tributação Regular). Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nAliqIbsUfReg":{"type":"decimal","description":"Valor da alíquota do IBS da UF na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nAliqIbsMunReg":{"type":"decimal","description":"Valor da alíquota do IBS do Município na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nAliqCbsReg":{"type":"decimal","description":"Valor da alíquota da CBS na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nValIbsUfReg":{"type":"decimal","description":"Valor do Tributo do IBS da UF na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nValIbsMunReg":{"type":"decimal","description":"Valor do Tributo do IBS do Município na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."},"nValCbsReg":{"type":"decimal","description":"Valor do Tributo da CBS na tributação regular. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme a configuração do cenário fiscal."}}}}}},"agropecuario":{"type":"object","properties":{"cNumReceita":{"type":"string","description":"Número da receita ou receituário do agrotóxico/defensivo agrícola"},"cCpfResponsavel":{"type":"string","description":"CPF do responsá¡vel técnico legalmente habilitado"},"nTipoGuia":{"type":"integer","description":"Tipo da Guia 1 - Corresponde ao GTA 2 - Corresponde ao TTA 3 - Corresponde ao DTA 4 - Corresponde ao ATV 5 - Corresponde ao PTV 6 - Corresponde ao GTV 7 - Corresponde ao Guia Florestal (DOF, SisFlora - PA e MT, SIAM - MG)"},"cUFGuia":{"type":"string","description":"UF de emissão da Guia"},"cSerieGuia":{"type":"string","description":"Número de série da guia"},"nNumGuia":{"type":"integer","description":"Número da guia"}}}}}}},"title":"ListarRemessas (retorno)"},"produtos_remessa_StatusRemessa":{"type":"object","title":"StatusRemessa","description":"Retorna o status da remessa.","required":["call","param"],"properties":{"call":{"type":"string","enum":["StatusRemessa"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodRem":{"type":"integer","maxLength":15,"description":"Código da Remessa"},"cCodIntRem":{"type":"string","maxLength":60,"description":"Código de Integração da Remessa"}}}}},"example":{"call":"StatusRemessa","param":[{"nCodRem":0,"cCodIntRem":""}]}},"produtos_remessa_StatusRemessa_retorno":{"type":"object","properties":{"nCodRem":{"type":"integer","description":"Código da Remessa"},"cCodIntRem":{"type":"string","description":"Código de Integração da Remessa"},"cNumeroRemessa":{"type":"string","description":"Número da Remessa exibido na tela."},"cancelada":{"type":"string","description":"NF-e Cancelada?"},"faturada":{"type":"string"},"cAmbiente":{"type":"string"},"nValorTotal":{"type":"decimal","description":"Valor total da remessa"},"ListaNfe":{"type":"array","items":{"type":"object","properties":{"nNumLote":{"type":"integer","description":"Número do lote da NF-e"},"cStatusLote":{"type":"string","description":"Status do Lote da NF-e."},"nRecibo":{"type":"integer","description":"Recibo"},"contingencia":{"type":"string","description":"NF-e emitida em contingência"},"cNumNFe":{"type":"string","description":"Número da NF-e gerada"},"cSerieNFe":{"type":"string","description":"Série da NF-e"},"cStatusNFe":{"type":"string","description":"Status da NF-e"},"cChaveNFe":{"type":"string","description":"Chave de Acesso da NF-e"},"nProtocolo":{"type":"integer","description":"Número do Protocolo"},"cTipo":{"type":"string","description":"Tipo de Emissão. Pode ser: E - Entrada S - Saída"},"dtEmissao":{"type":"string","description":"Data da Emissão da NF-e"},"hrEmissao":{"type":"string","description":"Hora da Emissão da NF-e"},"dtFatura":{"type":"string","description":"Data do faturamento"},"hrFatura":{"type":"string","description":"Hora de Faturamento"},"dtSaida":{"type":"string","description":"Data de Saída"},"hrSaida":{"type":"string","description":"Hora de Saída da NF-e"},"mensagens":{"type":"array","items":{"type":"object","properties":{"cCodigo":{"type":"string","description":"Código da mensagem de erro/aviso"},"cDescricao":{"type":"string","description":"Descrição da mensagem de erro/aviso."},"cCorrecao":{"type":"string","description":"Correção da descrição de mensagem de erro/aviso."}}},"description":"Mensagens de Erros"},"cXmlDistribuicao":{"type":"string","description":"XML de distribuição da NF-e"},"cDanfe":{"type":"string","description":"Link para o DANFE da NF-e gerada."}}},"description":"Lista de NF-es geradas"}},"title":"StatusRemessa (retorno)"},"produtos_remessafat_CancelarRemessa":{"type":"object","title":"CancelarRemessa","description":"Cancelar remessa de produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["CancelarRemessa"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodRem":{"type":"integer","maxLength":15,"description":"Código da Remessa."},"cCodIntRem":{"type":"string","maxLength":60,"description":"Código de Integração da Remessa."}}}}},"example":{"call":"CancelarRemessa","param":[{"nCodRem":0,"cCodIntRem":""}]}},"produtos_remessafat_CancelarRemessa_retorno":{"type":"object","properties":{"nCodRem":{"type":"integer","description":"Código da Remessa."},"cCodIntRem":{"type":"string","description":"Código de Integração da Remessa."},"cCodStatus":{"type":"string","description":"Código do Status."},"cDescStatus":{"type":"string","description":"Descrição do Status."}},"title":"CancelarRemessa (retorno)"},"produtos_remessafat_ConcluirRemessa":{"type":"object","title":"ConcluirRemessa","description":"Concluir remessa de produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConcluirRemessa"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodRem":{"type":"integer","maxLength":15,"description":"Código da Remessa."},"cCodIntRem":{"type":"string","maxLength":60,"description":"Código de Integração da Remessa."}}}}},"example":{"call":"ConcluirRemessa","param":[{"nCodRem":0,"cCodIntRem":""}]}},"produtos_remessafat_ConcluirRemessa_retorno":{"type":"object","properties":{"nCodRem":{"type":"integer","description":"Código da Remessa."},"cCodIntRem":{"type":"string","description":"Código de Integração da Remessa."},"cCodStatus":{"type":"string","description":"Código do Status."},"cDescStatus":{"type":"string","description":"Descrição do Status."}},"title":"ConcluirRemessa (retorno)"},"produtos_remessafat_ConferirRemessa":{"type":"object","title":"ConferirRemessa","description":"Conferir remessa de produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConferirRemessa"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodRem":{"type":"integer","maxLength":15,"description":"Código da Remessa."},"cCodIntRem":{"type":"string","maxLength":60,"description":"Código de Integração da Remessa."}}}}},"example":{"call":"ConferirRemessa","param":[{"nCodRem":0,"cCodIntRem":""}]}},"produtos_remessafat_ConferirRemessa_retorno":{"type":"object","properties":{"nCodRem":{"type":"integer","description":"Código da Remessa."},"cCodIntRem":{"type":"string","description":"Código de Integração da Remessa."},"cCodStatus":{"type":"string","description":"Código do Status."},"cDescStatus":{"type":"string","description":"Descrição do Status."}},"title":"ConferirRemessa (retorno)"},"produtos_remessafat_DuplicarRemessa":{"type":"object","title":"DuplicarRemessa","description":"Duplicar remessa de produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["DuplicarRemessa"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodRem":{"type":"integer","maxLength":15,"description":"Código da Remessa."},"cCodIntRem":{"type":"string","maxLength":60,"description":"Código de Integração da Remessa."}}}}},"example":{"call":"DuplicarRemessa","param":[{"nCodRem":0,"cCodIntRem":""}]}},"produtos_remessafat_DuplicarRemessa_retorno":{"type":"object","properties":{"nCodRem":{"type":"integer","description":"Código da Remessa."},"cCodIntRem":{"type":"string","description":"Código de Integração da Remessa."},"cCodStatus":{"type":"string","description":"Código do Status."},"cDescStatus":{"type":"string","description":"Descrição do Status."}},"title":"DuplicarRemessa (retorno)"},"produtos_requisicaocompra_AlterarReq":{"type":"object","title":"AlterarReq","description":"Alterar Requisição de Compras.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarReq"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codReqCompra":{"type":"integer","maxLength":15,"description":"Código da Requisição de Compras."},"codIntReqCompra":{"type":"string","maxLength":20,"description":"Código de integração da requisição de Compra."},"codCateg":{"type":"string","maxLength":20,"description":"Código da Categoria."},"codProj":{"type":"integer","maxLength":15,"description":"Código do Projeto."},"dtSugestao":{"type":"string","maxLength":10,"description":"Data de Sugestão de Entrega."},"obsReqCompra":{"type":"string","description":"Preencha aqui as observações desta requisição (elas serão impressas na carta de cotação para o fornecedor)."},"obsIntReqCompra":{"type":"string","description":"Preencha aqui as observações internas desta requisição (elas serão exibidas apenas aqui)."},"ItensReqCompra":{"type":"array","items":{"type":"object","properties":{"codItem":{"type":"integer","maxLength":15,"description":"Código do Item da Requisição de Compras."},"codIntItem":{"type":"string","maxLength":20,"description":"Código de integração do Item da requisição de Compra."},"codProd":{"type":"integer","maxLength":15,"description":"Código do Produto."},"codIntProd":{"type":"string","maxLength":60,"description":"Código de Integração do Produto."},"qtde":{"type":"number","maxLength":18,"description":"Quantidade."},"precoUnit":{"type":"number","maxLength":18,"description":"Preço unitário sugerido."},"obsItem":{"type":"string","description":"Observações do item."}}},"description":"Itens da Requisição de Compras."}}}}},"example":{"call":"AlterarReq","param":[{"codCateg":"2.04.06","codIntReqCompra":"INT001","codProj":0,"codReqCompra":0,"dtSugestao":"30/09/2026","obsIntReqCompra":"","obsReqCompra":"","ItensReqCompra":[{"codIntItem":"                    ","codIntProd":"","codItem":200000003040063,"codProd":993848,"obsItem":"","precoUnit":12,"qtde":1}]}]}},"produtos_requisicaocompra_AlterarReq_retorno":{"type":"object","properties":{"codReqCompra":{"type":"integer","description":"Código da Remessa."},"codIntReqCompra":{"type":"string","description":"Código de Integração da Requisição de Compras."},"cCodStatus":{"type":"string","description":"Código do Status."},"cDesStatus":{"type":"string","description":"Descrição do Status da Remessa."}},"title":"AlterarReq (retorno)"},"produtos_requisicaocompra_ConsultarReq":{"type":"object","title":"ConsultarReq","description":"Consultar Requisição de Compras.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarReq"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codReqCompra":{"type":"integer","maxLength":15,"description":"Código da Requisição de Compras."},"codIntReqCompra":{"type":"string","maxLength":20,"description":"Código de integração da requisição de Compra."}}}}},"example":{"call":"ConsultarReq","param":[{"codIntReqCompra":"INT001","codReqCompra":0}]}},"produtos_requisicaocompra_ConsultarReq_retorno":{"type":"object","properties":{"codReqCompra":{"type":"integer","description":"Código da Requisição de Compras."},"codIntReqCompra":{"type":"string","description":"Código de integração da requisição de Compra."},"codCateg":{"type":"string","description":"Código da Categoria."},"codProj":{"type":"integer","description":"Código do Projeto."},"dtSugestao":{"type":"string","description":"Data de Sugestão de Entrega."},"obsReqCompra":{"type":"string","description":"Preencha aqui as observações desta requisição (elas serão impressas na carta de cotação para o fornecedor)."},"obsIntReqCompra":{"type":"string","description":"Preencha aqui as observações internas desta requisição (elas serão exibidas apenas aqui)."},"ItensReqCompra":{"type":"array","items":{"type":"object","properties":{"codItem":{"type":"integer","description":"Código do Item da Requisição de Compras."},"codIntItem":{"type":"string","description":"Código de integração do Item da requisição de Compra."},"codProd":{"type":"integer","description":"Código do Produto."},"codIntProd":{"type":"string","description":"Código de Integração do Produto."},"qtde":{"type":"decimal","description":"Quantidade."},"precoUnit":{"type":"decimal","description":"Preço unitário sugerido."},"obsItem":{"type":"string","description":"Observações do item."}}},"description":"Itens da Requisição de Compras."}},"title":"ConsultarReq (retorno)"},"produtos_requisicaocompra_ExcluirReq":{"type":"object","title":"ExcluirReq","description":"Exclui uma Requisição de Compras.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirReq"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codReqCompra":{"type":"integer","maxLength":15,"description":"Código da Requisição de Compras."},"codIntReqCompra":{"type":"string","maxLength":20,"description":"Código de integração da requisição de Compra."}}}}},"example":{"call":"ExcluirReq","param":[{"codIntReqCompra":"INT001","codReqCompra":0}]}},"produtos_requisicaocompra_ExcluirReq_retorno":{"type":"object","properties":{"codReqCompra":{"type":"integer","description":"Código da Remessa."},"codIntReqCompra":{"type":"string","description":"Código de Integração da Requisição de Compras."},"cCodStatus":{"type":"string","description":"Código do Status."},"cDesStatus":{"type":"string","description":"Descrição do Status da Remessa."}},"title":"ExcluirReq (retorno)"},"produtos_requisicaocompra_IncluirReq":{"type":"object","title":"IncluirReq","description":"Inclui uma Requisição de Compras.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirReq"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codReqCompra":{"type":"integer","maxLength":15,"description":"Código da Requisição de Compras."},"codIntReqCompra":{"type":"string","maxLength":20,"description":"Código de integração da requisição de Compra."},"codCateg":{"type":"string","maxLength":20,"description":"Código da Categoria."},"codProj":{"type":"integer","maxLength":15,"description":"Código do Projeto."},"dtSugestao":{"type":"string","maxLength":10,"description":"Data de Sugestão de Entrega."},"obsReqCompra":{"type":"string","description":"Preencha aqui as observações desta requisição (elas serão impressas na carta de cotação para o fornecedor)."},"obsIntReqCompra":{"type":"string","description":"Preencha aqui as observações internas desta requisição (elas serão exibidas apenas aqui)."},"ItensReqCompra":{"type":"array","items":{"type":"object","properties":{"codItem":{"type":"integer","maxLength":15,"description":"Código do Item da Requisição de Compras."},"codIntItem":{"type":"string","maxLength":20,"description":"Código de integração do Item da requisição de Compra."},"codProd":{"type":"integer","maxLength":15,"description":"Código do Produto."},"codIntProd":{"type":"string","maxLength":60,"description":"Código de Integração do Produto."},"qtde":{"type":"number","maxLength":18,"description":"Quantidade."},"precoUnit":{"type":"number","maxLength":18,"description":"Preço unitário sugerido."},"obsItem":{"type":"string","description":"Observações do item."}}},"description":"Itens da Requisição de Compras."}},"required":["codCateg","dtSugestao"]}}},"example":{"call":"IncluirReq","param":[{"codCateg":"2.04.06","codIntReqCompra":"INT001","codProj":0,"codReqCompra":0,"dtSugestao":"30/09/2026","obsIntReqCompra":"","obsReqCompra":"","ItensReqCompra":[{"codIntItem":"                    ","codIntProd":"","codItem":200000003040063,"codProd":993848,"obsItem":"","precoUnit":12,"qtde":1}]}]}},"produtos_requisicaocompra_IncluirReq_retorno":{"type":"object","properties":{"codReqCompra":{"type":"integer","description":"Código da Remessa."},"codIntReqCompra":{"type":"string","description":"Código de Integração da Requisição de Compras."},"cCodStatus":{"type":"string","description":"Código do Status."},"cDesStatus":{"type":"string","description":"Descrição do Status da Remessa."}},"title":"IncluirReq (retorno)"},"produtos_requisicaocompra_PesquisarReq":{"type":"object","title":"PesquisarReq","description":"Pesquisar Requisição de Compras.","required":["call","param"],"properties":{"call":{"type":"string","enum":["PesquisarReq"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15},"registros_por_pagina":{"type":"integer","maxLength":15},"apenas_importado_api":{"type":"string","maxLength":1},"ordenar_por":{"type":"string","maxLength":100},"ordem_descrescente":{"type":"string","maxLength":1},"filtrar_por_data_de":{"type":"string","maxLength":10},"filtrar_por_data_ate":{"type":"string","maxLength":10},"filtrar_apenas_inclusao":{"type":"string","maxLength":1},"filtrar_apenas_alteracao":{"type":"string","maxLength":1}}}}},"example":{"call":"PesquisarReq","param":[{"pagina":1,"registros_por_pagina":50}]}},"produtos_requisicaocompra_PesquisarReq_retorno":{"type":"object","properties":{"pagina":{"type":"integer"},"total_de_paginas":{"type":"integer"},"registros":{"type":"integer"},"total_de_registros":{"type":"integer"},"requisicaoCadastro":{"type":"array","items":{"type":"object","properties":{"codReqCompra":{"type":"integer","description":"Código da Requisição de Compras."},"codIntReqCompra":{"type":"string","description":"Código de integração da requisição de Compra."},"codCateg":{"type":"string","description":"Código da Categoria."},"codProj":{"type":"integer","description":"Código do Projeto."},"dtSugestao":{"type":"string","description":"Data de Sugestão de Entrega."},"obsReqCompra":{"type":"string","description":"Preencha aqui as observações desta requisição (elas serão impressas na carta de cotação para o fornecedor)."},"obsIntReqCompra":{"type":"string","description":"Preencha aqui as observações internas desta requisição (elas serão exibidas apenas aqui)."},"ItensReqCompra":{"type":"array","items":{"type":"object","properties":{"codItem":{"type":"integer","description":"Código do Item da Requisição de Compras."},"codIntItem":{"type":"string","description":"Código de integração do Item da requisição de Compra."},"codProd":{"type":"integer","description":"Código do Produto."},"codIntProd":{"type":"string","description":"Código de Integração do Produto."},"qtde":{"type":"decimal","description":"Quantidade."},"precoUnit":{"type":"decimal","description":"Preço unitário sugerido."},"obsItem":{"type":"string","description":"Observações do item."}}},"description":"Itens da Requisição de Compras."}}}}},"title":"PesquisarReq (retorno)"},"produtos_requisicaocompra_UpsertReq":{"type":"object","title":"UpsertReq","description":"Upsert Requisição de Compras.","required":["call","param"],"properties":{"call":{"type":"string","enum":["UpsertReq"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"codReqCompra":{"type":"integer","maxLength":15,"description":"Código da Requisição de Compras."},"codIntReqCompra":{"type":"string","maxLength":20,"description":"Código de integração da requisição de Compra."},"codCateg":{"type":"string","maxLength":20,"description":"Código da Categoria."},"codProj":{"type":"integer","maxLength":15,"description":"Código do Projeto."},"dtSugestao":{"type":"string","maxLength":10,"description":"Data de Sugestão de Entrega."},"obsReqCompra":{"type":"string","description":"Preencha aqui as observações desta requisição (elas serão impressas na carta de cotação para o fornecedor)."},"obsIntReqCompra":{"type":"string","description":"Preencha aqui as observações internas desta requisição (elas serão exibidas apenas aqui)."},"ItensReqCompra":{"type":"array","items":{"type":"object","properties":{"codItem":{"type":"integer","maxLength":15,"description":"Código do Item da Requisição de Compras."},"codIntItem":{"type":"string","maxLength":20,"description":"Código de integração do Item da requisição de Compra."},"codProd":{"type":"integer","maxLength":15,"description":"Código do Produto."},"codIntProd":{"type":"string","maxLength":60,"description":"Código de Integração do Produto."},"qtde":{"type":"number","maxLength":18,"description":"Quantidade."},"precoUnit":{"type":"number","maxLength":18,"description":"Preço unitário sugerido."},"obsItem":{"type":"string","description":"Observações do item."}}},"description":"Itens da Requisição de Compras."}}}}},"example":{"call":"UpsertReq","param":[{"codCateg":"2.04.06","codIntReqCompra":"INT001","codProj":0,"codReqCompra":0,"dtSugestao":"30/09/2026","obsIntReqCompra":"","obsReqCompra":"","ItensReqCompra":[{"codIntItem":"                    ","codIntProd":"","codItem":200000003040063,"codProd":993848,"obsItem":"","precoUnit":12,"qtde":1}]}]}},"produtos_requisicaocompra_UpsertReq_retorno":{"type":"object","properties":{"codReqCompra":{"type":"integer","description":"Código da Remessa."},"codIntReqCompra":{"type":"string","description":"Código de Integração da Requisição de Compras."},"cCodStatus":{"type":"string","description":"Código do Status."},"cDesStatus":{"type":"string","description":"Descrição do Status da Remessa."}},"title":"UpsertReq (retorno)"},"produtos_sat_ImportarCfeSat":{"type":"object","title":"ImportarCfeSat","description":"Importa o XML de um CF-e SAT.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ImportarCfeSat"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"emiNome":{"type":"string","maxLength":20,"description":"Nome do aplicativo emissor do cupom fiscal.\nO aplicativo deve ser previamente cadastrado. Para isso entre em contato com a nosso suporte."},"emiVersao":{"type":"string","maxLength":20,"description":"Versão do aplicativo emissor do cupom fiscal."},"emiId":{"type":"string","maxLength":20,"description":"Identificação do computador onde o aplicativo emissor do cupom fiscal está instalado. É o código do PDV.\nExemplos: \"01\", \"20\", \"55\"."},"chNFe":{"type":"string","maxLength":44,"description":"Chave de Acesso do CF-e-SAT."},"satXml":{"type":"string","description":"XML do Cupom Fiscal enviado.\n\nPreechimento obrigatório.\n\nAntes de enviar, converta os seus seguintes caracteres:\n\n&amp; para &amp;amp;\n> para &amp;gt;\n< para &amp;lt;\n\" para &amp;quot;\n\" para &amp;apos;\n| para &amp;#124;\n\nApós essa conversão aplique o MD5 para enviar no campo \"nfceMd5\".\n\nObservação: Para requisições SOAP usar CDATA como demonstra o exemplo abaixo:\n&lt;![CDATA[Conteúdo do campo convertido]]&gt;."},"satMd5":{"type":"string","maxLength":32,"description":"MD5 do arquivo XML enviado em \"satXml\"."},"cAcaoCliente":{"type":"string","maxLength":15,"description":"Ação a ser executada com relação a tag idCliente.\n\nPode ser:\n\n- CONSUMIDOR: assumirá que a venda foi realizada para um cliente consumidor padrão. Caso não exista um cliente consumidor cadastrado, o mesmo será criado automaticamente.\n\n- ERRO (padrão): Exigirá a definição de um idCliente válido.\n\n- INCLUIR: Com base nos dados do XML irá fazer a inclusão de um novo cliente."},"idCliente":{"type":"integer","maxLength":15,"description":"Código do cliente.\n\n- Se no XML não houver informações do cliente assumirá que a venda foi realizada para um cliente consumidor padrão. Caso não exista um cliente consumidor cadastrado, o mesmo será criado automaticamente.\n\n- Se no XML houver informações do cliente, seus dados serão consultados no Omie com base no CPF/CNPJ, caso não seja encontrado a tag cAcaoCliente será avaliada.\n\nPossível valores para tag cAcaoCliente:\n\n- CONSUMIDOR: assumirá que a venda foi realizada para um cliente consumidor padrão. Caso não exista um cliente consumidor cadastrado, o mesmo será criado automaticamente.\n\n- ERRO (padrão): Exigirá a definição de um idCliente válido.\n\n- INCLUIR: Com base nos dados do XML irá fazer a inclusão de um novo cliente."},"idVendedor":{"type":"integer","maxLength":15,"description":"Código do vendedor.\n\nQuando não informado, será criado um vendedor padrão para o emissor de cupom fiscal."},"idProjeto":{"type":"integer","maxLength":15,"description":"Código do projeto.\n\nQuando não informado, será criado um projeto padrão para o emissor de cupom fiscal."},"idLocalEstoque":{"type":"integer","maxLength":15,"description":"Código do Local do Estoque.\n\nCaso não informado assumirá o Local de Estoque padrão."},"cNaoMovEstoque":{"type":"string","maxLength":1,"description":"Indica que os items do Cupom Fiscal não devem movimentar o estoque.\n\nValores possíveis:\nS - Sim\nN - Não."},"cNaoGerarTitulo":{"type":"string","maxLength":1,"description":"Indica que a parcela não deve gerar um título no financeiro.\n\nValores possíveis:\nS - Sim\nN - Não."},"cIncluirProduto":{"type":"string","maxLength":1,"description":"Indica se na inclusão do cupom os produtos não existentes devem ser incluídos automaticamente.\n\nPossíveis valores:\nS - Sim\nN - Não (padrão)."}},"required":["chNFe","emiId","emiNome","emiVersao","satMd5","satXml"]}}},"example":{"call":"ImportarCfeSat","param":[{"emiNome":"SeuPDV","emiVersao":"1.01.02","emiId":"PDV01","chNFe":"","satXml":"","satMd5":"","cAcaoCliente":"INCLUIR","idCliente":0,"idVendedor":0,"idProjeto":0,"idLocalEstoque":0,"cNaoMovEstoque":"N","cNaoGerarTitulo":"N","cIncluirProduto":"N"}]}},"produtos_sat_ImportarCfeSat_retorno":{"type":"object","properties":{"idImportacao":{"type":"integer","description":"ID da Importação."},"idCupom":{"type":"integer","description":"Identificação do cupom fiscal."},"idLote":{"type":"integer","description":"Identificação do lote do cupom fiscal."},"cCodStatus":{"type":"string","description":"Código do status de processamento do cupom fiscal. Se retornar 0 indica que o cupom foi processado com sucesso. Se retornar um valor maior que zero indica o código do erro gerado."},"cDesStatus":{"type":"string","description":"Descrição do status de processamento. Caso ocorra erro, retorna a descrição do erro gerado."}},"title":"ImportarCfeSat (retorno)"},"produtos_tabelaprecos_AlterarPrecoItem":{"type":"object","title":"AlterarPrecoItem","description":"Altera o preço de um item da Tabela de Preços.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarPrecoItem"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodTabPreco":{"type":"integer","maxLength":15,"description":"Código da Tabela de Preços.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno da Tabela de Preços gerado pelo Omie."},"nCodProd":{"type":"integer","maxLength":15,"description":"Código do produto.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno do produto gerado pelo Omie."},"nValorTabela":{"type":"number","maxLength":18,"description":"Valor do Item da Tabela de Preços."}},"required":["nCodProd","nCodTabPreco"]}}},"example":{"call":"AlterarPrecoItem","param":[{"nCodTabPreco":0,"nCodProd":0,"nValorTabela":0}]}},"produtos_tabelaprecos_AlterarPrecoItem_retorno":{"type":"object","properties":{"nCodTabPreco":{"type":"integer","description":"Código da Tabela de Preços. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da Tabela de Preços gerado pelo Omie."},"nCodProd":{"type":"integer","description":"Código do produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do produto gerado pelo Omie."},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro duranteo o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodigoStatus\"."}},"title":"AlterarPrecoItem (retorno)"},"produtos_tabelaprecos_AlterarTabelaPreco":{"type":"object","title":"AlterarTabelaPreco","description":"Altera uma tabela de preços.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarTabelaPreco"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodTabPreco":{"type":"integer","maxLength":15,"description":"Código da Tabela de Preços.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno da Tabela de Preços gerado pelo Omie."},"cCodIntTabPreco":{"type":"string","maxLength":20,"description":"Código de integração da Tabela de Preços.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código da Tabela de Preços utilizado no seu aplicativo quando incluir uma Tabela de Preços no Omie.\nAssim, poderá utilizar esse campo para resgatar as informações da Tabela de Preços desejada.\nCaso informe esse campo, não informe a tag nCodTabPreco. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"cNome":{"type":"string","maxLength":50,"description":"Nome da Tabela de Preço."},"cCodigo":{"type":"string","maxLength":20,"description":"Código da Tabela de Preço.\n(Exibido na tela do aplicativo)."},"produtos":{"type":"object","properties":{"cTodosProdutos":{"type":"string","maxLength":1,"description":"Considerar todos os produtos nesta tabela de preços? (S/N)\nO padrão é \"S\".\nQuando informar \"S\", todos os demais campos deste grupo serão desconsiderados.\nCaso informe \"N\", pelo menos 1 dos campos deste grupo deverá ser informado."},"nCodFamilia":{"type":"integer","maxLength":15,"description":"Código da família.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno da família gerado pelo Omie.\nSerá ignorado caso o campo \"cTodosProdutos\" estiver preenhido com \"S\"."},"cNCM":{"type":"string","maxLength":13,"description":"Código do NCM.\nNo formato 9999.99.99\nSerá ignorado caso o campo \"cTodosProdutos\" estiver preenhido com \"S\"."},"nCodCaract":{"type":"integer","maxLength":15,"description":"Código da característica de produto.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno da característica do produto gerado pelo Omie.\nSerá ignorado caso o campo \"cTodosProdutos\" estiver preenhido com \"S\"."},"cConteudo":{"type":"string","maxLength":60,"description":"Conteúdo da característica.\nSerá ignorado caso o campo \"cTodosProdutos\" estiver preenhido com \"S\"."},"nCodFornec":{"type":"integer","maxLength":15,"description":"Código do fornecedor.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno do fornecedor gerado pelo Omie.\nSerá ignorado caso o campo \"cTodosProdutos\" estiver preenhido com \"S\"."}},"description":"Dados dos filtros por produto."},"clientes":{"type":"object","properties":{"cTodosClientes":{"type":"string","maxLength":1,"description":"Considerar todos os clientes nesta tabela de preços? (S/N)\nO padrão é \"S\".\nQuando informar \"S\", todos os demais campos deste grupo serão desconsiderados.\nCaso informe \"N\", pelo menos 1 dos campos deste grupo deverá ser informado."},"nCodTag":{"type":"integer","maxLength":15,"description":"Considerar apenas os clientes de uma determinada Tag.\nSerá ignorado caso o campo \"cTodosClientes\" estiver preenhido com \"S\"."},"cTag":{"type":"string","maxLength":50,"description":"Descrição da tag do cliente informada no campo nCodTag.\nO conteúdo deste campo é apenas informativo e não tem efeito na inclusão.\nNa inclusão utilize a tag \"nCodTag\"."},"cUF":{"type":"string","maxLength":2,"description":"Considerar apenas os clientes do Estado.\nSerá ignorado caso o campo \"cTodosClientes\" estiver preenhido com \"S\"."}},"description":"Dados dos filtros do cliente."},"outrasInfo":{"type":"object","properties":{"nCodOrigTab":{"type":"integer","maxLength":15,"description":"Código da Tabela de Preço Original."},"nPercAcrescimo":{"type":"number","maxLength":10,"description":"Percentual de Acréscimo da tabela de preços."},"nPercDesconto":{"type":"number","maxLength":10,"description":"Percentual de Desconto da tabela de preços."}},"description":"Outros filtros da tabela de preços."},"caracteristicas":{"type":"object","properties":{"cTemValidade":{"type":"string","maxLength":1,"description":"Indica se a Tabela de Preço possui Validade (S/N)."},"dDtInicial":{"type":"string","maxLength":10,"description":"Data Inicial da Validade da Tabela de Preço.\nNo formato dd/mm/aaaa."},"dDtFinal":{"type":"string","maxLength":10,"description":"Data Final de Validade Tabela de Preço.\nNo formato dd/mm/aaaa."},"cTemDesconto":{"type":"string","maxLength":1,"description":"Indica se a Tabela de Preço possui Desconto Sugerido ou Máximo (S/N)."},"nDescSugerido":{"type":"number","maxLength":10,"description":"Percentual de Desconto Sugerido."},"nPercDescMax":{"type":"number","maxLength":10,"description":"Percentual de Desconto Máximo Permitido."},"cArredPreco":{"type":"string","maxLength":1,"description":"Indica se deve Arredondar o preço dos produtos (S/N)."}},"description":"Características da tabela de preço."},"cOrigem":{"type":"string","maxLength":3,"description":"Origem da Tabela de Preços.\nPode ser:\nPRD - Lê o preço do cadastro de produtos.\nCMC - Lê o preço do CMC do produto.\nTBL - Lê o preço de uma tabela específica informada na tag \"nCodOrigTab\"."}}}}},"example":{"call":"AlterarTabelaPreco","param":[{"nCodTabPreco":0,"cCodIntTabPreco":"TP1790776581","cNome":"","cCodigo":"","cOrigem":"","produtos":{"cTodosProdutos":"S","nCodFamilia":0,"cNCM":"","nCodCaract":0,"cConteudo":"","nCodFornec":0},"clientes":{"cTodosClientes":"S","nCodTag":0,"cTag":"","cUF":""},"outrasInfo":{"nCodOrigTab":0,"nPercAcrescimo":0,"nPercDesconto":0},"caracteristicas":{"cTemValidade":"S","dDtInicial":"30/09/2026","dDtFinal":"30/09/2026","cTemDesconto":"","nDescSugerido":0,"nPercDescMax":0,"cArredPreco":"N"}}]}},"produtos_tabelaprecos_AlterarTabelaPreco_retorno":{"type":"object","properties":{"nCodTabPreco":{"type":"integer","description":"Código da Tabela de Preços. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da Tabela de Preços gerado pelo Omie."},"cCodIntTabPreco":{"type":"string","description":"Código de integração da Tabela de Preços. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código da Tabela de Preços utilizado no seu aplicativo quando incluir uma Tabela de Preços no Omie. Assim, poderá utilizar esse campo para resgatar as informações da Tabela de Preços desejada. Caso informe esse campo, não informe a tag nCodTabPreco. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro duranteo o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodigoStatus\"."}},"title":"AlterarTabelaPreco (retorno)"},"produtos_tabelaprecos_AtivarTabelaPreco":{"type":"object","title":"AtivarTabelaPreco","description":"Ativa uma tabela de preços.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AtivarTabelaPreco"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodTabPreco":{"type":"integer","maxLength":15,"description":"Código da Tabela de Preços.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno da Tabela de Preços gerado pelo Omie."},"cCodIntTabPreco":{"type":"string","maxLength":20,"description":"Código de integração da Tabela de Preços.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código da Tabela de Preços utilizado no seu aplicativo quando incluir uma Tabela de Preços no Omie.\nAssim, poderá utilizar esse campo para resgatar as informações da Tabela de Preços desejada.\nCaso informe esse campo, não informe a tag nCodTabPreco. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."}}}}},"example":{"call":"AtivarTabelaPreco","param":[{"nCodTabPreco":0,"cCodIntTabPreco":""}]}},"produtos_tabelaprecos_AtivarTabelaPreco_retorno":{"type":"object","properties":{"nCodTabPreco":{"type":"integer","description":"Código da Tabela de Preços. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da Tabela de Preços gerado pelo Omie."},"cCodIntTabPreco":{"type":"string","description":"Código de integração da Tabela de Preços. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código da Tabela de Preços utilizado no seu aplicativo quando incluir uma Tabela de Preços no Omie. Assim, poderá utilizar esse campo para resgatar as informações da Tabela de Preços desejada. Caso informe esse campo, não informe a tag nCodTabPreco. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro duranteo o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodigoStatus\"."}},"title":"AtivarTabelaPreco (retorno)"},"produtos_tabelaprecos_AtualizarProdutos":{"type":"object","title":"AtualizarProdutos","description":"Atualiza os produtos da tabela de preços.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AtualizarProdutos"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodTabPreco":{"type":"integer","maxLength":15,"description":"Código da Tabela de Preços.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno da Tabela de Preços gerado pelo Omie."},"cCodIntTabPreco":{"type":"string","maxLength":20,"description":"Código de integração da Tabela de Preços.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código da Tabela de Preços utilizado no seu aplicativo quando incluir uma Tabela de Preços no Omie.\nAssim, poderá utilizar esse campo para resgatar as informações da Tabela de Preços desejada.\nCaso informe esse campo, não informe a tag nCodTabPreco. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"nPercAcrescimo":{"type":"number","maxLength":10,"description":"Percentual de Acréscimo da tabela de preços."},"nPercDesconto":{"type":"number","maxLength":10,"description":"Percentual de Desconto da tabela de preços."},"cArredPreco":{"type":"string","maxLength":1,"description":"Indica se deve Arredondar o preço dos produtos (S/N)."}},"required":["cArredPreco"]}}},"example":{"call":"AtualizarProdutos","param":[{"nCodTabPreco":0,"cCodIntTabPreco":""}]}},"produtos_tabelaprecos_AtualizarProdutos_retorno":{"type":"object","properties":{"nCodTabPreco":{"type":"integer","description":"Código da Tabela de Preços. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da Tabela de Preços gerado pelo Omie."},"cCodIntTabPreco":{"type":"string","description":"Código de integração da Tabela de Preços. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código da Tabela de Preços utilizado no seu aplicativo quando incluir uma Tabela de Preços no Omie. Assim, poderá utilizar esse campo para resgatar as informações da Tabela de Preços desejada. Caso informe esse campo, não informe a tag nCodTabPreco. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro duranteo o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodigoStatus\"."}},"title":"AtualizarProdutos (retorno)"},"produtos_tabelaprecos_ConsultarTabelaPreco":{"type":"object","title":"ConsultarTabelaPreco","description":"Consulta uma tabela de preços.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarTabelaPreco"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodTabPreco":{"type":"integer","maxLength":15,"description":"Código da Tabela de Preços.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno da Tabela de Preços gerado pelo Omie."},"cCodIntTabPreco":{"type":"string","maxLength":20,"description":"Código de integração da Tabela de Preços.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código da Tabela de Preços utilizado no seu aplicativo quando incluir uma Tabela de Preços no Omie.\nAssim, poderá utilizar esse campo para resgatar as informações da Tabela de Preços desejada.\nCaso informe esse campo, não informe a tag nCodTabPreco. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."}}}}},"example":{"call":"ConsultarTabelaPreco","param":[{"nCodTabPreco":0,"cCodIntTabPreco":""}]}},"produtos_tabelaprecos_ConsultarTabelaPreco_retorno":{"type":"object","properties":{"nCodTabPreco":{"type":"integer","description":"Código da Tabela de Preços. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da Tabela de Preços gerado pelo Omie."},"cCodIntTabPreco":{"type":"string","description":"Código de integração da Tabela de Preços. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código da Tabela de Preços utilizado no seu aplicativo quando incluir uma Tabela de Preços no Omie. Assim, poderá utilizar esse campo para resgatar as informações da Tabela de Preços desejada. Caso informe esse campo, não informe a tag nCodTabPreco. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"cNome":{"type":"string","description":"Nome da Tabela de Preço."},"cCodigo":{"type":"string","description":"Código da Tabela de Preço. (Exibido na tela do aplicativo)."},"cAtiva":{"type":"string","description":"Indica se a tabela de preços está ativa (S/N)."},"cOrigem":{"type":"string","description":"Origem da Tabela de Preços. Pode ser: PRD - Lê o preço do cadastro de produtos. CMC - Lê o preço do CMC do produto. TBL - Lê o preço de uma tabela específica informada na tag \"nCodOrigTab\"."},"produtos":{"type":"object","properties":{"cTodosProdutos":{"type":"string","description":"Considerar todos os produtos nesta tabela de preços? (S/N) O padrão é \"S\". Quando informar \"S\", todos os demais campos deste grupo serão desconsiderados. Caso informe \"N\", pelo menos 1 dos campos deste grupo deverá ser informado."},"nCodFamilia":{"type":"integer","description":"Código da família. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da família gerado pelo Omie. Será ignorado caso o campo \"cTodosProdutos\" estiver preenhido com \"S\"."},"cNCM":{"type":"string","description":"Código do NCM. No formato 9999.99.99 Será ignorado caso o campo \"cTodosProdutos\" estiver preenhido com \"S\"."},"nCodCaract":{"type":"integer","description":"Código da característica de produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da característica do produto gerado pelo Omie. Será ignorado caso o campo \"cTodosProdutos\" estiver preenhido com \"S\"."},"cConteudo":{"type":"string","description":"Conteúdo da característica. Será ignorado caso o campo \"cTodosProdutos\" estiver preenhido com \"S\"."},"nCodFornec":{"type":"integer","description":"Código do fornecedor. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do fornecedor gerado pelo Omie. Será ignorado caso o campo \"cTodosProdutos\" estiver preenhido com \"S\"."}},"description":"Dados dos filtros por produto."},"clientes":{"type":"object","properties":{"cTodosClientes":{"type":"string","description":"Considerar todos os clientes nesta tabela de preços? (S/N) O padrão é \"S\". Quando informar \"S\", todos os demais campos deste grupo serão desconsiderados. Caso informe \"N\", pelo menos 1 dos campos deste grupo deverá ser informado."},"nCodTag":{"type":"integer","description":"Considerar apenas os clientes de uma determinada Tag. Será ignorado caso o campo \"cTodosClientes\" estiver preenhido com \"S\"."},"cTag":{"type":"string","description":"Descrição da tag do cliente informada no campo nCodTag. O conteúdo deste campo é apenas informativo e não tem efeito na inclusão. Na inclusão utilize a tag \"nCodTag\"."},"cUF":{"type":"string","description":"Considerar apenas os clientes do Estado. Será ignorado caso o campo \"cTodosClientes\" estiver preenhido com \"S\"."}},"description":"Dados dos filtros do cliente."},"outrasInfo":{"type":"object","properties":{"nCodOrigTab":{"type":"integer","description":"Código da Tabela de Preço Original."},"nPercAcrescimo":{"type":"decimal","description":"Percentual de Acréscimo da tabela de preços."},"nPercDesconto":{"type":"decimal","description":"Percentual de Desconto da tabela de preços."}},"description":"Outros filtros da tabela de preços."},"caracteristicas":{"type":"object","properties":{"cTemValidade":{"type":"string","description":"Indica se a Tabela de Preço possui Validade (S/N)."},"dDtInicial":{"type":"string","description":"Data Inicial da Validade da Tabela de Preço. No formato dd/mm/aaaa."},"dDtFinal":{"type":"string","description":"Data Final de Validade Tabela de Preço. No formato dd/mm/aaaa."},"cTemDesconto":{"type":"string","description":"Indica se a Tabela de Preço possui Desconto Sugerido ou Máximo (S/N)."},"nDescSugerido":{"type":"decimal","description":"Percentual de Desconto Sugerido."},"nPercDescMax":{"type":"decimal","description":"Percentual de Desconto Máximo Permitido."},"cArredPreco":{"type":"string","description":"Indica se deve Arredondar o preço dos produtos (S/N)."}},"description":"Características da tabela de preço."},"info":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão. No formato dd/mm/aaaa."},"hInc":{"type":"string","description":"Hora da Inclusão. No formato hh:mm:ss."},"uInc":{"type":"string","description":"Usuário da Inclusão."},"dAlt":{"type":"string","description":"Data da Alteração. No formato dd/mm/aaaa."},"hAlt":{"type":"string","description":"Hora da Alteração. No formato hh:mm:ss."},"uAlt":{"type":"string","description":"Usuário da Alteração."},"cImpAPI":{"type":"string","description":"Importado pela API (S/N)."}},"description":"Informações do cadastro da tabela de preços."}},"title":"ConsultarTabelaPreco (retorno)"},"produtos_tabelaprecos_ExcluirTabelaPreco":{"type":"object","title":"ExcluirTabelaPreco","description":"Exclui uma tabela de preços.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirTabelaPreco"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodTabPreco":{"type":"integer","maxLength":15,"description":"Código da Tabela de Preços.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno da Tabela de Preços gerado pelo Omie."},"cCodIntTabPreco":{"type":"string","maxLength":20,"description":"Código de integração da Tabela de Preços.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código da Tabela de Preços utilizado no seu aplicativo quando incluir uma Tabela de Preços no Omie.\nAssim, poderá utilizar esse campo para resgatar as informações da Tabela de Preços desejada.\nCaso informe esse campo, não informe a tag nCodTabPreco. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."}}}}},"example":{"call":"ExcluirTabelaPreco","param":[{"nCodTabPreco":0,"cCodIntTabPreco":""}]}},"produtos_tabelaprecos_ExcluirTabelaPreco_retorno":{"type":"object","properties":{"nCodTabPreco":{"type":"integer","description":"Código da Tabela de Preços. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da Tabela de Preços gerado pelo Omie."},"cCodIntTabPreco":{"type":"string","description":"Código de integração da Tabela de Preços. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código da Tabela de Preços utilizado no seu aplicativo quando incluir uma Tabela de Preços no Omie. Assim, poderá utilizar esse campo para resgatar as informações da Tabela de Preços desejada. Caso informe esse campo, não informe a tag nCodTabPreco. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro duranteo o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodigoStatus\"."}},"title":"ExcluirTabelaPreco (retorno)"},"produtos_tabelaprecos_IncluirTabelaPreco":{"type":"object","title":"IncluirTabelaPreco","description":"Inclui uma tabela de preços.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirTabelaPreco"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cCodIntTabPreco":{"type":"string","maxLength":20,"description":"Código de integração da Tabela de Preços.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código da Tabela de Preços utilizado no seu aplicativo quando incluir uma Tabela de Preços no Omie.\nAssim, poderá utilizar esse campo para resgatar as informações da Tabela de Preços desejada.\nCaso informe esse campo, não informe a tag nCodTabPreco. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"cNome":{"type":"string","maxLength":50,"description":"Nome da Tabela de Preço."},"cCodigo":{"type":"string","maxLength":20,"description":"Código da Tabela de Preço.\n(Exibido na tela do aplicativo)."},"produtos":{"type":"object","properties":{"cTodosProdutos":{"type":"string","maxLength":1,"description":"Considerar todos os produtos nesta tabela de preços? (S/N)\nO padrão é \"S\".\nQuando informar \"S\", todos os demais campos deste grupo serão desconsiderados.\nCaso informe \"N\", pelo menos 1 dos campos deste grupo deverá ser informado."},"nCodFamilia":{"type":"integer","maxLength":15,"description":"Código da família.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno da família gerado pelo Omie.\nSerá ignorado caso o campo \"cTodosProdutos\" estiver preenhido com \"S\"."},"cNCM":{"type":"string","maxLength":13,"description":"Código do NCM.\nNo formato 9999.99.99\nSerá ignorado caso o campo \"cTodosProdutos\" estiver preenhido com \"S\"."},"nCodCaract":{"type":"integer","maxLength":15,"description":"Código da característica de produto.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno da característica do produto gerado pelo Omie.\nSerá ignorado caso o campo \"cTodosProdutos\" estiver preenhido com \"S\"."},"cConteudo":{"type":"string","maxLength":60,"description":"Conteúdo da característica.\nSerá ignorado caso o campo \"cTodosProdutos\" estiver preenhido com \"S\"."},"nCodFornec":{"type":"integer","maxLength":15,"description":"Código do fornecedor.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno do fornecedor gerado pelo Omie.\nSerá ignorado caso o campo \"cTodosProdutos\" estiver preenhido com \"S\"."}},"description":"Dados dos filtros por produto."},"clientes":{"type":"object","properties":{"cTodosClientes":{"type":"string","maxLength":1,"description":"Considerar todos os clientes nesta tabela de preços? (S/N)\nO padrão é \"S\".\nQuando informar \"S\", todos os demais campos deste grupo serão desconsiderados.\nCaso informe \"N\", pelo menos 1 dos campos deste grupo deverá ser informado."},"nCodTag":{"type":"integer","maxLength":15,"description":"Considerar apenas os clientes de uma determinada Tag.\nSerá ignorado caso o campo \"cTodosClientes\" estiver preenhido com \"S\"."},"cTag":{"type":"string","maxLength":50,"description":"Descrição da tag do cliente informada no campo nCodTag.\nO conteúdo deste campo é apenas informativo e não tem efeito na inclusão.\nNa inclusão utilize a tag \"nCodTag\"."},"cUF":{"type":"string","maxLength":2,"description":"Considerar apenas os clientes do Estado.\nSerá ignorado caso o campo \"cTodosClientes\" estiver preenhido com \"S\"."}},"description":"Dados dos filtros do cliente."},"outrasInfo":{"type":"object","properties":{"nCodOrigTab":{"type":"integer","maxLength":15,"description":"Código da Tabela de Preço Original."},"nPercAcrescimo":{"type":"number","maxLength":10,"description":"Percentual de Acréscimo da tabela de preços."},"nPercDesconto":{"type":"number","maxLength":10,"description":"Percentual de Desconto da tabela de preços."}},"description":"Outros filtros da tabela de preços."},"caracteristicas":{"type":"object","properties":{"cTemValidade":{"type":"string","maxLength":1,"description":"Indica se a Tabela de Preço possui Validade (S/N)."},"dDtInicial":{"type":"string","maxLength":10,"description":"Data Inicial da Validade da Tabela de Preço.\nNo formato dd/mm/aaaa."},"dDtFinal":{"type":"string","maxLength":10,"description":"Data Final de Validade Tabela de Preço.\nNo formato dd/mm/aaaa."},"cTemDesconto":{"type":"string","maxLength":1,"description":"Indica se a Tabela de Preço possui Desconto Sugerido ou Máximo (S/N)."},"nDescSugerido":{"type":"number","maxLength":10,"description":"Percentual de Desconto Sugerido."},"nPercDescMax":{"type":"number","maxLength":10,"description":"Percentual de Desconto Máximo Permitido."},"cArredPreco":{"type":"string","maxLength":1,"description":"Indica se deve Arredondar o preço dos produtos (S/N)."}},"description":"Características da tabela de preço."},"cOrigem":{"type":"string","maxLength":3,"description":"Origem da Tabela de Preços.\nPode ser:\nPRD - Lê o preço do cadastro de produtos.\nCMC - Lê o preço do CMC do produto.\nTBL - Lê o preço de uma tabela específica informada na tag \"nCodOrigTab\"."}},"required":["cCodIntTabPreco","cNome","cOrigem"]}}},"example":{"call":"IncluirTabelaPreco","param":[{"cCodIntTabPreco":"TP1790776581","cNome":"","cCodigo":"","cOrigem":"","produtos":{"cTodosProdutos":"S","nCodFamilia":0,"cNCM":"","nCodCaract":0,"cConteudo":"","nCodFornec":0},"clientes":{"cTodosClientes":"S","nCodTag":0,"cTag":"","cUF":""},"outrasInfo":{"nCodOrigTab":0,"nPercAcrescimo":0,"nPercDesconto":0},"caracteristicas":{"cTemValidade":"S","dDtInicial":"30/09/2026","dDtFinal":"30/09/2026","cTemDesconto":"","nDescSugerido":0,"nPercDescMax":0,"cArredPreco":"N"}}]}},"produtos_tabelaprecos_IncluirTabelaPreco_retorno":{"type":"object","properties":{"nCodTabPreco":{"type":"integer","description":"Código da Tabela de Preços. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da Tabela de Preços gerado pelo Omie."},"cCodIntTabPreco":{"type":"string","description":"Código de integração da Tabela de Preços. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código da Tabela de Preços utilizado no seu aplicativo quando incluir uma Tabela de Preços no Omie. Assim, poderá utilizar esse campo para resgatar as informações da Tabela de Preços desejada. Caso informe esse campo, não informe a tag nCodTabPreco. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro duranteo o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodigoStatus\"."}},"title":"IncluirTabelaPreco (retorno)"},"produtos_tabelaprecos_ListarTabelaItens":{"type":"object","title":"ListarTabelaItens","description":"Lista os itens de uma tabela de preços.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarTabelaItens"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página que se deseja resgatar.\nO padrão é \"1\"."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Número de registros retornados por página.\nO padrão é 20.\nO limite máximo é 50 por página."},"cOrdenarPor":{"type":"string","maxLength":100,"description":"Ordem os resultados da página por:\nCODIGO - Código da Tabela de Preço.\nCODINT - Código de Integração da Tabela de Preço.\nNOME - Nome da Tabela de Preço."},"cOrdemDecrescente":{"type":"string","maxLength":1,"description":"Indica se a ordem de exibição é Decrescente caso seja informado \"S\"."},"nCodTabPreco":{"type":"integer","maxLength":15,"description":"Código da Tabela de Preços.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno da Tabela de Preços gerado pelo Omie."},"cCodIntTabPreco":{"type":"string","maxLength":20,"description":"Código de integração da Tabela de Preços.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código da Tabela de Preços utilizado no seu aplicativo quando incluir uma Tabela de Preços no Omie."},"dDtIncDe":{"type":"string","maxLength":10,"description":"Data de inclusão inicial.\nNo formato dd/mm/aaaa."},"dDtIncAte":{"type":"string","maxLength":10,"description":"Data de inclusão final.\nNo formato dd/mm/aaaa."},"dDtAltDe":{"type":"string","maxLength":10,"description":"Data de alteração inicial.\nNo formato dd/mm/aaaa."},"dDtAltAte":{"type":"string","maxLength":10,"description":"Data de alteração final.\nNo formato dd/mm/aaaa."},"lApenasItens":{"type":"boolean","description":"Filtrar apenas itens que tiveram alteração no período definido entre dDtAltDe e dDtAltAte.\n\nAtivando esse filtro, não serão consideradas alterações no cabeçalho da Tabela de Preços."},"cApenasFixado":{"type":"string","maxLength":1,"description":"Indica se deve retornar apenas itens que foram modificados manualmente (S/N)."}}}}},"example":{"call":"ListarTabelaItens","param":[{"nPagina":1,"nRegPorPagina":20,"nCodTabPreco":0,"cCodIntTabPreco":""}]}},"produtos_tabelaprecos_ListarTabelaItens_retorno":{"type":"object","properties":{"nPagina":{"type":"integer","description":"Número da página resgatada."},"nTotPaginas":{"type":"integer","description":"Número total de páginas encontradas."},"nRegistros":{"type":"integer","description":"Número de registros retornados na página."},"nTotRegistros":{"type":"integer","description":"Número total de registros encontrados."},"listaTabelaPreco":{"type":"object","properties":{"nCodTabPreco":{"type":"integer","description":"Código da Tabela de Preços. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da Tabela de Preços gerado pelo Omie."},"cCodIntTabPreco":{"type":"string","description":"Código de integração da Tabela de Preços. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código da Tabela de Preços utilizado no seu aplicativo quando incluir uma Tabela de Preços no Omie. Assim, poderá utilizar esse campo para resgatar as informações da Tabela de Preços desejada. Caso informe esse campo, não informe a tag nCodTabPreco. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"cNome":{"type":"string","description":"Nome da Tabela de Preço."},"cCodigo":{"type":"string","description":"Código da Tabela de Preço. (Exibido na tela do aplicativo)."},"cAtiva":{"type":"string","description":"Indica se a tabela de preços está ativa (S/N)."},"cOrigem":{"type":"string","description":"Origem da Tabela de Preços. Pode ser: PRD - Lê o preço do cadastro de produtos. CMC - Lê o preço do CMC do produto. TBL - Lê o preço de uma tabela específica informada na tag \"nCodOrigTab\"."},"itensTabela":{"type":"array","items":{"type":"object","properties":{"nCodProd":{"type":"integer","description":"Código do produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do produto gerado pelo Omie."},"cCodIntProd":{"type":"string","description":"Código de integração do produto. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código utilizado no seu aplicativo quando incluir um produto no Omie. Assim, poderá utilizá-lo para resgatar as informações do produto desejado. Caso informe esse campo, não informe a tag nCodProd. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"cCodigoProduto":{"type":"string","description":"Código do produto. (Exibido na tela do aplicativo)."},"cDescricaoProduto":{"type":"string","description":"Descrição do produto."},"cNCM":{"type":"string","description":"Código do NCM. No formato 9999.99.99."},"cEAN":{"type":"string","description":"EAN do produto."},"nCodFamilia":{"type":"integer","description":"Código da Familia do Produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da família gerado pelo Omie."},"cArredPreco":{"type":"string","description":"Indica se deve Arredondar o preço do produto (S/N)."},"cTemDesconto":{"type":"string","description":"Indica se a Tabela de Preço possui Desconto Sugerido ou Máximo (S/N)."},"nDescMaximo":{"type":"decimal","description":"Percentual de Desconto Máximo Permitido."},"nDescSugerido":{"type":"decimal","description":"Percentual de Desconto Sugerido."},"cManual":{"type":"string","description":"Indica se o item foi modificado Manualmente (S/N)."},"nPercDesconto":{"type":"decimal","description":"Percentual de Desconto da tabela de preços."},"nPercAcrescimo":{"type":"decimal","description":"Percentual de Acréscimo da tabela de preços."},"nValorCalculado":{"type":"decimal","description":"Valor Calculado."},"nValorOriginal":{"type":"decimal","description":"Valor Original."},"nValorTabela":{"type":"decimal","description":"Valor da Tabela de Preços."},"itemInfo":{"type":"object","properties":{"dIncItem":{"type":"string","description":"Data da Inclusão. No formato dd/mm/aaaa."},"hIncItem":{"type":"string","description":"Hora da Inclusão. No formato hh:mm:ss."},"uIncItem":{"type":"string","description":"Usuário da Inclusão."},"dAltItem":{"type":"string","description":"Data da Alteração. No formato dd/mm/aaaa."},"hAltItem":{"type":"string","description":"Hora da Alteração. No formato hh:mm:ss."},"uAltItem":{"type":"string","description":"Usuário da Alteração."},"cImpAPIItem":{"type":"string","description":"Importado pela API (S/N)."}},"description":"Informações do cadastro do item."}}},"description":"Itens da Tabela de Preços."}},"description":"Tabela de preço com itens."}},"title":"ListarTabelaItens (retorno)"},"produtos_tabelaprecos_ListarTabelasPreco":{"type":"object","title":"ListarTabelasPreco","description":"Lista as tabelas de preço cadastradas.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarTabelasPreco"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página que se deseja resgatar.\nO padrão é \"1\"."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Número de registros retornados por página.\nO padrão é 20.\nO limite máximo é 50 por página."},"cOrdenarPor":{"type":"string","maxLength":100,"description":"Ordem os resultados da página por:\nCODIGO - Código da Tabela de Preço.\nCODINT - Código de Integração da Tabela de Preço.\nNOME - Nome da Tabela de Preço."},"cOrdemDecrescente":{"type":"string","maxLength":1,"description":"Indica se a ordem de exibição é Decrescente caso seja informado \"S\"."},"dDtIncDe":{"type":"string","maxLength":10,"description":"Data de inclusão inicial.\nNo formato dd/mm/aaaa."},"dDtIncAte":{"type":"string","maxLength":10,"description":"Data de inclusão final.\nNo formato dd/mm/aaaa."},"dDtAltDe":{"type":"string","maxLength":10,"description":"Data de alteração inicial.\nNo formato dd/mm/aaaa."},"dDtAltAte":{"type":"string","maxLength":10,"description":"Data de alteração final.\nNo formato dd/mm/aaaa."},"nCodTag":{"type":"integer","maxLength":15,"description":"Considerar apenas os clientes de uma determinada Tag.\nSerá ignorado caso o campo \"cTodosClientes\" estiver preenhido com \"S\"."}}}}},"example":{"call":"ListarTabelasPreco","param":[{"nPagina":1,"nRegPorPagina":20}]}},"produtos_tabelaprecos_ListarTabelasPreco_retorno":{"type":"object","properties":{"nPagina":{"type":"integer","description":"Número da página resgatada."},"nTotPaginas":{"type":"integer","description":"Número total de páginas encontradas."},"nRegistros":{"type":"integer","description":"Número de registros retornados na página."},"nTotRegistros":{"type":"integer","description":"Número total de registros encontrados."},"listaTabelasPreco":{"type":"array","items":{"type":"object","properties":{"nCodTabPreco":{"type":"integer","description":"Código da Tabela de Preços. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da Tabela de Preços gerado pelo Omie."},"cCodIntTabPreco":{"type":"string","description":"Código de integração da Tabela de Preços. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código da Tabela de Preços utilizado no seu aplicativo quando incluir uma Tabela de Preços no Omie. Assim, poderá utilizar esse campo para resgatar as informações da Tabela de Preços desejada. Caso informe esse campo, não informe a tag nCodTabPreco. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"cNome":{"type":"string","description":"Nome da Tabela de Preço."},"cCodigo":{"type":"string","description":"Código da Tabela de Preço. (Exibido na tela do aplicativo)."},"cAtiva":{"type":"string","description":"Indica se a tabela de preços está ativa (S/N)."},"cOrigem":{"type":"string","description":"Origem da Tabela de Preços. Pode ser: PRD - Lê o preço do cadastro de produtos. CMC - Lê o preço do CMC do produto. TBL - Lê o preço de uma tabela específica informada na tag \"nCodOrigTab\"."},"produtos":{"type":"object","properties":{"cTodosProdutos":{"type":"string","description":"Considerar todos os produtos nesta tabela de preços? (S/N) O padrão é \"S\". Quando informar \"S\", todos os demais campos deste grupo serão desconsiderados. Caso informe \"N\", pelo menos 1 dos campos deste grupo deverá ser informado."},"nCodFamilia":{"type":"integer","description":"Código da família. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da família gerado pelo Omie. Será ignorado caso o campo \"cTodosProdutos\" estiver preenhido com \"S\"."},"cNCM":{"type":"string","description":"Código do NCM. No formato 9999.99.99 Será ignorado caso o campo \"cTodosProdutos\" estiver preenhido com \"S\"."},"nCodCaract":{"type":"integer","description":"Código da característica de produto. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da característica do produto gerado pelo Omie. Será ignorado caso o campo \"cTodosProdutos\" estiver preenhido com \"S\"."},"cConteudo":{"type":"string","description":"Conteúdo da característica. Será ignorado caso o campo \"cTodosProdutos\" estiver preenhido com \"S\"."},"nCodFornec":{"type":"integer","description":"Código do fornecedor. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno do fornecedor gerado pelo Omie. Será ignorado caso o campo \"cTodosProdutos\" estiver preenhido com \"S\"."}},"description":"Dados dos filtros por produto."},"clientes":{"type":"object","properties":{"cTodosClientes":{"type":"string","description":"Considerar todos os clientes nesta tabela de preços? (S/N) O padrão é \"S\". Quando informar \"S\", todos os demais campos deste grupo serão desconsiderados. Caso informe \"N\", pelo menos 1 dos campos deste grupo deverá ser informado."},"nCodTag":{"type":"integer","description":"Considerar apenas os clientes de uma determinada Tag. Será ignorado caso o campo \"cTodosClientes\" estiver preenhido com \"S\"."},"cTag":{"type":"string","description":"Descrição da tag do cliente informada no campo nCodTag. O conteúdo deste campo é apenas informativo e não tem efeito na inclusão. Na inclusão utilize a tag \"nCodTag\"."},"cUF":{"type":"string","description":"Considerar apenas os clientes do Estado. Será ignorado caso o campo \"cTodosClientes\" estiver preenhido com \"S\"."}},"description":"Dados dos filtros do cliente."},"outrasInfo":{"type":"object","properties":{"nCodOrigTab":{"type":"integer","description":"Código da Tabela de Preço Original."},"nPercAcrescimo":{"type":"decimal","description":"Percentual de Acréscimo da tabela de preços."},"nPercDesconto":{"type":"decimal","description":"Percentual de Desconto da tabela de preços."}},"description":"Outros filtros da tabela de preços."},"caracteristicas":{"type":"object","properties":{"cTemValidade":{"type":"string","description":"Indica se a Tabela de Preço possui Validade (S/N)."},"dDtInicial":{"type":"string","description":"Data Inicial da Validade da Tabela de Preço. No formato dd/mm/aaaa."},"dDtFinal":{"type":"string","description":"Data Final de Validade Tabela de Preço. No formato dd/mm/aaaa."},"cTemDesconto":{"type":"string","description":"Indica se a Tabela de Preço possui Desconto Sugerido ou Máximo (S/N)."},"nDescSugerido":{"type":"decimal","description":"Percentual de Desconto Sugerido."},"nPercDescMax":{"type":"decimal","description":"Percentual de Desconto Máximo Permitido."},"cArredPreco":{"type":"string","description":"Indica se deve Arredondar o preço dos produtos (S/N)."}},"description":"Características da tabela de preço."},"info":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão. No formato dd/mm/aaaa."},"hInc":{"type":"string","description":"Hora da Inclusão. No formato hh:mm:ss."},"uInc":{"type":"string","description":"Usuário da Inclusão."},"dAlt":{"type":"string","description":"Data da Alteração. No formato dd/mm/aaaa."},"hAlt":{"type":"string","description":"Hora da Alteração. No formato hh:mm:ss."},"uAlt":{"type":"string","description":"Usuário da Alteração."},"cImpAPI":{"type":"string","description":"Importado pela API (S/N)."}},"description":"Informações do cadastro da tabela de preços."}}},"description":"Lista das tabelas de preço."}},"title":"ListarTabelasPreco (retorno)"},"produtos_tabelaprecos_SuspenderTabelaPreco":{"type":"object","title":"SuspenderTabelaPreco","description":"Suspende uma tabela de preços.","required":["call","param"],"properties":{"call":{"type":"string","enum":["SuspenderTabelaPreco"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodTabPreco":{"type":"integer","maxLength":15,"description":"Código da Tabela de Preços.\n(Interno, utilizado apenas na integração via API, não é exibido na tela).\nO conteúdo desse campo é o código interno da Tabela de Preços gerado pelo Omie."},"cCodIntTabPreco":{"type":"string","maxLength":20,"description":"Código de integração da Tabela de Preços.\n(Interno, utilizado apenas na Integração via API, não aparece na tela).\nUtilize esse campo para informar o código da Tabela de Preços utilizado no seu aplicativo quando incluir uma Tabela de Preços no Omie.\nAssim, poderá utilizar esse campo para resgatar as informações da Tabela de Preços desejada.\nCaso informe esse campo, não informe a tag nCodTabPreco. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."}}}}},"example":{"call":"SuspenderTabelaPreco","param":[{"nCodTabPreco":0,"cCodIntTabPreco":""}]}},"produtos_tabelaprecos_SuspenderTabelaPreco_retorno":{"type":"object","properties":{"nCodTabPreco":{"type":"integer","description":"Código da Tabela de Preços. (Interno, utilizado apenas na integração via API, não é exibido na tela). O conteúdo desse campo é o código interno da Tabela de Preços gerado pelo Omie."},"cCodIntTabPreco":{"type":"string","description":"Código de integração da Tabela de Preços. (Interno, utilizado apenas na Integração via API, não aparece na tela). Utilize esse campo para informar o código da Tabela de Preços utilizado no seu aplicativo quando incluir uma Tabela de Preços no Omie. Assim, poderá utilizar esse campo para resgatar as informações da Tabela de Preços desejada. Caso informe esse campo, não informe a tag nCodTabPreco. Caso isso aconteça, o conteúdo dessa tag será desconsiderada."},"cCodStatus":{"type":"string","description":"Código do status do processamento. Se o retorno for \"0\" significa que a solicitação foi executada com sucesso. Se o retorno for maior que \"0\" ocorreu algum erro duranteo o processamento da solicitação. A tag \"cDesStatus\" descreve o problema ocorrido."},"cDesStatus":{"type":"string","description":"Descrição do status do processamento. Essa tag explica o resultado da tag \"cCodigoStatus\"."}},"title":"SuspenderTabelaPreco (retorno)"},"produtos_tpcalc_ListarTpCalc":{"type":"object","title":"ListarTpCalc","description":"Listar Tipo de Cálculo.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarTpCalc"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"ordenar_por":{"type":"string","maxLength":100,"description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."}}}}},"example":{"call":"ListarTpCalc","param":[{"pagina":1,"registros_por_pagina":50}]}},"produtos_tpcalc_ListarTpCalc_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada."},"total_de_paginas":{"type":"integer","description":"Número total de páginas."},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"Total de registros encontrados."},"cadastros":{"type":"array","items":{"type":"object","properties":{"nCodigo":{"type":"string","description":"Código do Tipo de Cálculo."},"cDescricao":{"type":"string","description":"Descrição do Tipo de Cálculo."}}},"description":"Lista os CSOSN do ICMS encontrados."}},"title":"ListarTpCalc (retorno)"},"produtos_variacao_ConsultarVariacoes":{"type":"object","title":"ConsultarVariacoes","description":"Método para realizar a consulta da variação da grade do produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarVariacoes"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodProd":{"type":"integer","maxLength":15,"description":"Código do produto.\nÉ o ID do produto e será utilizado apenas nas APIs como chave principal para localizar um produto.\n\nQuando um produto for incluído via API, você receberá um ID para esse novo produto.\nRecomendamos que você guarde essa informação no aplicativo que estiver integrando.\n\nUtilize a tag \"codigo_produto\" do método \"ListarProdutos\" da API\n/api/v1/geral/produtos/\npara obter essa informação."},"cCodIntProd":{"type":"string","maxLength":60,"description":"Código de integração do produto.\n\nEsse campo deve ser informado apenas se você incluiu o produto via API e informou um código de integração para o produto. Do contrário, informe sempre a tag \"nCodProd\"."}}}}},"example":{"call":"ConsultarVariacoes","param":[{"nCodProd":0,"cCodIntProd":""}]}},"produtos_variacao_ConsultarVariacoes_retorno":{"type":"object","properties":{"ident":{"type":"object","properties":{"nCodProd":{"type":"integer","description":"Código do produto. É o ID do produto e será utilizado apenas nas APIs como chave principal para localizar um produto. Quando um produto for incluído via API, você receberá um ID para esse novo produto. Recomendamos que você guarde essa informação no aplicativo que estiver integrando. Utilize a tag \"codigo_produto\" do método \"ListarProdutos\" da API /api/v1/geral/produtos/ para obter essa informação."},"cCodIntProd":{"type":"string","description":"Código de integração do produto. Esse campo deve ser informado apenas se você incluiu o produto via API e informou um código de integração para o produto. Do contrário, informe sempre a tag \"nCodProd\"."},"cCodProduto":{"type":"string","description":"Código do Produto exibido na tela de Produtos."},"cDescrProduto":{"type":"string","description":"Descrição do produto. Descrição do nome do produto no Omie."}},"description":"Identificação do Produto."},"variacoes":{"type":"array","items":{"type":"object","properties":{"nIdVariacao":{"type":"integer","description":"Id da variação. Id criado para integrar com a característica do produto."},"nIdProdVariacao":{"type":"integer","description":"Id do produto variação. Id do produto criado pelas características selecionadas."},"cDescProdVariacao":{"type":"string","description":"Descrição do produto variação ."},"CaractVariacoes":{"type":"array","items":{"type":"object","properties":{"nIdCaract":{"type":"integer","description":"Id da Característica."},"cNomeCaract":{"type":"string","description":"Nome da característica variante."},"cConteudoCaract":{"type":"integer","description":"Conteúdo da característica."}}},"description":"Características das variações."}}},"description":"Conjunto de variações do produto."}},"title":"ConsultarVariacoes (retorno)"},"produtos_variacao_IncluirVariacoes":{"type":"object","title":"IncluirVariacoes","description":"Método para realizar a inclusão da variação da grade do produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirVariacoes"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodProd":{"type":"integer","maxLength":15,"description":"Código do produto.\nÉ o ID do produto e será utilizado apenas nas APIs como chave principal para localizar um produto.\n\nQuando um produto for incluído via API, você receberá um ID para esse novo produto.\nRecomendamos que você guarde essa informação no aplicativo que estiver integrando.\n\nUtilize a tag \"codigo_produto\" do método \"ListarProdutos\" da API\n/api/v1/geral/produtos/\npara obter essa informação."},"cCodIntProd":{"type":"string","maxLength":60,"description":"Código de integração do produto.\n\nEsse campo deve ser informado apenas se você incluiu o produto via API e informou um código de integração para o produto. Do contrário, informe sempre a tag \"nCodProd\"."},"aCaracteristicas":{"type":"array","items":{"type":"object","properties":{"nIdCaract":{"type":"integer","maxLength":15,"description":"Id da característica."}},"required":["nIdCaract"]},"description":"Lista com as característica para a criação da variação do produto.\n\n\nÉ permitido informar no máximo 2 características."},"aVariacoes":{"type":"array","items":{"type":"object","properties":{"nCodProdAssoc":{"type":"integer","maxLength":15,"description":"Código do produto a ser associado a essa variação.\n\nCaso informado, não será gerado um novo produto variação e sim, associado a esse produto informado."},"cDescrProduto":{"type":"string","maxLength":120,"description":"Descrição do produto variação.\n\nQuando informado, essa descrição será alocada ao novo produto gerado."},"cCodProduto":{"type":"string","maxLength":60,"description":"Código do produto variação.\n\nQuando informado, esse código será alocado ao novo produto gerado."},"aValoresCaracteristicas":{"type":"array","items":{"type":"object","properties":{"nIdCaract":{"type":"integer","maxLength":15,"description":"Id da característica."},"nIdValor":{"type":"integer","maxLength":15,"description":"Id do valor da característica."}},"required":["nIdCaract","nIdValor"]}}}},"description":"Configuração manual da variação do produto.\n\n\nDeve ser preenchido apenas quando deseja informar manualmente as variações do produto."}}}}},"example":{"call":"IncluirVariacoes","param":[{"nCodProd":0,"cCodIntProd":"","aCaracteristicas":[{"nIdCaract":0}],"aVariacoes":[{"nCodProdAssoc":0,"cDescrProduto":"","cCodProduto":"","aValoresCaracteristicas":[{"nIdCaract":0,"nIdValor":0}]}]}]}},"produtos_variacao_IncluirVariacoes_retorno":{"type":"object","properties":{"cCodStatus":{"type":"string","description":"Identificação do Produto."},"cDesStatus":{"type":"string"}},"title":"IncluirVariacoes (retorno)"},"produtos_variacao_ListarVariacoes":{"type":"object","title":"ListarVariacoes","description":"Método para realizar a listagem das variações de grade do produto.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarVariacoes"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15},"nRegPorPagina":{"type":"integer","maxLength":15},"cFiltrarPorDataDe":{"type":"string","maxLength":10,"description":"Informe aqui a data de início do filtro."},"cFiltrarPorDataAte":{"type":"string","maxLength":10,"description":"Informe aqui a data de início do filtro."},"cFiltrarApenasInclusao":{"type":"string","maxLength":1,"example":"S","description":"Filtrar apenas registros incluídos para a data.\n\n(S/N)."},"cFiltrarApenasAlteracao":{"type":"string","maxLength":1,"example":"S","description":"Filtrar apenas registros alterados para a data.\n\n(S/N)."},"cExibirCaracteristicas":{"type":"string","maxLength":1,"description":"Campo S/N para filtrar as características das variacoes."}}}}},"example":{"call":"ListarVariacoes","param":[{"nPagina":1,"nRegPorPagina":50}]}},"produtos_variacao_ListarVariacoes_retorno":{"type":"object","properties":{"nPagina":{"type":"integer","description":"Número da página que será listada."},"nTotPaginas":{"type":"integer","description":"Total de páginas encontradas."},"nRegistros":{"type":"integer","description":"Número de registros retornados."},"nTotRegistros":{"type":"integer","description":"Número total de registros."},"listaVariacoes":{"type":"array","items":{"type":"object","properties":{"ident":{"type":"object","properties":{"nCodProd":{"type":"integer","description":"Código do produto. É o ID do produto e será utilizado apenas nas APIs como chave principal para localizar um produto. Quando um produto for incluído via API, você receberá um ID para esse novo produto. Recomendamos que você guarde essa informação no aplicativo que estiver integrando. Utilize a tag \"codigo_produto\" do método \"ListarProdutos\" da API /api/v1/geral/produtos/ para obter essa informação."},"cCodIntProd":{"type":"string","description":"Código de integração do produto. Esse campo deve ser informado apenas se você incluiu o produto via API e informou um código de integração para o produto. Do contrário, informe sempre a tag \"nCodProd\"."},"cCodProduto":{"type":"string","description":"Código do Produto exibido na tela de Produtos."},"cDescrProduto":{"type":"string","description":"Descrição do produto. Descrição do nome do produto no Omie."}},"description":"Identificação do Produto."},"variacoes":{"type":"array","items":{"type":"object","properties":{"nIdVariacao":{"type":"integer","description":"Id da variação. Id criado para integrar com a característica do produto."},"nIdProdVariacao":{"type":"integer","description":"Id do produto variação. Id do produto criado pelas características selecionadas."},"cDescProdVariacao":{"type":"string","description":"Descrição do produto variação ."},"CaractVariacoes":{"type":"array","items":{"type":"object","properties":{"nIdCaract":{"type":"integer","description":"Id da Característica."},"cNomeCaract":{"type":"string","description":"Nome da característica variante."},"cConteudoCaract":{"type":"integer","description":"Conteúdo da característica."}}},"description":"Características das variações."}}},"description":"Informação das variações do produto."}}},"description":"Informações das variações."}},"title":"ListarVariacoes (retorno)"},"produtos_vendasresumo_ObterResumoProdutos":{"type":"object","title":"ObterResumoProdutos","description":"Obtem o resumo das vendas de produtos.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterResumoProdutos"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"dDataInicio":{"type":"string","maxLength":10,"description":"Data Inicial de Consulta."},"dDataFim":{"type":"string","maxLength":10,"description":"Data final de Consulta."},"lApenasResumo":{"type":"boolean","description":"Exibir apenas o resumo.\n\nQuando true será retornado as estruturas:\n\nFaturamentoResumo\npedidoVenda->faturarHoje\npropostaVenda->faturarHoje\n\nQuando false retornará todas as estruturas.\n\nDefault = true."}}}}},"example":{"call":"ObterResumoProdutos","param":[{"dDataInicio":"30/09/2026","dDataFim":"30/09/2026","lApenasResumo":true}]}},"produtos_vendasresumo_ObterResumoProdutos_retorno":{"type":"object","properties":{"dDataInicio":{"type":"string","description":"Data Inicial de Consulta."},"dDataFim":{"type":"string","description":"Data final de Consulta."},"painelNfeVenda":{"type":"object","properties":{"emitidasEmpresaNfe":{"type":"object","properties":{"cVisualizar":{"type":"string","description":"Indica se o aplicativo possuí a configuração desse tipo de documento. Pode ser: S N."},"saidaNfe":{"type":"object","properties":{"nFaturadas":{"type":"decimal","description":"Quantidade faturada."},"vFaturadas":{"type":"decimal","description":"Valor faturado."},"nCanceladas":{"type":"decimal","description":"Quantidade cancelada."},"vCanceladas":{"type":"decimal","description":"Valor cancelado."},"nPendentes":{"type":"decimal","description":"Quantidade pendente."},"vPendentes":{"type":"decimal","description":"Valor pendente."},"nRejeitadas":{"type":"decimal","description":"Quantidade rejeitada."},"vRejeitadas":{"type":"decimal","description":"Valor rejeitado."},"nTotal":{"type":"decimal","description":"Quantidade total."},"vTotal":{"type":"decimal","description":"Valor total."}},"description":"Exibe os totais de faturamentos das Notas Fiscais (NF-e) de saída."},"cIcone":{"type":"string"},"cCor":{"type":"string"},"cIconeFat":{"type":"string"},"cCorFat":{"type":"string"},"cIconeCanc":{"type":"string"},"cCorCanc":{"type":"string"},"cIconeRej":{"type":"string"},"cCorRej":{"type":"string"},"cIconePend":{"type":"string"},"cCorPend":{"type":"string"}},"description":"Exibe os totais de faturamentos das Notas Fiscais (NF-e) emitidas pela própria empresa."}},"description":"Exibe os totais de faturamentos de Notas Fiscais. (NF-e)."},"painelCteVenda":{"type":"object","properties":{"emitidasEmpresaCte":{"type":"object","properties":{"cVisualizar":{"type":"string","description":"Indica se o aplicativo possuí a configuração desse tipo de documento. Pode ser: S N."},"saidaCte":{"type":"object","properties":{"nFaturadas":{"type":"decimal","description":"Quantidade faturada."},"vFaturadas":{"type":"decimal","description":"Valor faturado."},"nCanceladas":{"type":"decimal","description":"Quantidade cancelada."},"vCanceladas":{"type":"decimal","description":"Valor cancelado."},"nPendentes":{"type":"decimal","description":"Quantidade pendente."},"vPendentes":{"type":"decimal","description":"Valor pendente."},"nTotal":{"type":"decimal","description":"Quantidade total."},"vTotal":{"type":"decimal","description":"Valor total."}},"description":"Exibe os totais de faturamentos dos Conhecimentos de Transporte (CT-e) de saída."},"cIcone":{"type":"string"},"cCor":{"type":"string"},"cIconeFat":{"type":"string"},"cCorFat":{"type":"string"},"cIconeCanc":{"type":"string"},"cCorCanc":{"type":"string"},"cIconePend":{"type":"string"},"cCorPend":{"type":"string"}},"description":"Exibe os totais de faturamentos dos Conhecimentos de Transporte (CT-e) emitidos pela própria empresa."}},"description":"Exibe os totais de faturamentos de Conhecimentos de Transporte de saída. (CT-e)."},"painelCfeSat":{"type":"object","properties":{"nFaturadas":{"type":"decimal","description":"Quantidade faturada."},"vFaturadas":{"type":"decimal","description":"Valor faturado."},"nCanceladas":{"type":"decimal","description":"Quantidade cancelada."},"vCanceladas":{"type":"decimal","description":"Valor cancelado."},"nTotal":{"type":"decimal","description":"Quantidade total."},"vTotal":{"type":"decimal","description":"Valor total."},"pagamentos":{"type":"object","properties":{"vDinheiro":{"type":"decimal","description":"Total faturado em Dinheiro."},"vCartao":{"type":"decimal","description":"Total faturado em Cartão."},"vCheque":{"type":"decimal","description":"Total faturado em Cheque."},"vAprazo":{"type":"decimal","description":"Total faturado a Prazo."},"vOutros":{"type":"decimal","description":"Total faturado Outras formas de pagamento."}}},"cIcone":{"type":"string"},"cCor":{"type":"string"}},"description":"Exibe os totais de faturamentos de Cupons Fiscais Eletrônicos. (CFe-SAT)."},"painelNfce":{"type":"object","properties":{"nFaturadas":{"type":"decimal","description":"Quantidade faturada."},"vFaturadas":{"type":"decimal","description":"Valor faturado."},"nCanceladas":{"type":"decimal","description":"Quantidade cancelada."},"vCanceladas":{"type":"decimal","description":"Valor cancelado."},"nTotal":{"type":"decimal","description":"Quantidade total."},"vTotal":{"type":"decimal","description":"Valor total."},"pagamentos":{"type":"object","properties":{"vDinheiro":{"type":"decimal","description":"Total faturado em Dinheiro."},"vCartao":{"type":"decimal","description":"Total faturado em Cartão."},"vCheque":{"type":"decimal","description":"Total faturado em Cheque."},"vAprazo":{"type":"decimal","description":"Total faturado a Prazo."},"vOutros":{"type":"decimal","description":"Total faturado Outras formas de pagamento."}}},"cIcone":{"type":"string"},"cCor":{"type":"string"}},"description":"Exibe os totais de faturamentos de Notas Fiscais de Consumidor Eletrônica. (NFC-e)."},"painelCupom":{"type":"object","properties":{"nFaturadas":{"type":"decimal","description":"Quantidade faturada."},"vFaturadas":{"type":"decimal","description":"Valor faturado."},"nCanceladas":{"type":"decimal","description":"Quantidade cancelada."},"vCanceladas":{"type":"decimal","description":"Valor cancelado."},"nTotal":{"type":"decimal","description":"Quantidade total."},"vTotal":{"type":"decimal","description":"Valor total."},"pagamentos":{"type":"object","properties":{"vDinheiro":{"type":"decimal","description":"Total faturado em Dinheiro."},"vCartao":{"type":"decimal","description":"Total faturado em Cartão."},"vCheque":{"type":"decimal","description":"Total faturado em Cheque."},"vAprazo":{"type":"decimal","description":"Total faturado a Prazo."},"vOutros":{"type":"decimal","description":"Total faturado Outras formas de pagamento."}}},"cIcone":{"type":"string"},"cCor":{"type":"string"}},"description":"Exibe os totais de faturamentos de Cupons Fiscais. (ECF)."},"faturamentoCupomResumo":{"type":"object","properties":{"cVisualizar":{"type":"string","description":"Indica se o aplicativo possuí a configuração desse tipo de documento. Pode ser: S N."},"nFaturadas":{"type":"decimal","description":"Quantidade faturada."},"vFaturadas":{"type":"decimal","description":"Valor faturado."},"cIconeFat":{"type":"string"},"cCorFat":{"type":"string"},"nCanceladas":{"type":"decimal","description":"Quantidade cancelada."},"vCanceladas":{"type":"decimal","description":"Valor cancelado."},"cIconeCanc":{"type":"string"},"cCorCanc":{"type":"string"},"nPendentes":{"type":"decimal","description":"Quantidade pendente."},"vPendentes":{"type":"decimal","description":"Valor pendente."},"cIconePend":{"type":"string"},"cCorPend":{"type":"string"},"nContingencia":{"type":"decimal","description":"Quantidade em contigência."},"vContingencia":{"type":"decimal","description":"Valor em contigência."},"cIconeCont":{"type":"string"},"cCorCont":{"type":"string"},"nTotal":{"type":"decimal","description":"Quantidade total."},"vTotal":{"type":"decimal","description":"Valor total."}},"description":"Resumo do faturamento de cupons (ECF + SAT + NFC-e)."},"propostaVenda":{"type":"object","properties":{"cVisualizar":{"type":"string","description":"Indica se o aplicativo possuí a configuração desse tipo de documento. Pode ser: S N."},"cNome":{"type":"string","description":"Descrição da operação (Proposta / Pedido de venda)."},"cNomePlural":{"type":"string","description":"Descrição da operação no plural (Proposta / Pedido de venda)."},"emAberto":{"type":"object","properties":{"nTotal":{"type":"decimal","description":"Quantidade total."},"vTotal":{"type":"decimal","description":"Valor total."}},"description":"Estrutura contendo os valores em aberto."},"cIcone":{"type":"string"},"cCor":{"type":"string"}},"description":"Exibe os totais das propostas de venda de produtos."},"pedidoVenda":{"type":"object","properties":{"cNome":{"type":"string","description":"Descrição da operação (Proposta / Pedido de venda)."},"cNomePlural":{"type":"string","description":"Descrição da operação no plural (Proposta / Pedido de venda)."},"emAberto":{"type":"object","properties":{"nTotal":{"type":"decimal","description":"Quantidade total."},"vTotal":{"type":"decimal","description":"Valor total."}},"description":"Estrutura contendo os valores em aberto."},"cIconePed":{"type":"string"},"cCorPed":{"type":"string"},"faturarHoje":{"type":"object","properties":{"nTotal":{"type":"decimal","description":"Quantidade total."},"vTotal":{"type":"decimal","description":"Valor total."}},"description":"Exibe os totais com o faturamento previsto para hoje."},"cIconeHoje":{"type":"string"},"cCorHoje":{"type":"string"},"cIcone":{"type":"string"},"cCor":{"type":"string"},"nFaturadas":{"type":"decimal","description":"Quantidade faturada."},"vFaturadas":{"type":"decimal","description":"Valor faturado."},"nCanceladas":{"type":"decimal","description":"Quantidade cancelada."},"vCanceladas":{"type":"decimal","description":"Valor cancelado."},"nRejeitadas":{"type":"decimal","description":"Quantidade rejeitada."},"vRejeitadas":{"type":"decimal","description":"Valor rejeitado."}},"description":"Exibe os totais de venda de produtos."},"faturamentoResumo":{"type":"object","properties":{"nFaturadas":{"type":"decimal","description":"Quantidade faturada."},"vFaturadas":{"type":"decimal","description":"Valor faturado."},"cIconeFat":{"type":"string"},"cCorFat":{"type":"string"},"nCanceladas":{"type":"decimal","description":"Quantidade cancelada."},"vCanceladas":{"type":"decimal","description":"Valor cancelado."},"cIconeCanc":{"type":"string"},"cCorCanc":{"type":"string"},"nPendentes":{"type":"decimal","description":"Quantidade pendente."},"vPendentes":{"type":"decimal","description":"Valor pendente."},"cIconePend":{"type":"string"},"cCorPend":{"type":"string"},"nRejeitadas":{"type":"decimal","description":"Quantidade rejeitada."},"vRejeitadas":{"type":"decimal","description":"Valor rejeitado."},"cIconeRej":{"type":"string"},"cCorRej":{"type":"string"},"nTotal":{"type":"decimal","description":"Quantidade total."},"vTotal":{"type":"decimal","description":"Valor total."},"cIcone":{"type":"string"},"cCor":{"type":"string"}},"description":"Exibe os totais de faturamentos (NF-e + NFC-e + CF-e-SAT + ECF + CT-e)."}},"title":"ObterResumoProdutos (retorno)"},"servicos_classificacaoservico_ListarClassificacaoServico":{"type":"object","title":"ListarClassificacaoServico","description":"Lista as classificações do serviço","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarClassificacaoServico"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"ordenar_por":{"type":"string","maxLength":100,"description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."}}}}},"example":{"call":"ListarClassificacaoServico","param":[{"pagina":1,"registros_por_pagina":20}]}},"servicos_classificacaoservico_ListarClassificacaoServico_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada"},"total_de_paginas":{"type":"integer","description":"Número total de páginas"},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"total de registros encontrados"},"cadastros":{"type":"array","items":{"type":"object","properties":{"cCodigo":{"type":"string","description":"Código da classificação do serviço"},"cDescricao":{"type":"string","description":"Descrição da classificação do serviço"}}},"description":"Lista os tipos de classificações do serviço."}},"title":"ListarClassificacaoServico (retorno)"},"servicos_contrato_AlterarContrato":{"type":"object","title":"AlterarContrato","description":"Alterar um Contrato","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarContrato"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cabecalho":{"type":"object","properties":{"nCodCtr":{"type":"integer","maxLength":15,"description":"Código do contrato de serviços.\n(Gerado internamente, não é visualizado na tela)"},"cCodIntCtr":{"type":"string","maxLength":20,"description":"Código de integração do contrato de serviços.\n(Utilizado em contratos criados via API, não é visualizado na tela)"},"nCodCli":{"type":"integer","maxLength":15,"description":"Código do cliente a que se refere o contrato de serviços.\n(Gerado internamente, não é visualizado na tela)"},"cNumCtr":{"type":"string","maxLength":60,"description":"Número do contrato de serviços.\n(Informado pelo usuário / visualizado na tela)"},"cCodSit":{"type":"string","maxLength":2,"description":"Código da situação do contrato de serviços.\nPode ser:\n00 - Em Elaboração\n10 - Ativo\n90 - Suspenso\n99 - Cancelado"},"dVigInicial":{"type":"string","maxLength":10,"description":"Data da vigência inicial do contrato de serviços."},"dVigFinal":{"type":"string","maxLength":10,"description":"Data de vigência final do contrato de serviços."},"nDiaFat":{"type":"integer","maxLength":2,"description":"Dia de faturamento."},"nValTotMes":{"type":"number","maxLength":18,"description":"Valor total mensal do contrato de serviços.\n(Calculado automaticamente)"},"cTipoFat":{"type":"string","maxLength":2,"description":"Tipo de Faturamento do Contrato.\nPode ser:\n01 - Todo Mês (mensal)\n02 - A cada 2 meses (bimestral)\n03 - A cada 3 meses (trimestral)\n06 - A cada 6 meses (semestral)\n12 - A cada 12 meses (anual)"}}},"departamentos":{"type":"array","items":{"type":"object","properties":{"cCodDep":{"type":"string","maxLength":40,"description":"Código do Departamento"},"cDesDep":{"type":"string","maxLength":50,"description":"Descrição do Departamento"},"nValDep":{"type":"number","maxLength":18,"description":"Valor do rateio"},"nPerDep":{"type":"number","maxLength":10,"description":"Percentual do rateio"}}},"description":"Distribuição por departamento"},"infAdic":{"type":"object","properties":{"cCodCateg":{"type":"string","maxLength":20,"description":"Código da Categoria"},"nCodVend":{"type":"integer","maxLength":15,"description":"Código do Vendedor"},"nCodProj":{"type":"integer","maxLength":15,"description":"Código do Projeto"},"nCodCC":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente"},"cContato":{"type":"string","maxLength":100,"description":"Nome do Contato"},"cCidPrestServ":{"type":"string","maxLength":40,"description":"Cidade da Prestação do Serviço e Estado"},"cCodObra":{"type":"string","maxLength":15,"description":"Código da Obra"},"cCodART":{"type":"string","maxLength":20,"description":"Código ART"},"cNumEncap":{"type":"string","maxLength":15,"description":"Código de Encapsulamento de notas dedutoras"},"cDadosAdicNF":{"type":"string","description":"Dados Adicionais para a Nota Fiscal"},"cUsoConsumo":{"type":"string","maxLength":1,"description":"Uso e consumo pessoal.\n\n(0=Não, 1=Sim)."},"nIdDestinatario":{"type":"integer","maxLength":15,"description":"ID Cliente para o Destinatário."}}},"vencTextos":{"type":"object","properties":{"cTpVenc":{"type":"string","maxLength":3,"description":"Tipo de Vencimento.\n\nPode ser:\n001-Número de dias após faturar.\n002-Fixar dia do mês (1 a 31)."},"nDias":{"type":"integer","maxLength":3,"description":"Número de Dias para a gerar o contas a receber"},"nDiaFixo":{"type":"integer","maxLength":2,"description":"Dia de vencimento fixo para a gerar o contas a receber"},"cProxMes":{"type":"string","maxLength":1,"description":"Define se o vencimento ocorrerá somente no mês seguinte."},"cAntecipar":{"type":"string","maxLength":1,"description":"Define se deve antecipar o vencimento ao considerar apenas dias úteis"},"cPostergar":{"type":"string","maxLength":1,"description":"Postergar Sábados, Domingos e Feriados Nacionais"},"cAdPeriodo":{"type":"string","maxLength":1,"description":"Adicionar o período de referência associado ao faturamento"},"cAdContrato":{"type":"string","maxLength":1,"description":"Adicionar o \"Nº do Contrato\" à descrição dos serviços na NFS-e"},"cAdVenc":{"type":"string","maxLength":1,"description":"Adicionar o vencimento da parcela à descrição dos serviços na NFS-e"},"cCodPerRef":{"type":"string","maxLength":3,"description":"Período de Referência - Código do período de referência para o faturamento.\n\nPode ser:\n001 Mês do faturamento\n002 Mês Anterior ao faturamento\n003 Mês Posterior ao faturamento\n004 Período Anterior ao faturamento\n005 Período Posterior ao faturamento\n006 Período Anterior específico\n007 Número da Parcela\n008 Período Posterior específico\n009 Período Atual específico"},"cDiaIni":{"type":"string","corrigido_pela_convencao":true,"maxLength":2,"description":"Dia Inicial - Dia para a data inicial do período de referência associado ao faturamentDia Inicial"},"cDiaFim":{"type":"string","corrigido_pela_convencao":true,"maxLength":2,"description":"Dia Final - Dia para a data final do período de referência associado ao faturamento"}}},"itensContrato":{"type":"array","items":{"type":"object","properties":{"itemCabecalho":{"type":"object","properties":{"codItem":{"type":"integer","maxLength":15,"description":"Identificação do Item do Contrato.\n\n(Gerado automaticamente na Inclusão do item do contrato)"},"codIntItem":{"type":"string","maxLength":30,"description":"Código de integração do item do contrato."},"seq":{"type":"integer","maxLength":4,"description":"Sequência do Item do Contrato."},"codServico":{"type":"integer","maxLength":15,"description":"Código Interno do Serviço conforme cadastrado na tabela de serviços.\n\n\nCaso preenchido, irá assumir as informações do cadastro de serviço.\n\nSe não for preenchido, assumirá os valores informados na API."},"natOperacao":{"type":"string","maxLength":2,"description":"Natureza da Operação ou Tipo de Tributação dos Serviços.\n\n\nCaso tenha informado a tag \"codServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço.\n\nValores pode variar de acordo com o município. Verifique a legislação da sua cidade para obter os tipos de tributação disponíveis."},"codServMunic":{"type":"string","maxLength":20,"description":"Código do Serviço Municipal ou CNAE.\n\n\nCaso tenha informado a tag \"codServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço.\n\nValores pode variar de acordo com o município. Verifique a legislação da sua cidade para obter os códigos de serviço disponíveis."},"codLC116":{"type":"string","maxLength":10,"description":"Código do Serviço conforme Lei Complementar (LC 116).\n\n\nCaso tenha informado a tag \"codServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço.\n\nTabela única para todos os municípios."},"quant":{"type":"number","maxLength":18,"description":"Quantidade de serviços.\n\n\nCaso tenha informado a tag \"codServico\" o preenchimento passa a ser opcional e irá assumir o valor padrão 1."},"valorUnit":{"type":"number","maxLength":18,"description":"Valor Unitário do serviço.\n\n\nCaso tenha informado a tag \"codServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço."},"cTpDesconto":{"type":"string","maxLength":1,"description":"Tipo de Desconto.\n\n\nPode ser:\nP - Percentual\nV - Valor"},"valorDesconto":{"type":"number","maxLength":18,"description":"Valor do Desconto."},"aliqDesconto":{"type":"number","maxLength":18,"description":"Aliquota do Desconto."},"valorOutrasRetencoes":{"type":"number","maxLength":18,"description":"Valor de Outras Retenções.\n\n\n(Disponível apenas para cidades que oferecem esse recurso.)"},"valorAcrescimo":{"type":"number","maxLength":18,"description":"Valor de Acréscimos e taxas.\n\n\n(Disponível apenas para cidades que oferecem esse recurso.)"},"codNBS":{"type":"string","maxLength":9,"description":"Código da Nomenclatura Brasileira de Serviços (NBS).\n\n\nCaso tenha informado a tag \"codServico\" irá assumir o valor informado no cadastro do respectivo serviço."},"cNaoGerarFinanceiro":{"type":"string","maxLength":1,"description":"Não gerar conta a receber para este item.\n\n\nInformar \"S\" para não gerar movimento financeiro.\nInformar \"N\" para gerar movimento financeiro."},"cCodCategItem":{"type":"string","maxLength":20,"description":"Código da Categoria."},"valorDed":{"type":"number","maxLength":18,"description":"Valor de Deduções.\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"valorTotal":{"type":"number","maxLength":18,"description":"Valor total do item.\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração."}}},"itemDescrServ":{"type":"object","properties":{"descrCompleta":{"type":"string","description":"Informe a descrição completa do serviço prestado"}}},"itemImpostos":{"type":"object","properties":{"aliqISS":{"type":"number","maxLength":10,"description":"Alíquota de ISS."},"valorISS":{"type":"number","maxLength":18,"description":"Valor do ISS.\n\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"retISS":{"type":"string","maxLength":1,"description":"Retém ISS  (S/N).\n\n\nIndica se o imposto deve ser retido ou não."},"cUtilizaValorImposto":{"type":"string","maxLength":1,"description":"Indica se o valor informado para os Impostos Federais deverá ser mantido ao invés de ser recalculado a partir da alíquota.\n\n\nAssim:\n\nCaso seja informado \"N\", indica que valor do imposto deve ser calculado a partir da alíquota e base de cálculo.\n\nCaso seja informado \"S\", indica que o valor do imposto será mantido e a alíquota será recalculada a partir do valor do imposto e base de cálculo."},"aliqIR":{"type":"number","maxLength":10,"description":"Alíquota de IR.\n\n\nPara o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\".\n\nLembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"valorIR":{"type":"number","maxLength":18,"description":"Valor do IR.\n\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\".\n\nCaso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"retIR":{"type":"string","maxLength":1,"description":"Retém IR  (S/N).\n\n\nIndica se o imposto deve ser retido ou não."},"aliqPIS":{"type":"number","maxLength":10,"description":"Alíquota de PIS.\n\n\nPara o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\".\n\nLembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"valorPIS":{"type":"number","maxLength":18,"description":"Valor do PIS.\n\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\".\n\nCaso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"retPIS":{"type":"string","maxLength":1,"description":"Retém PIS  (S/N).\n\n\nIndica se o imposto deve ser retido ou não."},"aliqCOFINS":{"type":"number","maxLength":10,"description":"Indica se o imposto foi alterado pelo usuário ou informado via importação de planilha ou API.\n\nEsse campo é preenchido automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"valorCOFINS":{"type":"number","maxLength":18,"description":"Alíquota de COFINS.\n\n\nPara o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\".\n\nLembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"retCOFINS":{"type":"string","maxLength":1,"description":"Retém COFINS  (S/N).\n\n\nIndica se o imposto deve ser retido ou não."},"aliqCSLL":{"type":"number","maxLength":10,"description":"Alíquota de CSLL.\n\nPara o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\".\n\nLembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"valorCSLL":{"type":"number","maxLength":18,"description":"Valor de CSLL.\n\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\".\n\nCaso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"retCSLL":{"type":"string","maxLength":1,"description":"Retém CSLL  (S/N).\n\n\nIndica se o imposto deve ser retido ou não."},"aliqINSS":{"type":"number","maxLength":10,"description":"Alíquota de INSS.\n\n\nPara o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\".\n\nLembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"valorINSS":{"type":"number","maxLength":18,"description":"Valor de INSS.\n\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\".\n\nCaso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"retINSS":{"type":"string","maxLength":1,"description":"Retém INSS  (S/N).\n\n\nIndica se o imposto deve ser retido ou não."},"redBaseINSS":{"type":"number","maxLength":10,"description":"Percentual de Redução da Base de Cálculo do INSS."},"redBasePIS":{"type":"number","maxLength":10,"description":"Percentual de Redução da Base de Cálculo do PIS."},"redBaseCOFINS":{"type":"number","maxLength":10,"description":"Percentual de Redução da Base de Cálculo do COFINS."},"lDeduzISS":{"type":"boolean","description":"Deduz o ISS da Base de Cálculo de PIS e COFINS"},"cstIbsCbs":{"type":"string","maxLength":3,"description":"Código da Situação Tributária IBS/CBS.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"aliqCbs":{"type":"number","maxLength":10,"description":"Alíquota da CBS\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"aliqIbsUf":{"type":"number","maxLength":10,"description":"Alíquota do IBS Estadual.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"aliqIbsMun":{"type":"number","maxLength":10,"description":"Alíquota do Alíquota do IBS Municipal.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"percReducaoIbsUf":{"type":"number","maxLength":18,"description":"Percentual redução IBS municipal.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"percReducaoIbsMun":{"type":"number","maxLength":18,"description":"Percentual redução IBS estadual.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"percReducaoCbs":{"type":"number","maxLength":18,"description":"Percentual redução CBS.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"classTrib":{"type":"string","maxLength":6,"description":"Código de Classificação Tributária.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"indOper":{"type":"string","maxLength":6,"description":"Código Indicador de Operação.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"manIbsMun":{"type":"string","maxLength":1,"description":"Indica que houve alteração manual da alíquota de IBS Municipal.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"manIbsUf":{"type":"string","maxLength":1,"description":"Indica que houve alteração manual da alíquota de IBS Estadual.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"manCbs":{"type":"string","maxLength":1,"description":"Indica que houve alteração manual da alíquota de CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"valorCbs":{"type":"number","maxLength":18,"description":"Valor da CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"valorIbsUf":{"type":"number","maxLength":18,"description":"Valor do IBS Estadual.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"valorIbsMun":{"type":"number","maxLength":18,"description":"Valor do IBS Municipal.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."}},"required":["aliqCSLL","aliqINSS","aliqIR","aliqPIS","valorCOFINS"]},"itemLeiTranspImp":{"type":"object","properties":{"aliqFederal":{"type":"number","maxLength":10,"description":"Alíquota da Carga Tributária Aprox. Federal"},"aliqEstadual":{"type":"number","maxLength":10,"description":"Alíquota Carga Trib. Aprox. Estadual"},"aliMunicipal":{"type":"number","maxLength":10,"description":"Alíquota Carga Trib. Aprox. Municipal"},"chave":{"type":"string","maxLength":6,"description":"Chave do IBPT"},"fonte":{"type":"string","maxLength":34,"description":"Fonte do IBPT"}}},"itemOutrasInf":{"type":"object","properties":{"dItVigInicial":{"type":"string","maxLength":10,"description":"Data da vigência inicial do item do contrato de serviços"},"dItVigFinal":{"type":"string","maxLength":10,"description":"Data da vigência final do item do contrato de serviços"},"nTipoItVigFinal":{"type":"integer","maxLength":1,"description":"Tipo da vigência final do item do contrato de serviços.\n\nValores possiveis:\n\n1 - Data especifica\n2 - Segue a vigência final do contrato\n3 - Apenas para o proximo faturamento"}},"description":"Outras informações do item do contrato de serviços"},"itemViaUnica":{"type":"object","properties":{"cModeloNF":{"type":"string","maxLength":2,"description":"Indica qual modelo de NF será emitida para o serviço.\n\nObrigatório quando a tag cEnvViaUnica for igual a \"S\".\n\nPode ser:\n21 - Nota Fiscal de Serviço de Comunicação\n22 - Nota Fiscal de Serviço de Telecomunicação"},"cCFOP":{"type":"string","maxLength":10,"description":"Código CFOP para NF Via Única (Modelos 21 e 22).\n\nObrigatório quando a tag cEnvViaUnica for igual a \"S\".\n\nUtilize a tag \"nCodigo\" do método \"ListarCFOP\" da API  /api/v1/produtos/cfop/ para obter essa informação."},"cClassifServico":{"type":"string","maxLength":4,"description":"Código da Classificação para NF Via Única (Modelos 21 e 22).\n\nObrigatório quando a tag cEnvViaUnica for igual a \"S\".\n\nUtilize a tag \"cCodigo\" do método \"ListarClassificacaoServico\" da API\n/api/v1/servicos/classificacaoservico/ para obter essa informação."},"cTipoReceita":{"type":"string","maxLength":1,"description":"Indicador do Tipo de Receita para NF Via Única (Modelos 21 e 22).\n\nObrigatório quando a tag cEnvViaUnica for igual a \"S\".\n\nPode ser:\n0 - Receita própria - serviços prestados\n1 - Receita própria - cobrança de débitos\n2 - Receita própria - venda de mercadorias\n3 - Receita própria - venda de serviço pré-pago\n4 - Outras receitas próprias\n5 - Receitas de terceiros (co-faturamento)\n9 - Outras receitas de terceiros"},"cTipoUtilizacao":{"type":"string","maxLength":1,"description":"Código do tipo de utilização para NF Via Única (Modelos 21 e 22).\n\nObrigatório quando a tag cEnvViaUnica for igual a \"S\".\n\nUtilize a tag \"cCodigo\" do método \"ListarTipoUtilizacao\" da API\n/api/v1/servicos/tipoutilizacao/ para obter essa informação."}},"description":"Informações referente ao serviço da NF modelo 21 ou 22."}}}},"emailCliente":{"type":"object","properties":{"cEnviarRecibo":{"type":"string","maxLength":1,"description":"Enviar um recibo de prestação de serviço (ao invés de NFS-e)"},"cEnviarLinkNfse":{"type":"string","maxLength":1,"description":"Enviar o link da NFS-e gerada na Prefeitura"},"cEnviarBoleto":{"type":"string","maxLength":1,"description":"Enviar também o(s) boleto(s) de cobrança"},"cEnviarPix":{"type":"string","maxLength":1,"description":"Enviar também o(s) PIX(s) de cobrança"},"cUtilizarEmails":{"type":"string","description":"Utilizar os seguintes endereços de e-mail"},"cEnvViaUnica":{"type":"string","maxLength":1,"description":"Enviar ao cliente Via Única (Nota Fiscais Modelos 21 e 22).\n\nPode ser:\nS - Sim\nN - Não"}},"description":"Dados do envio de e-mail do cliente"},"observacoes":{"type":"object","properties":{"cObsContrato":{"type":"string","description":"Observações do Contrato. Essas informação não serão exibidas na Nota Fiscal)."}},"description":"Observações do contrato"},"despesasReembolsaveis":{"type":"object","properties":{"cCodCategReemb":{"type":"string","maxLength":20,"description":"Código da categoria para reembolso"},"despesaReembolsavel":{"type":"array","items":{"type":"object","properties":{"cAcaoReemb":{"type":"string","maxLength":1,"description":"Ação para o reembolso, pode ser:\n\nI - Inclusão\nA - Alteração\nE - Exclusão"},"nCodReemb":{"type":"integer","maxLength":15,"description":"ID do Reembolso"},"dDataReemb":{"type":"string","maxLength":10,"description":"Data do reembolso"},"nValorReemb":{"type":"number","maxLength":18,"description":"Valor do Reembolso"},"cDescReemb":{"type":"string","maxLength":200,"description":"Descrição do reembolso"},"cRecorrenteReemb":{"type":"string","maxLength":1,"description":"Indica se o reembolso é recorrente. [S/N]"}}},"description":"Despesa reembolsável"}},"description":"Despesas reembolsáveis"},"produtosUtilizados":{"type":"object","properties":{"cAcaoProdUtilizados":{"type":"string","maxLength":3,"description":"Pode ser:\nREM - Será gerado uma remessa dos produtos para o cliente.\nEST - Será gerado uma saída de estoque.\nPED - Será gerado um pedido de venda.\n\nObrigatório na inclusão."},"cCodCategRem":{"type":"string","maxLength":20,"description":"Código da Categoria da Remessa ou Pedido de Venda.\n\nObrigatório quando usar [cAcaoFaturamento] como 'REM' ou 'PED'."},"produtoUtilizado":{"type":"array","items":{"type":"object","properties":{"nIdItemPU":{"type":"integer","maxLength":15,"description":"(Código interno utilizado apenas na API).\nNão informar na inclusão.\n\nEsse código não aparece na tela do Omie."},"cAcaoItemPU":{"type":"string","maxLength":1,"description":"Pode ser:\n\n\"A\" - Alterar o item.\n\"E\" - Excluir o item.\n\"I\" - Incluir o item na alteração."},"nCodProdutoPU":{"type":"integer","maxLength":15,"description":"Código interno do produto.\n(utilizado apenas na API).\nEsse código não aparece na tela do Omie."},"nQtdePU":{"type":"number","maxLength":18,"description":"Quantidade."},"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do Local do Estoque."},"lote_validade":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","maxLength":15,"description":"Id do lote do produto.\n\nObrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.."},"nQtdLote":{"type":"number","maxLength":18,"description":"Informe aqui a quantidade do lote para o produto.\n\nÉ obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações."}},"required":["nQtdLote"]},"description":"Informações referentes ao lote e validade do produto.\n\nA tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes \"manualmente\" por API."}}},"description":"Produtos utilizados no serviço."}},"description":"Produtos Utilizados no contrato."},"infoCadastro":{"type":"object","properties":{"dInc":{"type":"string","maxLength":10,"description":"Data da Inclusão.\nNo formato dd/mm/aaaa.\n\nNão deve ser informado na Inclusão/Alteração."},"hInc":{"type":"string","maxLength":8,"description":"Hora da Inclusão.\nNo formato hh:mm:ss.\n\nNão deve ser informado na Inclusão/Alteração."},"uInc":{"type":"string","maxLength":10,"description":"Usuário da Inclusão.\n\nNão deve ser informado na Inclusão/Alteração."},"dAlt":{"type":"string","maxLength":10,"description":"Data da Alteração.\nNo formato dd/mm/aaaa.\n\nNão deve ser informado na Inclusão/Alteração."},"hAlt":{"type":"string","maxLength":8,"description":"Hora da Alteração.\nNo formato hh:mm:ss.\n\nNão deve ser informado na Inclusão/Alteração."},"uAlt":{"type":"string","maxLength":10,"description":"Usuário da Alteração.\n\nNão deve ser informado na Inclusão/Alteração."},"cImpAPI":{"type":"string","maxLength":1,"description":"Importado pela API (S/N).\n\nNão deve ser informado na Inclusão/Alteração."},"cOrigem":{"type":"string","maxLength":3,"description":"Origem do Contrato de Serviço.\n\nInformado na Inclusão."}},"description":"Informações complementares do contrato."}}}}},"example":{"call":"AlterarContrato","param":[{"cabecalho":{"cCodIntCtr":"019289Tb2","cCodSit":"10","cNumCtr":"2020/01001","cTipoFat":"01","dVigFinal":"30/03/2022","dVigInicial":"29/03/2020","nCodCli":2370765,"nDiaFat":30,"nValTotMes":3302},"departamentos":[],"emailCliente":{"cEnviarBoleto":"","cEnviarLinkNfse":"","cEnviarRecibo":"","cUtilizarEmails":""},"infAdic":{"cCidPrestServ":"PETROPOLIS (RJ)","cCodART":"","cCodCateg":"1.01.02","cCodObra":"","cContato":"","cDadosAdicNF":"","nCodCC":1208238,"nCodProj":0,"nCodVend":0},"itensContrato":[{"itemCabecalho":{"codIntItem":"1","cCodCategItem":"","cNaoGerarFinanceiro":"N","codLC116":"3.05","codNBS":"","codServMunic":"01292","codServico":0,"natOperacao":"01","quant":1,"seq":1,"valorDed":0,"valorTotal":3002,"valorUnit":3002},"itemDescrServ":{"descrCompleta":"Serviços prestados"},"itemImpostos":{"aliqCOFINS":0,"aliqCSLL":0,"aliqINSS":0,"aliqIR":0,"aliqISS":5,"aliqPIS":0,"redBaseINSS":0,"retCOFINS":"","retCSLL":"","retINSS":"","retIR":"","retISS":"N","retPIS":"","valorCOFINS":0,"valorCSLL":0,"valorINSS":0,"valorIR":0,"valorISS":150.1,"valorPIS":0},"itemLeiTranspImp":{"aliMunicipal":0,"aliqEstadual":0,"aliqFederal":0,"chave":"","fonte":""}},{"itemCabecalho":{"codIntItem":"2","cCodCategItem":"","cNaoGerarFinanceiro":"N","codLC116":"17.01","codNBS":"","codServMunic":"0162-8/99","codServico":3412648,"natOperacao":"01","quant":1,"seq":2,"valorDed":0,"valorTotal":300,"valorUnit":300},"itemDescrServ":{"descrCompleta":"Homologação de processo contábil"},"itemImpostos":{"aliqCOFINS":0,"aliqCSLL":0,"aliqINSS":0,"aliqIR":0,"aliqISS":3,"aliqPIS":0,"redBaseINSS":0,"retCOFINS":"","retCSLL":"","retINSS":"","retIR":"","retISS":"N","retPIS":"","valorCOFINS":0,"valorCSLL":0,"valorINSS":0,"valorIR":0,"valorISS":9,"valorPIS":0},"itemLeiTranspImp":{"aliMunicipal":0,"aliqEstadual":0,"aliqFederal":0,"chave":"","fonte":""}}],"observacoes":{"cObsContrato":""},"vencTextos":{"cAdContrato":"N","cAdPeriodo":"N","cAdVenc":" ","cAntecipar":"","cCodPerRef":"001","cDiaFim":0,"cDiaIni":0,"cPostergar":"","cProxMes":"","cTpVenc":"001","nDiaFixo":0,"nDias":5}}]}},"servicos_contrato_AlterarContrato_retorno":{"type":"object","properties":{"cCodIntCtr":{"type":"string","description":"Código de Integração do Contrato de Serviço"},"nCodCtr":{"type":"integer","description":"Código da Contrato de Serviço"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDescStatus":{"type":"string","description":"Descrição do Status"}},"title":"AlterarContrato (retorno)"},"servicos_contrato_ConsultarContrato":{"type":"object","title":"ConsultarContrato","description":"Consulta o Contrato de Serviço","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarContrato"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"contratoChave":{"type":"object","properties":{"nCodCtr":{"type":"integer","maxLength":15,"description":"Código do contrato de serviços.\n(Gerado internamente, não é visualizado na tela)"},"cCodIntCtr":{"type":"string","maxLength":20,"description":"Código de Integração do contrato de serviços.\n(Utilizado em contratos de serviços criados a partir de API, não é visualizado na tela)"}},"description":"Chave de Pesquisa do Contrato de Serviço."}}}}},"example":{"call":"ConsultarContrato","param":[{"contratoChave":{"nCodCtr":2203958}}]}},"servicos_contrato_ConsultarContrato_retorno":{"type":"object","properties":{"contratoCadastro":{"type":"object","properties":{"cabecalho":{"type":"object","properties":{"nCodCtr":{"type":"integer","description":"Código do contrato de serviços. (Gerado internamente, não é visualizado na tela)"},"cCodIntCtr":{"type":"string","description":"Código de integração do contrato de serviços. (Utilizado em contratos criados via API, não é visualizado na tela)"},"nCodCli":{"type":"integer","description":"Código do cliente a que se refere o contrato de serviços. (Gerado internamente, não é visualizado na tela)"},"cNumCtr":{"type":"string","description":"Número do contrato de serviços. (Informado pelo usuário / visualizado na tela)"},"cCodSit":{"type":"string","description":"Código da situação do contrato de serviços. Pode ser: 00 - Em Elaboração 10 - Ativo 90 - Suspenso 99 - Cancelado"},"dVigInicial":{"type":"string","description":"Data da vigência inicial do contrato de serviços."},"dVigFinal":{"type":"string","description":"Data de vigência final do contrato de serviços."},"nDiaFat":{"type":"integer","description":"Dia de faturamento."},"nValTotMes":{"type":"decimal","description":"Valor total mensal do contrato de serviços. (Calculado automaticamente)"},"cTipoFat":{"type":"string","description":"Tipo de Faturamento do Contrato. Pode ser: 01 - Todo Mês (mensal) 02 - A cada 2 meses (bimestral) 03 - A cada 3 meses (trimestral) 06 - A cada 6 meses (semestral) 12 - A cada 12 meses (anual)"}}},"departamentos":{"type":"array","items":{"type":"object","properties":{"cCodDep":{"type":"string","description":"Código do Departamento"},"cDesDep":{"type":"string","description":"Descrição do Departamento"},"nValDep":{"type":"decimal","description":"Valor do rateio"},"nPerDep":{"type":"decimal","description":"Percentual do rateio"}}},"description":"Distribuição por departamento"},"infAdic":{"type":"object","properties":{"cCodCateg":{"type":"string","description":"Código da Categoria"},"nCodVend":{"type":"integer","description":"Código do Vendedor"},"nCodProj":{"type":"integer","description":"Código do Projeto"},"nCodCC":{"type":"integer","description":"Código da Conta Corrente"},"cContato":{"type":"string","description":"Nome do Contato"},"cCidPrestServ":{"type":"string","description":"Cidade da Prestação do Serviço e Estado"},"cCodObra":{"type":"string","description":"Código da Obra"},"cCodART":{"type":"string","description":"Código ART"},"cNumEncap":{"type":"string","description":"Código de Encapsulamento de notas dedutoras"},"cDadosAdicNF":{"type":"string","description":"Dados Adicionais para a Nota Fiscal"},"cUsoConsumo":{"type":"string","description":"Uso e consumo pessoal. (0=Não, 1=Sim)."},"nIdDestinatario":{"type":"integer","description":"ID Cliente para o Destinatário."}}},"vencTextos":{"type":"object","properties":{"cTpVenc":{"type":"string","description":"Tipo de Vencimento. Pode ser: 001-Número de dias após faturar. 002-Fixar dia do mês (1 a 31)."},"nDias":{"type":"integer","description":"Número de Dias para a gerar o contas a receber"},"nDiaFixo":{"type":"integer","description":"Dia de vencimento fixo para a gerar o contas a receber"},"cProxMes":{"type":"string","description":"Define se o vencimento ocorrerá somente no mês seguinte."},"cAntecipar":{"type":"string","description":"Define se deve antecipar o vencimento ao considerar apenas dias úteis"},"cPostergar":{"type":"string","description":"Postergar Sábados, Domingos e Feriados Nacionais"},"cAdPeriodo":{"type":"string","description":"Adicionar o período de referência associado ao faturamento"},"cAdContrato":{"type":"string","description":"Adicionar o \"Nº do Contrato\" à descrição dos serviços na NFS-e"},"cAdVenc":{"type":"string","description":"Adicionar o vencimento da parcela à descrição dos serviços na NFS-e"},"cCodPerRef":{"type":"string","description":"Período de Referência - Código do período de referência para o faturamento. Pode ser: 001 Mês do faturamento 002 Mês Anterior ao faturamento 003 Mês Posterior ao faturamento 004 Período Anterior ao faturamento 005 Período Posterior ao faturamento 006 Período Anterior específico 007 Número da Parcela 008 Período Posterior específico 009 Período Atual específico"},"cDiaIni":{"type":"integer","description":"Dia Inicial - Dia para a data inicial do período de referência associado ao faturamentDia Inicial"},"cDiaFim":{"type":"integer","description":"Dia Final - Dia para a data final do período de referência associado ao faturamento"}}},"itensContrato":{"type":"array","items":{"type":"object","properties":{"itemCabecalho":{"type":"object","properties":{"codItem":{"type":"integer","description":"Identificação do Item do Contrato. (Gerado automaticamente na Inclusão do item do contrato)"},"codIntItem":{"type":"string","description":"Código de integração do item do contrato."},"seq":{"type":"integer","description":"Sequência do Item do Contrato."},"codServico":{"type":"integer","description":"Código Interno do Serviço conforme cadastrado na tabela de serviços. Caso preenchido, irá assumir as informações do cadastro de serviço. Se não for preenchido, assumirá os valores informados na API."},"natOperacao":{"type":"string","description":"Natureza da Operação ou Tipo de Tributação dos Serviços. Caso tenha informado a tag \"codServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. Valores pode variar de acordo com o município. Verifique a legislação da sua cidade para obter os tipos de tributação disponíveis."},"codServMunic":{"type":"string","description":"Código do Serviço Municipal ou CNAE. Caso tenha informado a tag \"codServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. Valores pode variar de acordo com o município. Verifique a legislação da sua cidade para obter os códigos de serviço disponíveis."},"codLC116":{"type":"string","description":"Código do Serviço conforme Lei Complementar (LC 116). Caso tenha informado a tag \"codServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. Tabela única para todos os municípios."},"quant":{"type":"decimal","description":"Quantidade de serviços. Caso tenha informado a tag \"codServico\" o preenchimento passa a ser opcional e irá assumir o valor padrão 1."},"valorUnit":{"type":"decimal","description":"Valor Unitário do serviço. Caso tenha informado a tag \"codServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço."},"cTpDesconto":{"type":"string","description":"Tipo de Desconto. Pode ser: P - Percentual V - Valor"},"valorDesconto":{"type":"decimal","description":"Valor do Desconto."},"aliqDesconto":{"type":"decimal","description":"Aliquota do Desconto."},"valorOutrasRetencoes":{"type":"decimal","description":"Valor de Outras Retenções. (Disponível apenas para cidades que oferecem esse recurso.)"},"valorAcrescimo":{"type":"decimal","description":"Valor de Acréscimos e taxas. (Disponível apenas para cidades que oferecem esse recurso.)"},"codNBS":{"type":"string","description":"Código da Nomenclatura Brasileira de Serviços (NBS). Caso tenha informado a tag \"codServico\" irá assumir o valor informado no cadastro do respectivo serviço."},"cNaoGerarFinanceiro":{"type":"string","description":"Não gerar conta a receber para este item. Informar \"S\" para não gerar movimento financeiro. Informar \"N\" para gerar movimento financeiro."},"cCodCategItem":{"type":"string","description":"Código da Categoria."},"valorDed":{"type":"decimal","description":"Valor de Deduções. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"valorTotal":{"type":"decimal","description":"Valor total do item. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração."}}},"itemDescrServ":{"type":"object","properties":{"descrCompleta":{"type":"string","description":"Informe a descrição completa do serviço prestado"}}},"itemImpostos":{"type":"object","properties":{"aliqISS":{"type":"decimal","description":"Alíquota de ISS."},"valorISS":{"type":"decimal","description":"Valor do ISS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"retISS":{"type":"string","description":"Retém ISS (S/N). Indica se o imposto deve ser retido ou não."},"cUtilizaValorImposto":{"type":"string","description":"Indica se o valor informado para os Impostos Federais deverá ser mantido ao invés de ser recalculado a partir da alíquota. Assim: Caso seja informado \"N\", indica que valor do imposto deve ser calculado a partir da alíquota e base de cálculo. Caso seja informado \"S\", indica que o valor do imposto será mantido e a alíquota será recalculada a partir do valor do imposto e base de cálculo."},"aliqIR":{"type":"decimal","description":"Alíquota de IR. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"valorIR":{"type":"decimal","description":"Valor do IR. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\". Caso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"retIR":{"type":"string","description":"Retém IR (S/N). Indica se o imposto deve ser retido ou não."},"aliqPIS":{"type":"decimal","description":"Alíquota de PIS. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"valorPIS":{"type":"decimal","description":"Valor do PIS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\". Caso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"retPIS":{"type":"string","description":"Retém PIS (S/N). Indica se o imposto deve ser retido ou não."},"aliqCOFINS":{"type":"decimal","description":"Indica se o imposto foi alterado pelo usuário ou informado via importação de planilha ou API. Esse campo é preenchido automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"valorCOFINS":{"type":"decimal","description":"Alíquota de COFINS. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"retCOFINS":{"type":"string","description":"Retém COFINS (S/N). Indica se o imposto deve ser retido ou não."},"aliqCSLL":{"type":"decimal","description":"Alíquota de CSLL. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"valorCSLL":{"type":"decimal","description":"Valor de CSLL. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\". Caso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"retCSLL":{"type":"string","description":"Retém CSLL (S/N). Indica se o imposto deve ser retido ou não."},"aliqINSS":{"type":"decimal","description":"Alíquota de INSS. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"valorINSS":{"type":"decimal","description":"Valor de INSS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\". Caso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"retINSS":{"type":"string","description":"Retém INSS (S/N). Indica se o imposto deve ser retido ou não."},"redBaseINSS":{"type":"decimal","description":"Percentual de Redução da Base de Cálculo do INSS."},"redBasePIS":{"type":"decimal","description":"Percentual de Redução da Base de Cálculo do PIS."},"redBaseCOFINS":{"type":"decimal","description":"Percentual de Redução da Base de Cálculo do COFINS."},"lDeduzISS":{"type":"boolean","description":"Deduz o ISS da Base de Cálculo de PIS e COFINS"},"cstIbsCbs":{"type":"string","description":"Código da Situação Tributária IBS/CBS. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"aliqCbs":{"type":"decimal","description":"Alíquota da CBS Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"aliqIbsUf":{"type":"decimal","description":"Alíquota do IBS Estadual. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"aliqIbsMun":{"type":"decimal","description":"Alíquota do Alíquota do IBS Municipal. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"percReducaoIbsUf":{"type":"decimal","description":"Percentual redução IBS municipal. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"percReducaoIbsMun":{"type":"decimal","description":"Percentual redução IBS estadual. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"percReducaoCbs":{"type":"decimal","description":"Percentual redução CBS. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"classTrib":{"type":"string","description":"Código de Classificação Tributária. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"indOper":{"type":"string","description":"Código Indicador de Operação. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"manIbsMun":{"type":"string","description":"Indica que houve alteração manual da alíquota de IBS Municipal. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"manIbsUf":{"type":"string","description":"Indica que houve alteração manual da alíquota de IBS Estadual. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"manCbs":{"type":"string","description":"Indica que houve alteração manual da alíquota de CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"valorCbs":{"type":"decimal","description":"Valor da CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"valorIbsUf":{"type":"decimal","description":"Valor do IBS Estadual. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"valorIbsMun":{"type":"decimal","description":"Valor do IBS Municipal. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."}}},"itemLeiTranspImp":{"type":"object","properties":{"aliqFederal":{"type":"decimal","description":"Alíquota da Carga Tributária Aprox. Federal"},"aliqEstadual":{"type":"decimal","description":"Alíquota Carga Trib. Aprox. Estadual"},"aliMunicipal":{"type":"decimal","description":"Alíquota Carga Trib. Aprox. Municipal"},"chave":{"type":"string","description":"Chave do IBPT"},"fonte":{"type":"string","description":"Fonte do IBPT"}}},"itemOutrasInf":{"type":"object","properties":{"dItVigInicial":{"type":"string","description":"Data da vigência inicial do item do contrato de serviços"},"dItVigFinal":{"type":"string","description":"Data da vigência final do item do contrato de serviços"},"nTipoItVigFinal":{"type":"integer","description":"Tipo da vigência final do item do contrato de serviços. Valores possiveis: 1 - Data especifica 2 - Segue a vigência final do contrato 3 - Apenas para o proximo faturamento"}},"description":"Outras informações do item do contrato de serviços"},"itemViaUnica":{"type":"object","properties":{"cModeloNF":{"type":"string","description":"Indica qual modelo de NF será emitida para o serviço. Obrigatório quando a tag cEnvViaUnica for igual a \"S\". Pode ser: 21 - Nota Fiscal de Serviço de Comunicação 22 - Nota Fiscal de Serviço de Telecomunicação"},"cCFOP":{"type":"string","description":"Código CFOP para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a \"S\". Utilize a tag \"nCodigo\" do método \"ListarCFOP\" da API /api/v1/produtos/cfop/ para obter essa informação."},"cClassifServico":{"type":"string","description":"Código da Classificação para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a \"S\". Utilize a tag \"cCodigo\" do método \"ListarClassificacaoServico\" da API /api/v1/servicos/classificacaoservico/ para obter essa informação."},"cTipoReceita":{"type":"string","description":"Indicador do Tipo de Receita para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a \"S\". Pode ser: 0 - Receita própria - serviços prestados 1 - Receita própria - cobrança de débitos 2 - Receita própria - venda de mercadorias 3 - Receita própria - venda de serviço pré-pago 4 - Outras receitas próprias 5 - Receitas de terceiros (co-faturamento) 9 - Outras receitas de terceiros"},"cTipoUtilizacao":{"type":"string","description":"Código do tipo de utilização para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a \"S\". Utilize a tag \"cCodigo\" do método \"ListarTipoUtilizacao\" da API /api/v1/servicos/tipoutilizacao/ para obter essa informação."}},"description":"Informações referente ao serviço da NF modelo 21 ou 22."}}}},"emailCliente":{"type":"object","properties":{"cEnviarRecibo":{"type":"string","description":"Enviar um recibo de prestação de serviço (ao invés de NFS-e)"},"cEnviarLinkNfse":{"type":"string","description":"Enviar o link da NFS-e gerada na Prefeitura"},"cEnviarBoleto":{"type":"string","description":"Enviar também o(s) boleto(s) de cobrança"},"cEnviarPix":{"type":"string","description":"Enviar também o(s) PIX(s) de cobrança"},"cUtilizarEmails":{"type":"string","description":"Utilizar os seguintes endereços de e-mail"},"cEnvViaUnica":{"type":"string","description":"Enviar ao cliente Via Única (Nota Fiscais Modelos 21 e 22). Pode ser: S - Sim N - Não"}},"description":"Dados do envio de e-mail do cliente"},"observacoes":{"type":"object","properties":{"cObsContrato":{"type":"string","description":"Observações do Contrato. Essas informação não serão exibidas na Nota Fiscal)."}},"description":"Observações do contrato"},"despesasReembolsaveis":{"type":"object","properties":{"cCodCategReemb":{"type":"string","description":"Código da categoria para reembolso"},"despesaReembolsavel":{"type":"array","items":{"type":"object","properties":{"cAcaoReemb":{"type":"string","description":"Ação para o reembolso, pode ser: I - Inclusão A - Alteração E - Exclusão"},"nCodReemb":{"type":"integer","description":"ID do Reembolso"},"dDataReemb":{"type":"string","description":"Data do reembolso"},"nValorReemb":{"type":"decimal","description":"Valor do Reembolso"},"cDescReemb":{"type":"string","description":"Descrição do reembolso"},"cRecorrenteReemb":{"type":"string","description":"Indica se o reembolso é recorrente. [S/N]"}}},"description":"Despesa reembolsável"}},"description":"Despesas reembolsáveis"},"produtosUtilizados":{"type":"object","properties":{"cAcaoProdUtilizados":{"type":"string","description":"Pode ser: REM - Será gerado uma remessa dos produtos para o cliente. EST - Será gerado uma saída de estoque. PED - Será gerado um pedido de venda. Obrigatório na inclusão."},"cCodCategRem":{"type":"string","description":"Código da Categoria da Remessa ou Pedido de Venda. Obrigatório quando usar [cAcaoFaturamento] como 'REM' ou 'PED'."},"produtoUtilizado":{"type":"array","items":{"type":"object","properties":{"nIdItemPU":{"type":"integer","description":"(Código interno utilizado apenas na API). Não informar na inclusão. Esse código não aparece na tela do Omie."},"cAcaoItemPU":{"type":"string","description":"Pode ser: \"A\" - Alterar o item. \"E\" - Excluir o item. \"I\" - Incluir o item na alteração."},"nCodProdutoPU":{"type":"integer","description":"Código interno do produto. (utilizado apenas na API). Esse código não aparece na tela do Omie."},"nQtdePU":{"type":"decimal","description":"Quantidade."},"codigo_local_estoque":{"type":"integer","description":"Código do Local do Estoque."},"lote_validade":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","description":"Id do lote do produto. Obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.."},"nQtdLote":{"type":"decimal","description":"Informe aqui a quantidade do lote para o produto. É obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações."}}},"description":"Informações referentes ao lote e validade do produto. A tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes \"manualmente\" por API."}}},"description":"Produtos utilizados no serviço."}},"description":"Produtos Utilizados no contrato."},"infoCadastro":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração."},"hInc":{"type":"string","description":"Hora da Inclusão. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração."},"uInc":{"type":"string","description":"Usuário da Inclusão. Não deve ser informado na Inclusão/Alteração."},"dAlt":{"type":"string","description":"Data da Alteração. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração."},"hAlt":{"type":"string","description":"Hora da Alteração. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração."},"uAlt":{"type":"string","description":"Usuário da Alteração. Não deve ser informado na Inclusão/Alteração."},"cImpAPI":{"type":"string","description":"Importado pela API (S/N). Não deve ser informado na Inclusão/Alteração."},"cOrigem":{"type":"string","description":"Origem do Contrato de Serviço. Informado na Inclusão."}},"description":"Informações complementares do contrato."}},"description":"Cadastro de Contrato de Serviço"}},"title":"ConsultarContrato (retorno)"},"servicos_contrato_ExcluirItem":{"type":"object","title":"ExcluirItem","description":"Exclui itens do contrato de serviços.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirItem"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"contratoChave":{"type":"object","properties":{"nCodCtr":{"type":"integer","maxLength":15,"description":"Código do contrato de serviços.\n(Gerado internamente, não é visualizado na tela)"},"cCodIntCtr":{"type":"string","maxLength":20,"description":"Código de Integração do contrato de serviços.\n(Utilizado em contratos de serviços criados a partir de API, não é visualizado na tela)"}},"description":"Chave de Pesquisa do Contrato de Serviço."},"ItensExclusao":{"type":"array","items":{"type":"object","properties":{"codItem":{"type":"integer","maxLength":15,"description":"Código do Item."},"codIntItem":{"type":"string","maxLength":30,"description":"Código de integração do item do contrato\n(Utilizado em contratos de serviços criados a partir de API, não é visualizado na tela)"}}},"description":"Itens a serem excluídos do contrato."}}}}},"example":{"call":"ExcluirItem","param":[{"contratoChave":{"nCodCtr":0,"cCodIntCtr":""},"ItensExclusao":[{"codItem":0,"codIntItem":""}]}]}},"servicos_contrato_ExcluirItem_retorno":{"type":"object","properties":{"cCodIntCtr":{"type":"string","description":"Código de Integração do Contrato de Serviço"},"nCodCtr":{"type":"integer","description":"Código da Contrato de Serviço"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDescStatus":{"type":"string","description":"Descrição do Status"}},"title":"ExcluirItem (retorno)"},"servicos_contrato_IncluirContrato":{"type":"object","title":"IncluirContrato","description":"Inclusão de Contrato","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirContrato"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cabecalho":{"type":"object","properties":{"nCodCtr":{"type":"integer","maxLength":15,"description":"Código do contrato de serviços.\n(Gerado internamente, não é visualizado na tela)"},"cCodIntCtr":{"type":"string","maxLength":20,"description":"Código de integração do contrato de serviços.\n(Utilizado em contratos criados via API, não é visualizado na tela)"},"nCodCli":{"type":"integer","maxLength":15,"description":"Código do cliente a que se refere o contrato de serviços.\n(Gerado internamente, não é visualizado na tela)"},"cNumCtr":{"type":"string","maxLength":60,"description":"Número do contrato de serviços.\n(Informado pelo usuário / visualizado na tela)"},"cCodSit":{"type":"string","maxLength":2,"description":"Código da situação do contrato de serviços.\nPode ser:\n00 - Em Elaboração\n10 - Ativo\n90 - Suspenso\n99 - Cancelado"},"dVigInicial":{"type":"string","maxLength":10,"description":"Data da vigência inicial do contrato de serviços."},"dVigFinal":{"type":"string","maxLength":10,"description":"Data de vigência final do contrato de serviços."},"nDiaFat":{"type":"integer","maxLength":2,"description":"Dia de faturamento."},"nValTotMes":{"type":"number","maxLength":18,"description":"Valor total mensal do contrato de serviços.\n(Calculado automaticamente)"},"cTipoFat":{"type":"string","maxLength":2,"description":"Tipo de Faturamento do Contrato.\nPode ser:\n01 - Todo Mês (mensal)\n02 - A cada 2 meses (bimestral)\n03 - A cada 3 meses (trimestral)\n06 - A cada 6 meses (semestral)\n12 - A cada 12 meses (anual)"}}},"departamentos":{"type":"array","items":{"type":"object","properties":{"cCodDep":{"type":"string","maxLength":40,"description":"Código do Departamento"},"cDesDep":{"type":"string","maxLength":50,"description":"Descrição do Departamento"},"nValDep":{"type":"number","maxLength":18,"description":"Valor do rateio"},"nPerDep":{"type":"number","maxLength":10,"description":"Percentual do rateio"}}},"description":"Distribuição por departamento"},"infAdic":{"type":"object","properties":{"cCodCateg":{"type":"string","maxLength":20,"description":"Código da Categoria"},"nCodVend":{"type":"integer","maxLength":15,"description":"Código do Vendedor"},"nCodProj":{"type":"integer","maxLength":15,"description":"Código do Projeto"},"nCodCC":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente"},"cContato":{"type":"string","maxLength":100,"description":"Nome do Contato"},"cCidPrestServ":{"type":"string","maxLength":40,"description":"Cidade da Prestação do Serviço e Estado"},"cCodObra":{"type":"string","maxLength":15,"description":"Código da Obra"},"cCodART":{"type":"string","maxLength":20,"description":"Código ART"},"cNumEncap":{"type":"string","maxLength":15,"description":"Código de Encapsulamento de notas dedutoras"},"cDadosAdicNF":{"type":"string","description":"Dados Adicionais para a Nota Fiscal"},"cUsoConsumo":{"type":"string","maxLength":1,"description":"Uso e consumo pessoal.\n\n(0=Não, 1=Sim)."},"nIdDestinatario":{"type":"integer","maxLength":15,"description":"ID Cliente para o Destinatário."}}},"vencTextos":{"type":"object","properties":{"cTpVenc":{"type":"string","maxLength":3,"description":"Tipo de Vencimento.\n\nPode ser:\n001-Número de dias após faturar.\n002-Fixar dia do mês (1 a 31)."},"nDias":{"type":"integer","maxLength":3,"description":"Número de Dias para a gerar o contas a receber"},"nDiaFixo":{"type":"integer","maxLength":2,"description":"Dia de vencimento fixo para a gerar o contas a receber"},"cProxMes":{"type":"string","maxLength":1,"description":"Define se o vencimento ocorrerá somente no mês seguinte."},"cAntecipar":{"type":"string","maxLength":1,"description":"Define se deve antecipar o vencimento ao considerar apenas dias úteis"},"cPostergar":{"type":"string","maxLength":1,"description":"Postergar Sábados, Domingos e Feriados Nacionais"},"cAdPeriodo":{"type":"string","maxLength":1,"description":"Adicionar o período de referência associado ao faturamento"},"cAdContrato":{"type":"string","maxLength":1,"description":"Adicionar o \"Nº do Contrato\" à descrição dos serviços na NFS-e"},"cAdVenc":{"type":"string","maxLength":1,"description":"Adicionar o vencimento da parcela à descrição dos serviços na NFS-e"},"cCodPerRef":{"type":"string","maxLength":3,"description":"Período de Referência - Código do período de referência para o faturamento.\n\nPode ser:\n001 Mês do faturamento\n002 Mês Anterior ao faturamento\n003 Mês Posterior ao faturamento\n004 Período Anterior ao faturamento\n005 Período Posterior ao faturamento\n006 Período Anterior específico\n007 Número da Parcela\n008 Período Posterior específico\n009 Período Atual específico"},"cDiaIni":{"type":"string","corrigido_pela_convencao":true,"maxLength":2,"description":"Dia Inicial - Dia para a data inicial do período de referência associado ao faturamentDia Inicial"},"cDiaFim":{"type":"string","corrigido_pela_convencao":true,"maxLength":2,"description":"Dia Final - Dia para a data final do período de referência associado ao faturamento"}}},"itensContrato":{"type":"array","items":{"type":"object","properties":{"itemCabecalho":{"type":"object","properties":{"codItem":{"type":"integer","maxLength":15,"description":"Identificação do Item do Contrato.\n\n(Gerado automaticamente na Inclusão do item do contrato)"},"codIntItem":{"type":"string","maxLength":30,"description":"Código de integração do item do contrato."},"seq":{"type":"integer","maxLength":4,"description":"Sequência do Item do Contrato."},"codServico":{"type":"integer","maxLength":15,"description":"Código Interno do Serviço conforme cadastrado na tabela de serviços.\n\n\nCaso preenchido, irá assumir as informações do cadastro de serviço.\n\nSe não for preenchido, assumirá os valores informados na API."},"natOperacao":{"type":"string","maxLength":2,"description":"Natureza da Operação ou Tipo de Tributação dos Serviços.\n\n\nCaso tenha informado a tag \"codServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço.\n\nValores pode variar de acordo com o município. Verifique a legislação da sua cidade para obter os tipos de tributação disponíveis."},"codServMunic":{"type":"string","maxLength":20,"description":"Código do Serviço Municipal ou CNAE.\n\n\nCaso tenha informado a tag \"codServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço.\n\nValores pode variar de acordo com o município. Verifique a legislação da sua cidade para obter os códigos de serviço disponíveis."},"codLC116":{"type":"string","maxLength":10,"description":"Código do Serviço conforme Lei Complementar (LC 116).\n\n\nCaso tenha informado a tag \"codServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço.\n\nTabela única para todos os municípios."},"quant":{"type":"number","maxLength":18,"description":"Quantidade de serviços.\n\n\nCaso tenha informado a tag \"codServico\" o preenchimento passa a ser opcional e irá assumir o valor padrão 1."},"valorUnit":{"type":"number","maxLength":18,"description":"Valor Unitário do serviço.\n\n\nCaso tenha informado a tag \"codServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço."},"cTpDesconto":{"type":"string","maxLength":1,"description":"Tipo de Desconto.\n\n\nPode ser:\nP - Percentual\nV - Valor"},"valorDesconto":{"type":"number","maxLength":18,"description":"Valor do Desconto."},"aliqDesconto":{"type":"number","maxLength":18,"description":"Aliquota do Desconto."},"valorOutrasRetencoes":{"type":"number","maxLength":18,"description":"Valor de Outras Retenções.\n\n\n(Disponível apenas para cidades que oferecem esse recurso.)"},"valorAcrescimo":{"type":"number","maxLength":18,"description":"Valor de Acréscimos e taxas.\n\n\n(Disponível apenas para cidades que oferecem esse recurso.)"},"codNBS":{"type":"string","maxLength":9,"description":"Código da Nomenclatura Brasileira de Serviços (NBS).\n\n\nCaso tenha informado a tag \"codServico\" irá assumir o valor informado no cadastro do respectivo serviço."},"cNaoGerarFinanceiro":{"type":"string","maxLength":1,"description":"Não gerar conta a receber para este item.\n\n\nInformar \"S\" para não gerar movimento financeiro.\nInformar \"N\" para gerar movimento financeiro."},"cCodCategItem":{"type":"string","maxLength":20,"description":"Código da Categoria."},"valorDed":{"type":"number","maxLength":18,"description":"Valor de Deduções.\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"valorTotal":{"type":"number","maxLength":18,"description":"Valor total do item.\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração."}}},"itemDescrServ":{"type":"object","properties":{"descrCompleta":{"type":"string","description":"Informe a descrição completa do serviço prestado"}}},"itemImpostos":{"type":"object","properties":{"aliqISS":{"type":"number","maxLength":10,"description":"Alíquota de ISS."},"valorISS":{"type":"number","maxLength":18,"description":"Valor do ISS.\n\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"retISS":{"type":"string","maxLength":1,"description":"Retém ISS  (S/N).\n\n\nIndica se o imposto deve ser retido ou não."},"cUtilizaValorImposto":{"type":"string","maxLength":1,"description":"Indica se o valor informado para os Impostos Federais deverá ser mantido ao invés de ser recalculado a partir da alíquota.\n\n\nAssim:\n\nCaso seja informado \"N\", indica que valor do imposto deve ser calculado a partir da alíquota e base de cálculo.\n\nCaso seja informado \"S\", indica que o valor do imposto será mantido e a alíquota será recalculada a partir do valor do imposto e base de cálculo."},"aliqIR":{"type":"number","maxLength":10,"description":"Alíquota de IR.\n\n\nPara o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\".\n\nLembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"valorIR":{"type":"number","maxLength":18,"description":"Valor do IR.\n\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\".\n\nCaso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"retIR":{"type":"string","maxLength":1,"description":"Retém IR  (S/N).\n\n\nIndica se o imposto deve ser retido ou não."},"aliqPIS":{"type":"number","maxLength":10,"description":"Alíquota de PIS.\n\n\nPara o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\".\n\nLembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"valorPIS":{"type":"number","maxLength":18,"description":"Valor do PIS.\n\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\".\n\nCaso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"retPIS":{"type":"string","maxLength":1,"description":"Retém PIS  (S/N).\n\n\nIndica se o imposto deve ser retido ou não."},"aliqCOFINS":{"type":"number","maxLength":10,"description":"Indica se o imposto foi alterado pelo usuário ou informado via importação de planilha ou API.\n\nEsse campo é preenchido automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"valorCOFINS":{"type":"number","maxLength":18,"description":"Alíquota de COFINS.\n\n\nPara o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\".\n\nLembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"retCOFINS":{"type":"string","maxLength":1,"description":"Retém COFINS  (S/N).\n\n\nIndica se o imposto deve ser retido ou não."},"aliqCSLL":{"type":"number","maxLength":10,"description":"Alíquota de CSLL.\n\nPara o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\".\n\nLembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"valorCSLL":{"type":"number","maxLength":18,"description":"Valor de CSLL.\n\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\".\n\nCaso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"retCSLL":{"type":"string","maxLength":1,"description":"Retém CSLL  (S/N).\n\n\nIndica se o imposto deve ser retido ou não."},"aliqINSS":{"type":"number","maxLength":10,"description":"Alíquota de INSS.\n\n\nPara o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\".\n\nLembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"valorINSS":{"type":"number","maxLength":18,"description":"Valor de INSS.\n\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\".\n\nCaso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"retINSS":{"type":"string","maxLength":1,"description":"Retém INSS  (S/N).\n\n\nIndica se o imposto deve ser retido ou não."},"redBaseINSS":{"type":"number","maxLength":10,"description":"Percentual de Redução da Base de Cálculo do INSS."},"redBasePIS":{"type":"number","maxLength":10,"description":"Percentual de Redução da Base de Cálculo do PIS."},"redBaseCOFINS":{"type":"number","maxLength":10,"description":"Percentual de Redução da Base de Cálculo do COFINS."},"lDeduzISS":{"type":"boolean","description":"Deduz o ISS da Base de Cálculo de PIS e COFINS"},"cstIbsCbs":{"type":"string","maxLength":3,"description":"Código da Situação Tributária IBS/CBS.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"aliqCbs":{"type":"number","maxLength":10,"description":"Alíquota da CBS\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"aliqIbsUf":{"type":"number","maxLength":10,"description":"Alíquota do IBS Estadual.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"aliqIbsMun":{"type":"number","maxLength":10,"description":"Alíquota do Alíquota do IBS Municipal.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"percReducaoIbsUf":{"type":"number","maxLength":18,"description":"Percentual redução IBS municipal.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"percReducaoIbsMun":{"type":"number","maxLength":18,"description":"Percentual redução IBS estadual.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"percReducaoCbs":{"type":"number","maxLength":18,"description":"Percentual redução CBS.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"classTrib":{"type":"string","maxLength":6,"description":"Código de Classificação Tributária.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"indOper":{"type":"string","maxLength":6,"description":"Código Indicador de Operação.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"manIbsMun":{"type":"string","maxLength":1,"description":"Indica que houve alteração manual da alíquota de IBS Municipal.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"manIbsUf":{"type":"string","maxLength":1,"description":"Indica que houve alteração manual da alíquota de IBS Estadual.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"manCbs":{"type":"string","maxLength":1,"description":"Indica que houve alteração manual da alíquota de CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"valorCbs":{"type":"number","maxLength":18,"description":"Valor da CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"valorIbsUf":{"type":"number","maxLength":18,"description":"Valor do IBS Estadual.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"valorIbsMun":{"type":"number","maxLength":18,"description":"Valor do IBS Municipal.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."}},"required":["aliqCSLL","aliqINSS","aliqIR","aliqPIS","valorCOFINS"]},"itemLeiTranspImp":{"type":"object","properties":{"aliqFederal":{"type":"number","maxLength":10,"description":"Alíquota da Carga Tributária Aprox. Federal"},"aliqEstadual":{"type":"number","maxLength":10,"description":"Alíquota Carga Trib. Aprox. Estadual"},"aliMunicipal":{"type":"number","maxLength":10,"description":"Alíquota Carga Trib. Aprox. Municipal"},"chave":{"type":"string","maxLength":6,"description":"Chave do IBPT"},"fonte":{"type":"string","maxLength":34,"description":"Fonte do IBPT"}}},"itemOutrasInf":{"type":"object","properties":{"dItVigInicial":{"type":"string","maxLength":10,"description":"Data da vigência inicial do item do contrato de serviços"},"dItVigFinal":{"type":"string","maxLength":10,"description":"Data da vigência final do item do contrato de serviços"},"nTipoItVigFinal":{"type":"integer","maxLength":1,"description":"Tipo da vigência final do item do contrato de serviços.\n\nValores possiveis:\n\n1 - Data especifica\n2 - Segue a vigência final do contrato\n3 - Apenas para o proximo faturamento"}},"description":"Outras informações do item do contrato de serviços"},"itemViaUnica":{"type":"object","properties":{"cModeloNF":{"type":"string","maxLength":2,"description":"Indica qual modelo de NF será emitida para o serviço.\n\nObrigatório quando a tag cEnvViaUnica for igual a \"S\".\n\nPode ser:\n21 - Nota Fiscal de Serviço de Comunicação\n22 - Nota Fiscal de Serviço de Telecomunicação"},"cCFOP":{"type":"string","maxLength":10,"description":"Código CFOP para NF Via Única (Modelos 21 e 22).\n\nObrigatório quando a tag cEnvViaUnica for igual a \"S\".\n\nUtilize a tag \"nCodigo\" do método \"ListarCFOP\" da API  /api/v1/produtos/cfop/ para obter essa informação."},"cClassifServico":{"type":"string","maxLength":4,"description":"Código da Classificação para NF Via Única (Modelos 21 e 22).\n\nObrigatório quando a tag cEnvViaUnica for igual a \"S\".\n\nUtilize a tag \"cCodigo\" do método \"ListarClassificacaoServico\" da API\n/api/v1/servicos/classificacaoservico/ para obter essa informação."},"cTipoReceita":{"type":"string","maxLength":1,"description":"Indicador do Tipo de Receita para NF Via Única (Modelos 21 e 22).\n\nObrigatório quando a tag cEnvViaUnica for igual a \"S\".\n\nPode ser:\n0 - Receita própria - serviços prestados\n1 - Receita própria - cobrança de débitos\n2 - Receita própria - venda de mercadorias\n3 - Receita própria - venda de serviço pré-pago\n4 - Outras receitas próprias\n5 - Receitas de terceiros (co-faturamento)\n9 - Outras receitas de terceiros"},"cTipoUtilizacao":{"type":"string","maxLength":1,"description":"Código do tipo de utilização para NF Via Única (Modelos 21 e 22).\n\nObrigatório quando a tag cEnvViaUnica for igual a \"S\".\n\nUtilize a tag \"cCodigo\" do método \"ListarTipoUtilizacao\" da API\n/api/v1/servicos/tipoutilizacao/ para obter essa informação."}},"description":"Informações referente ao serviço da NF modelo 21 ou 22."}}}},"emailCliente":{"type":"object","properties":{"cEnviarRecibo":{"type":"string","maxLength":1,"description":"Enviar um recibo de prestação de serviço (ao invés de NFS-e)"},"cEnviarLinkNfse":{"type":"string","maxLength":1,"description":"Enviar o link da NFS-e gerada na Prefeitura"},"cEnviarBoleto":{"type":"string","maxLength":1,"description":"Enviar também o(s) boleto(s) de cobrança"},"cEnviarPix":{"type":"string","maxLength":1,"description":"Enviar também o(s) PIX(s) de cobrança"},"cUtilizarEmails":{"type":"string","description":"Utilizar os seguintes endereços de e-mail"},"cEnvViaUnica":{"type":"string","maxLength":1,"description":"Enviar ao cliente Via Única (Nota Fiscais Modelos 21 e 22).\n\nPode ser:\nS - Sim\nN - Não"}},"description":"Dados do envio de e-mail do cliente"},"observacoes":{"type":"object","properties":{"cObsContrato":{"type":"string","description":"Observações do Contrato. Essas informação não serão exibidas na Nota Fiscal)."}},"description":"Observações do contrato"},"despesasReembolsaveis":{"type":"object","properties":{"cCodCategReemb":{"type":"string","maxLength":20,"description":"Código da categoria para reembolso"},"despesaReembolsavel":{"type":"array","items":{"type":"object","properties":{"cAcaoReemb":{"type":"string","maxLength":1,"description":"Ação para o reembolso, pode ser:\n\nI - Inclusão\nA - Alteração\nE - Exclusão"},"nCodReemb":{"type":"integer","maxLength":15,"description":"ID do Reembolso"},"dDataReemb":{"type":"string","maxLength":10,"description":"Data do reembolso"},"nValorReemb":{"type":"number","maxLength":18,"description":"Valor do Reembolso"},"cDescReemb":{"type":"string","maxLength":200,"description":"Descrição do reembolso"},"cRecorrenteReemb":{"type":"string","maxLength":1,"description":"Indica se o reembolso é recorrente. [S/N]"}}},"description":"Despesa reembolsável"}},"description":"Despesas reembolsáveis"},"produtosUtilizados":{"type":"object","properties":{"cAcaoProdUtilizados":{"type":"string","maxLength":3,"description":"Pode ser:\nREM - Será gerado uma remessa dos produtos para o cliente.\nEST - Será gerado uma saída de estoque.\nPED - Será gerado um pedido de venda.\n\nObrigatório na inclusão."},"cCodCategRem":{"type":"string","maxLength":20,"description":"Código da Categoria da Remessa ou Pedido de Venda.\n\nObrigatório quando usar [cAcaoFaturamento] como 'REM' ou 'PED'."},"produtoUtilizado":{"type":"array","items":{"type":"object","properties":{"nIdItemPU":{"type":"integer","maxLength":15,"description":"(Código interno utilizado apenas na API).\nNão informar na inclusão.\n\nEsse código não aparece na tela do Omie."},"cAcaoItemPU":{"type":"string","maxLength":1,"description":"Pode ser:\n\n\"A\" - Alterar o item.\n\"E\" - Excluir o item.\n\"I\" - Incluir o item na alteração."},"nCodProdutoPU":{"type":"integer","maxLength":15,"description":"Código interno do produto.\n(utilizado apenas na API).\nEsse código não aparece na tela do Omie."},"nQtdePU":{"type":"number","maxLength":18,"description":"Quantidade."},"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do Local do Estoque."},"lote_validade":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","maxLength":15,"description":"Id do lote do produto.\n\nObrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.."},"nQtdLote":{"type":"number","maxLength":18,"description":"Informe aqui a quantidade do lote para o produto.\n\nÉ obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações."}},"required":["nQtdLote"]},"description":"Informações referentes ao lote e validade do produto.\n\nA tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes \"manualmente\" por API."}}},"description":"Produtos utilizados no serviço."}},"description":"Produtos Utilizados no contrato."},"infoCadastro":{"type":"object","properties":{"dInc":{"type":"string","maxLength":10,"description":"Data da Inclusão.\nNo formato dd/mm/aaaa.\n\nNão deve ser informado na Inclusão/Alteração."},"hInc":{"type":"string","maxLength":8,"description":"Hora da Inclusão.\nNo formato hh:mm:ss.\n\nNão deve ser informado na Inclusão/Alteração."},"uInc":{"type":"string","maxLength":10,"description":"Usuário da Inclusão.\n\nNão deve ser informado na Inclusão/Alteração."},"dAlt":{"type":"string","maxLength":10,"description":"Data da Alteração.\nNo formato dd/mm/aaaa.\n\nNão deve ser informado na Inclusão/Alteração."},"hAlt":{"type":"string","maxLength":8,"description":"Hora da Alteração.\nNo formato hh:mm:ss.\n\nNão deve ser informado na Inclusão/Alteração."},"uAlt":{"type":"string","maxLength":10,"description":"Usuário da Alteração.\n\nNão deve ser informado na Inclusão/Alteração."},"cImpAPI":{"type":"string","maxLength":1,"description":"Importado pela API (S/N).\n\nNão deve ser informado na Inclusão/Alteração."},"cOrigem":{"type":"string","maxLength":3,"description":"Origem do Contrato de Serviço.\n\nInformado na Inclusão."}},"description":"Informações complementares do contrato."}}}}},"example":{"call":"IncluirContrato","param":[{"cabecalho":{"cCodIntCtr":"019289Tb2","cCodSit":"10","cNumCtr":"2020/01001","cTipoFat":"01","dVigFinal":"30/03/2022","dVigInicial":"29/03/2020","nCodCli":2370765,"nDiaFat":30,"nValTotMes":3302},"departamentos":[],"emailCliente":{"cEnviarBoleto":"","cEnviarLinkNfse":"","cEnviarRecibo":"","cUtilizarEmails":""},"infAdic":{"cCidPrestServ":"PETROPOLIS (RJ)","cCodART":"","cCodCateg":"1.01.02","cCodObra":"","cContato":"","cDadosAdicNF":"","nCodCC":1208238,"nCodProj":0,"nCodVend":0},"itensContrato":[{"itemCabecalho":{"codIntItem":"1","cCodCategItem":"","cNaoGerarFinanceiro":"N","codLC116":"3.05","codNBS":"","codServMunic":"01292","codServico":0,"natOperacao":"01","quant":1,"seq":1,"valorDed":0,"valorTotal":3002,"valorUnit":3002},"itemDescrServ":{"descrCompleta":"Serviços prestados"},"itemImpostos":{"aliqCOFINS":0,"aliqCSLL":0,"aliqINSS":0,"aliqIR":0,"aliqISS":5,"aliqPIS":0,"redBaseINSS":0,"retCOFINS":"","retCSLL":"","retINSS":"","retIR":"","retISS":"N","retPIS":"","valorCOFINS":0,"valorCSLL":0,"valorINSS":0,"valorIR":0,"valorISS":150.1,"valorPIS":0},"itemLeiTranspImp":{"aliMunicipal":0,"aliqEstadual":0,"aliqFederal":0,"chave":"","fonte":""}},{"itemCabecalho":{"codIntItem":"2","cCodCategItem":"","cNaoGerarFinanceiro":"N","codLC116":"17.01","codNBS":"","codServMunic":"0162-8/99","codServico":3412648,"natOperacao":"01","quant":1,"seq":2,"valorDed":0,"valorTotal":300,"valorUnit":300},"itemDescrServ":{"descrCompleta":"Homologação de processo contábil"},"itemImpostos":{"aliqCOFINS":0,"aliqCSLL":0,"aliqINSS":0,"aliqIR":0,"aliqISS":3,"aliqPIS":0,"redBaseINSS":0,"retCOFINS":"","retCSLL":"","retINSS":"","retIR":"","retISS":"N","retPIS":"","valorCOFINS":0,"valorCSLL":0,"valorINSS":0,"valorIR":0,"valorISS":9,"valorPIS":0},"itemLeiTranspImp":{"aliMunicipal":0,"aliqEstadual":0,"aliqFederal":0,"chave":"","fonte":""}}],"observacoes":{"cObsContrato":""},"vencTextos":{"cAdContrato":"N","cAdPeriodo":"N","cAdVenc":" ","cAntecipar":"","cCodPerRef":"001","cDiaFim":0,"cDiaIni":0,"cPostergar":"","cProxMes":"","cTpVenc":"001","nDiaFixo":0,"nDias":5}}]}},"servicos_contrato_IncluirContrato_retorno":{"type":"object","properties":{"cCodIntCtr":{"type":"string","description":"Código de Integração do Contrato de Serviço"},"nCodCtr":{"type":"integer","description":"Código da Contrato de Serviço"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDescStatus":{"type":"string","description":"Descrição do Status"}},"title":"IncluirContrato (retorno)"},"servicos_contrato_ListarContratos":{"type":"object","title":"ListarContratos","description":"Lista os contratos cadastrados.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarContratos"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15},"registros_por_pagina":{"type":"integer","maxLength":15},"apenas_importado_api":{"type":"string","maxLength":1},"ordenar_por":{"type":"string","maxLength":100,"description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_descrescente":{"type":"string","maxLength":1},"filtrar_por_data_de":{"type":"string","maxLength":10},"filtrar_por_data_ate":{"type":"string","maxLength":10},"filtrar_apenas_inclusao":{"type":"string","maxLength":1},"filtrar_apenas_alteracao":{"type":"string","maxLength":1},"filtrar_cnpj_cpf":{"type":"string","maxLength":20,"description":"Filtrar os contratos por CNPJ/CPF."},"filtrar_cliente":{"type":"integer","maxLength":15},"cExibeObs":{"type":"string","maxLength":1,"description":"(S/N) Indica se a \"Observação / Dados Adicionais\" serão retornados na listagem."},"cExibirProdutos":{"type":"string","maxLength":1,"description":"Exibir os produtos utilizados (S/N).\n\n\nPreencher com \"S\" ou \"N\"."},"cExibirInfoCadastro":{"type":"string","maxLength":1,"description":"Exibir as informações complementares do contrato (S/N).\n\n\nPreencher com \"S\" ou \"N\"."}}}}},"example":{"call":"ListarContratos","param":[{"pagina":1,"registros_por_pagina":50,"apenas_importado_api":"N"}]}},"servicos_contrato_ListarContratos_retorno":{"type":"object","properties":{"pagina":{"type":"integer"},"total_de_paginas":{"type":"integer"},"registros":{"type":"integer"},"total_de_registros":{"type":"integer"},"contratoCadastro":{"type":"array","items":{"type":"object","properties":{"cabecalho":{"type":"object","properties":{"nCodCtr":{"type":"integer","description":"Código do contrato de serviços. (Gerado internamente, não é visualizado na tela)"},"cCodIntCtr":{"type":"string","description":"Código de integração do contrato de serviços. (Utilizado em contratos criados via API, não é visualizado na tela)"},"nCodCli":{"type":"integer","description":"Código do cliente a que se refere o contrato de serviços. (Gerado internamente, não é visualizado na tela)"},"cNumCtr":{"type":"string","description":"Número do contrato de serviços. (Informado pelo usuário / visualizado na tela)"},"cCodSit":{"type":"string","description":"Código da situação do contrato de serviços. Pode ser: 00 - Em Elaboração 10 - Ativo 90 - Suspenso 99 - Cancelado"},"dVigInicial":{"type":"string","description":"Data da vigência inicial do contrato de serviços."},"dVigFinal":{"type":"string","description":"Data de vigência final do contrato de serviços."},"nDiaFat":{"type":"integer","description":"Dia de faturamento."},"nValTotMes":{"type":"decimal","description":"Valor total mensal do contrato de serviços. (Calculado automaticamente)"},"cTipoFat":{"type":"string","description":"Tipo de Faturamento do Contrato. Pode ser: 01 - Todo Mês (mensal) 02 - A cada 2 meses (bimestral) 03 - A cada 3 meses (trimestral) 06 - A cada 6 meses (semestral) 12 - A cada 12 meses (anual)"}}},"departamentos":{"type":"array","items":{"type":"object","properties":{"cCodDep":{"type":"string","description":"Código do Departamento"},"cDesDep":{"type":"string","description":"Descrição do Departamento"},"nValDep":{"type":"decimal","description":"Valor do rateio"},"nPerDep":{"type":"decimal","description":"Percentual do rateio"}}},"description":"Distribuição por departamento"},"infAdic":{"type":"object","properties":{"cCodCateg":{"type":"string","description":"Código da Categoria"},"nCodVend":{"type":"integer","description":"Código do Vendedor"},"nCodProj":{"type":"integer","description":"Código do Projeto"},"nCodCC":{"type":"integer","description":"Código da Conta Corrente"},"cContato":{"type":"string","description":"Nome do Contato"},"cCidPrestServ":{"type":"string","description":"Cidade da Prestação do Serviço e Estado"},"cCodObra":{"type":"string","description":"Código da Obra"},"cCodART":{"type":"string","description":"Código ART"},"cNumEncap":{"type":"string","description":"Código de Encapsulamento de notas dedutoras"},"cDadosAdicNF":{"type":"string","description":"Dados Adicionais para a Nota Fiscal"},"cUsoConsumo":{"type":"string","description":"Uso e consumo pessoal. (0=Não, 1=Sim)."},"nIdDestinatario":{"type":"integer","description":"ID Cliente para o Destinatário."}}},"vencTextos":{"type":"object","properties":{"cTpVenc":{"type":"string","description":"Tipo de Vencimento. Pode ser: 001-Número de dias após faturar. 002-Fixar dia do mês (1 a 31)."},"nDias":{"type":"integer","description":"Número de Dias para a gerar o contas a receber"},"nDiaFixo":{"type":"integer","description":"Dia de vencimento fixo para a gerar o contas a receber"},"cProxMes":{"type":"string","description":"Define se o vencimento ocorrerá somente no mês seguinte."},"cAntecipar":{"type":"string","description":"Define se deve antecipar o vencimento ao considerar apenas dias úteis"},"cPostergar":{"type":"string","description":"Postergar Sábados, Domingos e Feriados Nacionais"},"cAdPeriodo":{"type":"string","description":"Adicionar o período de referência associado ao faturamento"},"cAdContrato":{"type":"string","description":"Adicionar o \"Nº do Contrato\" à descrição dos serviços na NFS-e"},"cAdVenc":{"type":"string","description":"Adicionar o vencimento da parcela à descrição dos serviços na NFS-e"},"cCodPerRef":{"type":"string","description":"Período de Referência - Código do período de referência para o faturamento. Pode ser: 001 Mês do faturamento 002 Mês Anterior ao faturamento 003 Mês Posterior ao faturamento 004 Período Anterior ao faturamento 005 Período Posterior ao faturamento 006 Período Anterior específico 007 Número da Parcela 008 Período Posterior específico 009 Período Atual específico"},"cDiaIni":{"type":"integer","description":"Dia Inicial - Dia para a data inicial do período de referência associado ao faturamentDia Inicial"},"cDiaFim":{"type":"integer","description":"Dia Final - Dia para a data final do período de referência associado ao faturamento"}}},"itensContrato":{"type":"array","items":{"type":"object","properties":{"itemCabecalho":{"type":"object","properties":{"codItem":{"type":"integer","description":"Identificação do Item do Contrato. (Gerado automaticamente na Inclusão do item do contrato)"},"codIntItem":{"type":"string","description":"Código de integração do item do contrato."},"seq":{"type":"integer","description":"Sequência do Item do Contrato."},"codServico":{"type":"integer","description":"Código Interno do Serviço conforme cadastrado na tabela de serviços. Caso preenchido, irá assumir as informações do cadastro de serviço. Se não for preenchido, assumirá os valores informados na API."},"natOperacao":{"type":"string","description":"Natureza da Operação ou Tipo de Tributação dos Serviços. Caso tenha informado a tag \"codServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. Valores pode variar de acordo com o município. Verifique a legislação da sua cidade para obter os tipos de tributação disponíveis."},"codServMunic":{"type":"string","description":"Código do Serviço Municipal ou CNAE. Caso tenha informado a tag \"codServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. Valores pode variar de acordo com o município. Verifique a legislação da sua cidade para obter os códigos de serviço disponíveis."},"codLC116":{"type":"string","description":"Código do Serviço conforme Lei Complementar (LC 116). Caso tenha informado a tag \"codServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. Tabela única para todos os municípios."},"quant":{"type":"decimal","description":"Quantidade de serviços. Caso tenha informado a tag \"codServico\" o preenchimento passa a ser opcional e irá assumir o valor padrão 1."},"valorUnit":{"type":"decimal","description":"Valor Unitário do serviço. Caso tenha informado a tag \"codServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço."},"cTpDesconto":{"type":"string","description":"Tipo de Desconto. Pode ser: P - Percentual V - Valor"},"valorDesconto":{"type":"decimal","description":"Valor do Desconto."},"aliqDesconto":{"type":"decimal","description":"Aliquota do Desconto."},"valorOutrasRetencoes":{"type":"decimal","description":"Valor de Outras Retenções. (Disponível apenas para cidades que oferecem esse recurso.)"},"valorAcrescimo":{"type":"decimal","description":"Valor de Acréscimos e taxas. (Disponível apenas para cidades que oferecem esse recurso.)"},"codNBS":{"type":"string","description":"Código da Nomenclatura Brasileira de Serviços (NBS). Caso tenha informado a tag \"codServico\" irá assumir o valor informado no cadastro do respectivo serviço."},"cNaoGerarFinanceiro":{"type":"string","description":"Não gerar conta a receber para este item. Informar \"S\" para não gerar movimento financeiro. Informar \"N\" para gerar movimento financeiro."},"cCodCategItem":{"type":"string","description":"Código da Categoria."},"valorDed":{"type":"decimal","description":"Valor de Deduções. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"valorTotal":{"type":"decimal","description":"Valor total do item. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração."}}},"itemDescrServ":{"type":"object","properties":{"descrCompleta":{"type":"string","description":"Informe a descrição completa do serviço prestado"}}},"itemImpostos":{"type":"object","properties":{"aliqISS":{"type":"decimal","description":"Alíquota de ISS."},"valorISS":{"type":"decimal","description":"Valor do ISS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"retISS":{"type":"string","description":"Retém ISS (S/N). Indica se o imposto deve ser retido ou não."},"cUtilizaValorImposto":{"type":"string","description":"Indica se o valor informado para os Impostos Federais deverá ser mantido ao invés de ser recalculado a partir da alíquota. Assim: Caso seja informado \"N\", indica que valor do imposto deve ser calculado a partir da alíquota e base de cálculo. Caso seja informado \"S\", indica que o valor do imposto será mantido e a alíquota será recalculada a partir do valor do imposto e base de cálculo."},"aliqIR":{"type":"decimal","description":"Alíquota de IR. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"valorIR":{"type":"decimal","description":"Valor do IR. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\". Caso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"retIR":{"type":"string","description":"Retém IR (S/N). Indica se o imposto deve ser retido ou não."},"aliqPIS":{"type":"decimal","description":"Alíquota de PIS. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"valorPIS":{"type":"decimal","description":"Valor do PIS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\". Caso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"retPIS":{"type":"string","description":"Retém PIS (S/N). Indica se o imposto deve ser retido ou não."},"aliqCOFINS":{"type":"decimal","description":"Indica se o imposto foi alterado pelo usuário ou informado via importação de planilha ou API. Esse campo é preenchido automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"valorCOFINS":{"type":"decimal","description":"Alíquota de COFINS. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"retCOFINS":{"type":"string","description":"Retém COFINS (S/N). Indica se o imposto deve ser retido ou não."},"aliqCSLL":{"type":"decimal","description":"Alíquota de CSLL. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"valorCSLL":{"type":"decimal","description":"Valor de CSLL. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\". Caso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"retCSLL":{"type":"string","description":"Retém CSLL (S/N). Indica se o imposto deve ser retido ou não."},"aliqINSS":{"type":"decimal","description":"Alíquota de INSS. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"valorINSS":{"type":"decimal","description":"Valor de INSS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\". Caso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"retINSS":{"type":"string","description":"Retém INSS (S/N). Indica se o imposto deve ser retido ou não."},"redBaseINSS":{"type":"decimal","description":"Percentual de Redução da Base de Cálculo do INSS."},"redBasePIS":{"type":"decimal","description":"Percentual de Redução da Base de Cálculo do PIS."},"redBaseCOFINS":{"type":"decimal","description":"Percentual de Redução da Base de Cálculo do COFINS."},"lDeduzISS":{"type":"boolean","description":"Deduz o ISS da Base de Cálculo de PIS e COFINS"},"cstIbsCbs":{"type":"string","description":"Código da Situação Tributária IBS/CBS. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"aliqCbs":{"type":"decimal","description":"Alíquota da CBS Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"aliqIbsUf":{"type":"decimal","description":"Alíquota do IBS Estadual. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"aliqIbsMun":{"type":"decimal","description":"Alíquota do Alíquota do IBS Municipal. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"percReducaoIbsUf":{"type":"decimal","description":"Percentual redução IBS municipal. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"percReducaoIbsMun":{"type":"decimal","description":"Percentual redução IBS estadual. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"percReducaoCbs":{"type":"decimal","description":"Percentual redução CBS. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"classTrib":{"type":"string","description":"Código de Classificação Tributária. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"indOper":{"type":"string","description":"Código Indicador de Operação. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"manIbsMun":{"type":"string","description":"Indica que houve alteração manual da alíquota de IBS Municipal. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"manIbsUf":{"type":"string","description":"Indica que houve alteração manual da alíquota de IBS Estadual. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"manCbs":{"type":"string","description":"Indica que houve alteração manual da alíquota de CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"valorCbs":{"type":"decimal","description":"Valor da CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"valorIbsUf":{"type":"decimal","description":"Valor do IBS Estadual. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"valorIbsMun":{"type":"decimal","description":"Valor do IBS Municipal. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."}}},"itemLeiTranspImp":{"type":"object","properties":{"aliqFederal":{"type":"decimal","description":"Alíquota da Carga Tributária Aprox. Federal"},"aliqEstadual":{"type":"decimal","description":"Alíquota Carga Trib. Aprox. Estadual"},"aliMunicipal":{"type":"decimal","description":"Alíquota Carga Trib. Aprox. Municipal"},"chave":{"type":"string","description":"Chave do IBPT"},"fonte":{"type":"string","description":"Fonte do IBPT"}}},"itemOutrasInf":{"type":"object","properties":{"dItVigInicial":{"type":"string","description":"Data da vigência inicial do item do contrato de serviços"},"dItVigFinal":{"type":"string","description":"Data da vigência final do item do contrato de serviços"},"nTipoItVigFinal":{"type":"integer","description":"Tipo da vigência final do item do contrato de serviços. Valores possiveis: 1 - Data especifica 2 - Segue a vigência final do contrato 3 - Apenas para o proximo faturamento"}},"description":"Outras informações do item do contrato de serviços"},"itemViaUnica":{"type":"object","properties":{"cModeloNF":{"type":"string","description":"Indica qual modelo de NF será emitida para o serviço. Obrigatório quando a tag cEnvViaUnica for igual a \"S\". Pode ser: 21 - Nota Fiscal de Serviço de Comunicação 22 - Nota Fiscal de Serviço de Telecomunicação"},"cCFOP":{"type":"string","description":"Código CFOP para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a \"S\". Utilize a tag \"nCodigo\" do método \"ListarCFOP\" da API /api/v1/produtos/cfop/ para obter essa informação."},"cClassifServico":{"type":"string","description":"Código da Classificação para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a \"S\". Utilize a tag \"cCodigo\" do método \"ListarClassificacaoServico\" da API /api/v1/servicos/classificacaoservico/ para obter essa informação."},"cTipoReceita":{"type":"string","description":"Indicador do Tipo de Receita para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a \"S\". Pode ser: 0 - Receita própria - serviços prestados 1 - Receita própria - cobrança de débitos 2 - Receita própria - venda de mercadorias 3 - Receita própria - venda de serviço pré-pago 4 - Outras receitas próprias 5 - Receitas de terceiros (co-faturamento) 9 - Outras receitas de terceiros"},"cTipoUtilizacao":{"type":"string","description":"Código do tipo de utilização para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a \"S\". Utilize a tag \"cCodigo\" do método \"ListarTipoUtilizacao\" da API /api/v1/servicos/tipoutilizacao/ para obter essa informação."}},"description":"Informações referente ao serviço da NF modelo 21 ou 22."}}}},"emailCliente":{"type":"object","properties":{"cEnviarRecibo":{"type":"string","description":"Enviar um recibo de prestação de serviço (ao invés de NFS-e)"},"cEnviarLinkNfse":{"type":"string","description":"Enviar o link da NFS-e gerada na Prefeitura"},"cEnviarBoleto":{"type":"string","description":"Enviar também o(s) boleto(s) de cobrança"},"cEnviarPix":{"type":"string","description":"Enviar também o(s) PIX(s) de cobrança"},"cUtilizarEmails":{"type":"string","description":"Utilizar os seguintes endereços de e-mail"},"cEnvViaUnica":{"type":"string","description":"Enviar ao cliente Via Única (Nota Fiscais Modelos 21 e 22). Pode ser: S - Sim N - Não"}},"description":"Dados do envio de e-mail do cliente"},"observacoes":{"type":"object","properties":{"cObsContrato":{"type":"string","description":"Observações do Contrato. Essas informação não serão exibidas na Nota Fiscal)."}},"description":"Observações do contrato"},"despesasReembolsaveis":{"type":"object","properties":{"cCodCategReemb":{"type":"string","description":"Código da categoria para reembolso"},"despesaReembolsavel":{"type":"array","items":{"type":"object","properties":{"cAcaoReemb":{"type":"string","description":"Ação para o reembolso, pode ser: I - Inclusão A - Alteração E - Exclusão"},"nCodReemb":{"type":"integer","description":"ID do Reembolso"},"dDataReemb":{"type":"string","description":"Data do reembolso"},"nValorReemb":{"type":"decimal","description":"Valor do Reembolso"},"cDescReemb":{"type":"string","description":"Descrição do reembolso"},"cRecorrenteReemb":{"type":"string","description":"Indica se o reembolso é recorrente. [S/N]"}}},"description":"Despesa reembolsável"}},"description":"Despesas reembolsáveis"},"produtosUtilizados":{"type":"object","properties":{"cAcaoProdUtilizados":{"type":"string","description":"Pode ser: REM - Será gerado uma remessa dos produtos para o cliente. EST - Será gerado uma saída de estoque. PED - Será gerado um pedido de venda. Obrigatório na inclusão."},"cCodCategRem":{"type":"string","description":"Código da Categoria da Remessa ou Pedido de Venda. Obrigatório quando usar [cAcaoFaturamento] como 'REM' ou 'PED'."},"produtoUtilizado":{"type":"array","items":{"type":"object","properties":{"nIdItemPU":{"type":"integer","description":"(Código interno utilizado apenas na API). Não informar na inclusão. Esse código não aparece na tela do Omie."},"cAcaoItemPU":{"type":"string","description":"Pode ser: \"A\" - Alterar o item. \"E\" - Excluir o item. \"I\" - Incluir o item na alteração."},"nCodProdutoPU":{"type":"integer","description":"Código interno do produto. (utilizado apenas na API). Esse código não aparece na tela do Omie."},"nQtdePU":{"type":"decimal","description":"Quantidade."},"codigo_local_estoque":{"type":"integer","description":"Código do Local do Estoque."},"lote_validade":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","description":"Id do lote do produto. Obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.."},"nQtdLote":{"type":"decimal","description":"Informe aqui a quantidade do lote para o produto. É obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações."}}},"description":"Informações referentes ao lote e validade do produto. A tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes \"manualmente\" por API."}}},"description":"Produtos utilizados no serviço."}},"description":"Produtos Utilizados no contrato."},"infoCadastro":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração."},"hInc":{"type":"string","description":"Hora da Inclusão. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração."},"uInc":{"type":"string","description":"Usuário da Inclusão. Não deve ser informado na Inclusão/Alteração."},"dAlt":{"type":"string","description":"Data da Alteração. No formato dd/mm/aaaa. Não deve ser informado na Inclusão/Alteração."},"hAlt":{"type":"string","description":"Hora da Alteração. No formato hh:mm:ss. Não deve ser informado na Inclusão/Alteração."},"uAlt":{"type":"string","description":"Usuário da Alteração. Não deve ser informado na Inclusão/Alteração."},"cImpAPI":{"type":"string","description":"Importado pela API (S/N). Não deve ser informado na Inclusão/Alteração."},"cOrigem":{"type":"string","description":"Origem do Contrato de Serviço. Informado na Inclusão."}},"description":"Informações complementares do contrato."}}},"description":"Cadastro de Contrato de Serviço"}},"title":"ListarContratos (retorno)"},"servicos_contrato_UpsertContrato":{"type":"object","title":"UpsertContrato","description":"Inclui / Altera um contrato","required":["call","param"],"properties":{"call":{"type":"string","enum":["UpsertContrato"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cabecalho":{"type":"object","properties":{"nCodCtr":{"type":"integer","maxLength":15,"description":"Código do contrato de serviços.\n(Gerado internamente, não é visualizado na tela)"},"cCodIntCtr":{"type":"string","maxLength":20,"description":"Código de integração do contrato de serviços.\n(Utilizado em contratos criados via API, não é visualizado na tela)"},"nCodCli":{"type":"integer","maxLength":15,"description":"Código do cliente a que se refere o contrato de serviços.\n(Gerado internamente, não é visualizado na tela)"},"cNumCtr":{"type":"string","maxLength":60,"description":"Número do contrato de serviços.\n(Informado pelo usuário / visualizado na tela)"},"cCodSit":{"type":"string","maxLength":2,"description":"Código da situação do contrato de serviços.\nPode ser:\n00 - Em Elaboração\n10 - Ativo\n90 - Suspenso\n99 - Cancelado"},"dVigInicial":{"type":"string","maxLength":10,"description":"Data da vigência inicial do contrato de serviços."},"dVigFinal":{"type":"string","maxLength":10,"description":"Data de vigência final do contrato de serviços."},"nDiaFat":{"type":"integer","maxLength":2,"description":"Dia de faturamento."},"nValTotMes":{"type":"number","maxLength":18,"description":"Valor total mensal do contrato de serviços.\n(Calculado automaticamente)"},"cTipoFat":{"type":"string","maxLength":2,"description":"Tipo de Faturamento do Contrato.\nPode ser:\n01 - Todo Mês (mensal)\n02 - A cada 2 meses (bimestral)\n03 - A cada 3 meses (trimestral)\n06 - A cada 6 meses (semestral)\n12 - A cada 12 meses (anual)"}}},"departamentos":{"type":"array","items":{"type":"object","properties":{"cCodDep":{"type":"string","maxLength":40,"description":"Código do Departamento"},"cDesDep":{"type":"string","maxLength":50,"description":"Descrição do Departamento"},"nValDep":{"type":"number","maxLength":18,"description":"Valor do rateio"},"nPerDep":{"type":"number","maxLength":10,"description":"Percentual do rateio"}}},"description":"Distribuição por departamento"},"infAdic":{"type":"object","properties":{"cCodCateg":{"type":"string","maxLength":20,"description":"Código da Categoria"},"nCodVend":{"type":"integer","maxLength":15,"description":"Código do Vendedor"},"nCodProj":{"type":"integer","maxLength":15,"description":"Código do Projeto"},"nCodCC":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente"},"cContato":{"type":"string","maxLength":100,"description":"Nome do Contato"},"cCidPrestServ":{"type":"string","maxLength":40,"description":"Cidade da Prestação do Serviço e Estado"},"cCodObra":{"type":"string","maxLength":15,"description":"Código da Obra"},"cCodART":{"type":"string","maxLength":20,"description":"Código ART"},"cNumEncap":{"type":"string","maxLength":15,"description":"Código de Encapsulamento de notas dedutoras"},"cDadosAdicNF":{"type":"string","description":"Dados Adicionais para a Nota Fiscal"},"cUsoConsumo":{"type":"string","maxLength":1,"description":"Uso e consumo pessoal.\n\n(0=Não, 1=Sim)."},"nIdDestinatario":{"type":"integer","maxLength":15,"description":"ID Cliente para o Destinatário."}}},"vencTextos":{"type":"object","properties":{"cTpVenc":{"type":"string","maxLength":3,"description":"Tipo de Vencimento.\n\nPode ser:\n001-Número de dias após faturar.\n002-Fixar dia do mês (1 a 31)."},"nDias":{"type":"integer","maxLength":3,"description":"Número de Dias para a gerar o contas a receber"},"nDiaFixo":{"type":"integer","maxLength":2,"description":"Dia de vencimento fixo para a gerar o contas a receber"},"cProxMes":{"type":"string","maxLength":1,"description":"Define se o vencimento ocorrerá somente no mês seguinte."},"cAntecipar":{"type":"string","maxLength":1,"description":"Define se deve antecipar o vencimento ao considerar apenas dias úteis"},"cPostergar":{"type":"string","maxLength":1,"description":"Postergar Sábados, Domingos e Feriados Nacionais"},"cAdPeriodo":{"type":"string","maxLength":1,"description":"Adicionar o período de referência associado ao faturamento"},"cAdContrato":{"type":"string","maxLength":1,"description":"Adicionar o \"Nº do Contrato\" à descrição dos serviços na NFS-e"},"cAdVenc":{"type":"string","maxLength":1,"description":"Adicionar o vencimento da parcela à descrição dos serviços na NFS-e"},"cCodPerRef":{"type":"string","maxLength":3,"description":"Período de Referência - Código do período de referência para o faturamento.\n\nPode ser:\n001 Mês do faturamento\n002 Mês Anterior ao faturamento\n003 Mês Posterior ao faturamento\n004 Período Anterior ao faturamento\n005 Período Posterior ao faturamento\n006 Período Anterior específico\n007 Número da Parcela\n008 Período Posterior específico\n009 Período Atual específico"},"cDiaIni":{"type":"string","corrigido_pela_convencao":true,"maxLength":2,"description":"Dia Inicial - Dia para a data inicial do período de referência associado ao faturamentDia Inicial"},"cDiaFim":{"type":"string","corrigido_pela_convencao":true,"maxLength":2,"description":"Dia Final - Dia para a data final do período de referência associado ao faturamento"}}},"itensContrato":{"type":"array","items":{"type":"object","properties":{"itemCabecalho":{"type":"object","properties":{"codItem":{"type":"integer","maxLength":15,"description":"Identificação do Item do Contrato.\n\n(Gerado automaticamente na Inclusão do item do contrato)"},"codIntItem":{"type":"string","maxLength":30,"description":"Código de integração do item do contrato."},"seq":{"type":"integer","maxLength":4,"description":"Sequência do Item do Contrato."},"codServico":{"type":"integer","maxLength":15,"description":"Código Interno do Serviço conforme cadastrado na tabela de serviços.\n\n\nCaso preenchido, irá assumir as informações do cadastro de serviço.\n\nSe não for preenchido, assumirá os valores informados na API."},"natOperacao":{"type":"string","maxLength":2,"description":"Natureza da Operação ou Tipo de Tributação dos Serviços.\n\n\nCaso tenha informado a tag \"codServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço.\n\nValores pode variar de acordo com o município. Verifique a legislação da sua cidade para obter os tipos de tributação disponíveis."},"codServMunic":{"type":"string","maxLength":20,"description":"Código do Serviço Municipal ou CNAE.\n\n\nCaso tenha informado a tag \"codServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço.\n\nValores pode variar de acordo com o município. Verifique a legislação da sua cidade para obter os códigos de serviço disponíveis."},"codLC116":{"type":"string","maxLength":10,"description":"Código do Serviço conforme Lei Complementar (LC 116).\n\n\nCaso tenha informado a tag \"codServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço.\n\nTabela única para todos os municípios."},"quant":{"type":"number","maxLength":18,"description":"Quantidade de serviços.\n\n\nCaso tenha informado a tag \"codServico\" o preenchimento passa a ser opcional e irá assumir o valor padrão 1."},"valorUnit":{"type":"number","maxLength":18,"description":"Valor Unitário do serviço.\n\n\nCaso tenha informado a tag \"codServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço."},"cTpDesconto":{"type":"string","maxLength":1,"description":"Tipo de Desconto.\n\n\nPode ser:\nP - Percentual\nV - Valor"},"valorDesconto":{"type":"number","maxLength":18,"description":"Valor do Desconto."},"aliqDesconto":{"type":"number","maxLength":18,"description":"Aliquota do Desconto."},"valorOutrasRetencoes":{"type":"number","maxLength":18,"description":"Valor de Outras Retenções.\n\n\n(Disponível apenas para cidades que oferecem esse recurso.)"},"valorAcrescimo":{"type":"number","maxLength":18,"description":"Valor de Acréscimos e taxas.\n\n\n(Disponível apenas para cidades que oferecem esse recurso.)"},"codNBS":{"type":"string","maxLength":9,"description":"Código da Nomenclatura Brasileira de Serviços (NBS).\n\n\nCaso tenha informado a tag \"codServico\" irá assumir o valor informado no cadastro do respectivo serviço."},"cNaoGerarFinanceiro":{"type":"string","maxLength":1,"description":"Não gerar conta a receber para este item.\n\n\nInformar \"S\" para não gerar movimento financeiro.\nInformar \"N\" para gerar movimento financeiro."},"cCodCategItem":{"type":"string","maxLength":20,"description":"Código da Categoria."},"valorDed":{"type":"number","maxLength":18,"description":"Valor de Deduções.\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"valorTotal":{"type":"number","maxLength":18,"description":"Valor total do item.\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração."}}},"itemDescrServ":{"type":"object","properties":{"descrCompleta":{"type":"string","description":"Informe a descrição completa do serviço prestado"}}},"itemImpostos":{"type":"object","properties":{"aliqISS":{"type":"number","maxLength":10,"description":"Alíquota de ISS."},"valorISS":{"type":"number","maxLength":18,"description":"Valor do ISS.\n\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"retISS":{"type":"string","maxLength":1,"description":"Retém ISS  (S/N).\n\n\nIndica se o imposto deve ser retido ou não."},"cUtilizaValorImposto":{"type":"string","maxLength":1,"description":"Indica se o valor informado para os Impostos Federais deverá ser mantido ao invés de ser recalculado a partir da alíquota.\n\n\nAssim:\n\nCaso seja informado \"N\", indica que valor do imposto deve ser calculado a partir da alíquota e base de cálculo.\n\nCaso seja informado \"S\", indica que o valor do imposto será mantido e a alíquota será recalculada a partir do valor do imposto e base de cálculo."},"aliqIR":{"type":"number","maxLength":10,"description":"Alíquota de IR.\n\n\nPara o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\".\n\nLembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"valorIR":{"type":"number","maxLength":18,"description":"Valor do IR.\n\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\".\n\nCaso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"retIR":{"type":"string","maxLength":1,"description":"Retém IR  (S/N).\n\n\nIndica se o imposto deve ser retido ou não."},"aliqPIS":{"type":"number","maxLength":10,"description":"Alíquota de PIS.\n\n\nPara o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\".\n\nLembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"valorPIS":{"type":"number","maxLength":18,"description":"Valor do PIS.\n\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\".\n\nCaso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"retPIS":{"type":"string","maxLength":1,"description":"Retém PIS  (S/N).\n\n\nIndica se o imposto deve ser retido ou não."},"aliqCOFINS":{"type":"number","maxLength":10,"description":"Indica se o imposto foi alterado pelo usuário ou informado via importação de planilha ou API.\n\nEsse campo é preenchido automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"valorCOFINS":{"type":"number","maxLength":18,"description":"Alíquota de COFINS.\n\n\nPara o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\".\n\nLembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"retCOFINS":{"type":"string","maxLength":1,"description":"Retém COFINS  (S/N).\n\n\nIndica se o imposto deve ser retido ou não."},"aliqCSLL":{"type":"number","maxLength":10,"description":"Alíquota de CSLL.\n\nPara o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\".\n\nLembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"valorCSLL":{"type":"number","maxLength":18,"description":"Valor de CSLL.\n\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\".\n\nCaso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"retCSLL":{"type":"string","maxLength":1,"description":"Retém CSLL  (S/N).\n\n\nIndica se o imposto deve ser retido ou não."},"aliqINSS":{"type":"number","maxLength":10,"description":"Alíquota de INSS.\n\n\nPara o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\".\n\nLembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"valorINSS":{"type":"number","maxLength":18,"description":"Valor de INSS.\n\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\".\n\nCaso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"retINSS":{"type":"string","maxLength":1,"description":"Retém INSS  (S/N).\n\n\nIndica se o imposto deve ser retido ou não."},"redBaseINSS":{"type":"number","maxLength":10,"description":"Percentual de Redução da Base de Cálculo do INSS."},"redBasePIS":{"type":"number","maxLength":10,"description":"Percentual de Redução da Base de Cálculo do PIS."},"redBaseCOFINS":{"type":"number","maxLength":10,"description":"Percentual de Redução da Base de Cálculo do COFINS."},"lDeduzISS":{"type":"boolean","description":"Deduz o ISS da Base de Cálculo de PIS e COFINS"},"cstIbsCbs":{"type":"string","maxLength":3,"description":"Código da Situação Tributária IBS/CBS.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"aliqCbs":{"type":"number","maxLength":10,"description":"Alíquota da CBS\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"aliqIbsUf":{"type":"number","maxLength":10,"description":"Alíquota do IBS Estadual.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"aliqIbsMun":{"type":"number","maxLength":10,"description":"Alíquota do Alíquota do IBS Municipal.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"percReducaoIbsUf":{"type":"number","maxLength":18,"description":"Percentual redução IBS municipal.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"percReducaoIbsMun":{"type":"number","maxLength":18,"description":"Percentual redução IBS estadual.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"percReducaoCbs":{"type":"number","maxLength":18,"description":"Percentual redução CBS.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"classTrib":{"type":"string","maxLength":6,"description":"Código de Classificação Tributária.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"indOper":{"type":"string","maxLength":6,"description":"Código Indicador de Operação.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"manIbsMun":{"type":"string","maxLength":1,"description":"Indica que houve alteração manual da alíquota de IBS Municipal.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"manIbsUf":{"type":"string","maxLength":1,"description":"Indica que houve alteração manual da alíquota de IBS Estadual.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"manCbs":{"type":"string","maxLength":1,"description":"Indica que houve alteração manual da alíquota de CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"valorCbs":{"type":"number","maxLength":18,"description":"Valor da CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"valorIbsUf":{"type":"number","maxLength":18,"description":"Valor do IBS Estadual.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"valorIbsMun":{"type":"number","maxLength":18,"description":"Valor do IBS Municipal.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."}},"required":["aliqCSLL","aliqINSS","aliqIR","aliqPIS","valorCOFINS"]},"itemLeiTranspImp":{"type":"object","properties":{"aliqFederal":{"type":"number","maxLength":10,"description":"Alíquota da Carga Tributária Aprox. Federal"},"aliqEstadual":{"type":"number","maxLength":10,"description":"Alíquota Carga Trib. Aprox. Estadual"},"aliMunicipal":{"type":"number","maxLength":10,"description":"Alíquota Carga Trib. Aprox. Municipal"},"chave":{"type":"string","maxLength":6,"description":"Chave do IBPT"},"fonte":{"type":"string","maxLength":34,"description":"Fonte do IBPT"}}},"itemOutrasInf":{"type":"object","properties":{"dItVigInicial":{"type":"string","maxLength":10,"description":"Data da vigência inicial do item do contrato de serviços"},"dItVigFinal":{"type":"string","maxLength":10,"description":"Data da vigência final do item do contrato de serviços"},"nTipoItVigFinal":{"type":"integer","maxLength":1,"description":"Tipo da vigência final do item do contrato de serviços.\n\nValores possiveis:\n\n1 - Data especifica\n2 - Segue a vigência final do contrato\n3 - Apenas para o proximo faturamento"}},"description":"Outras informações do item do contrato de serviços"},"itemViaUnica":{"type":"object","properties":{"cModeloNF":{"type":"string","maxLength":2,"description":"Indica qual modelo de NF será emitida para o serviço.\n\nObrigatório quando a tag cEnvViaUnica for igual a \"S\".\n\nPode ser:\n21 - Nota Fiscal de Serviço de Comunicação\n22 - Nota Fiscal de Serviço de Telecomunicação"},"cCFOP":{"type":"string","maxLength":10,"description":"Código CFOP para NF Via Única (Modelos 21 e 22).\n\nObrigatório quando a tag cEnvViaUnica for igual a \"S\".\n\nUtilize a tag \"nCodigo\" do método \"ListarCFOP\" da API  /api/v1/produtos/cfop/ para obter essa informação."},"cClassifServico":{"type":"string","maxLength":4,"description":"Código da Classificação para NF Via Única (Modelos 21 e 22).\n\nObrigatório quando a tag cEnvViaUnica for igual a \"S\".\n\nUtilize a tag \"cCodigo\" do método \"ListarClassificacaoServico\" da API\n/api/v1/servicos/classificacaoservico/ para obter essa informação."},"cTipoReceita":{"type":"string","maxLength":1,"description":"Indicador do Tipo de Receita para NF Via Única (Modelos 21 e 22).\n\nObrigatório quando a tag cEnvViaUnica for igual a \"S\".\n\nPode ser:\n0 - Receita própria - serviços prestados\n1 - Receita própria - cobrança de débitos\n2 - Receita própria - venda de mercadorias\n3 - Receita própria - venda de serviço pré-pago\n4 - Outras receitas próprias\n5 - Receitas de terceiros (co-faturamento)\n9 - Outras receitas de terceiros"},"cTipoUtilizacao":{"type":"string","maxLength":1,"description":"Código do tipo de utilização para NF Via Única (Modelos 21 e 22).\n\nObrigatório quando a tag cEnvViaUnica for igual a \"S\".\n\nUtilize a tag \"cCodigo\" do método \"ListarTipoUtilizacao\" da API\n/api/v1/servicos/tipoutilizacao/ para obter essa informação."}},"description":"Informações referente ao serviço da NF modelo 21 ou 22."}}}},"emailCliente":{"type":"object","properties":{"cEnviarRecibo":{"type":"string","maxLength":1,"description":"Enviar um recibo de prestação de serviço (ao invés de NFS-e)"},"cEnviarLinkNfse":{"type":"string","maxLength":1,"description":"Enviar o link da NFS-e gerada na Prefeitura"},"cEnviarBoleto":{"type":"string","maxLength":1,"description":"Enviar também o(s) boleto(s) de cobrança"},"cEnviarPix":{"type":"string","maxLength":1,"description":"Enviar também o(s) PIX(s) de cobrança"},"cUtilizarEmails":{"type":"string","description":"Utilizar os seguintes endereços de e-mail"},"cEnvViaUnica":{"type":"string","maxLength":1,"description":"Enviar ao cliente Via Única (Nota Fiscais Modelos 21 e 22).\n\nPode ser:\nS - Sim\nN - Não"}},"description":"Dados do envio de e-mail do cliente"},"observacoes":{"type":"object","properties":{"cObsContrato":{"type":"string","description":"Observações do Contrato. Essas informação não serão exibidas na Nota Fiscal)."}},"description":"Observações do contrato"},"despesasReembolsaveis":{"type":"object","properties":{"cCodCategReemb":{"type":"string","maxLength":20,"description":"Código da categoria para reembolso"},"despesaReembolsavel":{"type":"array","items":{"type":"object","properties":{"cAcaoReemb":{"type":"string","maxLength":1,"description":"Ação para o reembolso, pode ser:\n\nI - Inclusão\nA - Alteração\nE - Exclusão"},"nCodReemb":{"type":"integer","maxLength":15,"description":"ID do Reembolso"},"dDataReemb":{"type":"string","maxLength":10,"description":"Data do reembolso"},"nValorReemb":{"type":"number","maxLength":18,"description":"Valor do Reembolso"},"cDescReemb":{"type":"string","maxLength":200,"description":"Descrição do reembolso"},"cRecorrenteReemb":{"type":"string","maxLength":1,"description":"Indica se o reembolso é recorrente. [S/N]"}}},"description":"Despesa reembolsável"}},"description":"Despesas reembolsáveis"},"produtosUtilizados":{"type":"object","properties":{"cAcaoProdUtilizados":{"type":"string","maxLength":3,"description":"Pode ser:\nREM - Será gerado uma remessa dos produtos para o cliente.\nEST - Será gerado uma saída de estoque.\nPED - Será gerado um pedido de venda.\n\nObrigatório na inclusão."},"cCodCategRem":{"type":"string","maxLength":20,"description":"Código da Categoria da Remessa ou Pedido de Venda.\n\nObrigatório quando usar [cAcaoFaturamento] como 'REM' ou 'PED'."},"produtoUtilizado":{"type":"array","items":{"type":"object","properties":{"nIdItemPU":{"type":"integer","maxLength":15,"description":"(Código interno utilizado apenas na API).\nNão informar na inclusão.\n\nEsse código não aparece na tela do Omie."},"cAcaoItemPU":{"type":"string","maxLength":1,"description":"Pode ser:\n\n\"A\" - Alterar o item.\n\"E\" - Excluir o item.\n\"I\" - Incluir o item na alteração."},"nCodProdutoPU":{"type":"integer","maxLength":15,"description":"Código interno do produto.\n(utilizado apenas na API).\nEsse código não aparece na tela do Omie."},"nQtdePU":{"type":"number","maxLength":18,"description":"Quantidade."},"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do Local do Estoque."},"lote_validade":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","maxLength":15,"description":"Id do lote do produto.\n\nObrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.."},"nQtdLote":{"type":"number","maxLength":18,"description":"Informe aqui a quantidade do lote para o produto.\n\nÉ obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações."}},"required":["nQtdLote"]},"description":"Informações referentes ao lote e validade do produto.\n\nA tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes \"manualmente\" por API."}}},"description":"Produtos utilizados no serviço."}},"description":"Produtos Utilizados no contrato."},"infoCadastro":{"type":"object","properties":{"dInc":{"type":"string","maxLength":10,"description":"Data da Inclusão.\nNo formato dd/mm/aaaa.\n\nNão deve ser informado na Inclusão/Alteração."},"hInc":{"type":"string","maxLength":8,"description":"Hora da Inclusão.\nNo formato hh:mm:ss.\n\nNão deve ser informado na Inclusão/Alteração."},"uInc":{"type":"string","maxLength":10,"description":"Usuário da Inclusão.\n\nNão deve ser informado na Inclusão/Alteração."},"dAlt":{"type":"string","maxLength":10,"description":"Data da Alteração.\nNo formato dd/mm/aaaa.\n\nNão deve ser informado na Inclusão/Alteração."},"hAlt":{"type":"string","maxLength":8,"description":"Hora da Alteração.\nNo formato hh:mm:ss.\n\nNão deve ser informado na Inclusão/Alteração."},"uAlt":{"type":"string","maxLength":10,"description":"Usuário da Alteração.\n\nNão deve ser informado na Inclusão/Alteração."},"cImpAPI":{"type":"string","maxLength":1,"description":"Importado pela API (S/N).\n\nNão deve ser informado na Inclusão/Alteração."},"cOrigem":{"type":"string","maxLength":3,"description":"Origem do Contrato de Serviço.\n\nInformado na Inclusão."}},"description":"Informações complementares do contrato."}}}}},"example":{"call":"UpsertContrato","param":[{"cabecalho":{"cCodIntCtr":"019289Tb2","cCodSit":"10","cNumCtr":"2020/01001","cTipoFat":"01","dVigFinal":"30/03/2022","dVigInicial":"29/03/2020","nCodCli":2370765,"nDiaFat":30,"nValTotMes":3302},"departamentos":[],"emailCliente":{"cEnviarBoleto":"","cEnviarLinkNfse":"","cEnviarRecibo":"","cUtilizarEmails":""},"infAdic":{"cCidPrestServ":"PETROPOLIS (RJ)","cCodART":"","cCodCateg":"1.01.02","cCodObra":"","cContato":"","cDadosAdicNF":"","nCodCC":1208238,"nCodProj":0,"nCodVend":0},"itensContrato":[{"itemCabecalho":{"codIntItem":"1","cCodCategItem":"","cNaoGerarFinanceiro":"N","codLC116":"3.05","codNBS":"","codServMunic":"01292","codServico":0,"natOperacao":"01","quant":1,"seq":1,"valorDed":0,"valorTotal":3002,"valorUnit":3002},"itemDescrServ":{"descrCompleta":"Serviços prestados"},"itemImpostos":{"aliqCOFINS":0,"aliqCSLL":0,"aliqINSS":0,"aliqIR":0,"aliqISS":5,"aliqPIS":0,"redBaseINSS":0,"retCOFINS":"","retCSLL":"","retINSS":"","retIR":"","retISS":"N","retPIS":"","valorCOFINS":0,"valorCSLL":0,"valorINSS":0,"valorIR":0,"valorISS":150.1,"valorPIS":0},"itemLeiTranspImp":{"aliMunicipal":0,"aliqEstadual":0,"aliqFederal":0,"chave":"","fonte":""}},{"itemCabecalho":{"codIntItem":"2","cCodCategItem":"","cNaoGerarFinanceiro":"N","codLC116":"17.01","codNBS":"","codServMunic":"0162-8/99","codServico":3412648,"natOperacao":"01","quant":1,"seq":2,"valorDed":0,"valorTotal":300,"valorUnit":300},"itemDescrServ":{"descrCompleta":"Homologação de processo contábil"},"itemImpostos":{"aliqCOFINS":0,"aliqCSLL":0,"aliqINSS":0,"aliqIR":0,"aliqISS":3,"aliqPIS":0,"redBaseINSS":0,"retCOFINS":"","retCSLL":"","retINSS":"","retIR":"","retISS":"N","retPIS":"","valorCOFINS":0,"valorCSLL":0,"valorINSS":0,"valorIR":0,"valorISS":9,"valorPIS":0},"itemLeiTranspImp":{"aliMunicipal":0,"aliqEstadual":0,"aliqFederal":0,"chave":"","fonte":""}}],"observacoes":{"cObsContrato":""},"vencTextos":{"cAdContrato":"N","cAdPeriodo":"N","cAdVenc":" ","cAntecipar":"","cCodPerRef":"001","cDiaFim":0,"cDiaIni":0,"cPostergar":"","cProxMes":"","cTpVenc":"001","nDiaFixo":0,"nDias":5}}]}},"servicos_contrato_UpsertContrato_retorno":{"type":"object","properties":{"cCodIntCtr":{"type":"string","description":"Código de Integração do Contrato de Serviço"},"nCodCtr":{"type":"integer","description":"Código da Contrato de Serviço"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDescStatus":{"type":"string","description":"Descrição do Status"}},"title":"UpsertContrato (retorno)"},"servicos_contratofat_AtivarContrato":{"type":"object","title":"AtivarContrato","description":"Ativa um contrato","required":["call","param"],"properties":{"call":{"type":"string","enum":["AtivarContrato"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodCtr":{"type":"integer","maxLength":15,"description":"Código do Contrato de Serviço."}},"required":["nCodCtr"]}}},"example":{"call":"AtivarContrato","param":[{"nCodCtr":0}]}},"servicos_contratofat_AtivarContrato_retorno":{"type":"object","properties":{"nCodCtr":{"type":"integer","description":"Código do Contrato de Serviço."},"cCodStatus":{"type":"string","description":"Código do Status"},"cDescStatus":{"type":"string","description":"Descrição do Status"}},"title":"AtivarContrato (retorno)"},"servicos_contratofat_CancelarContrato":{"type":"object","title":"CancelarContrato","description":"Cancela contrato","required":["call","param"],"properties":{"call":{"type":"string","enum":["CancelarContrato"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodCtr":{"type":"integer","maxLength":15,"description":"Código do Contrato de Serviço."}},"required":["nCodCtr"]}}},"example":{"call":"CancelarContrato","param":[{"nCodCtr":0}]}},"servicos_contratofat_CancelarContrato_retorno":{"type":"object","properties":{"nCodCtr":{"type":"integer","description":"Código do Contrato de Serviço."},"cCodStatus":{"type":"string","description":"Código do Status"},"cDescStatus":{"type":"string","description":"Descrição do Status"}},"title":"CancelarContrato (retorno)"},"servicos_contratofat_FaturarContrato":{"type":"object","title":"FaturarContrato","description":"Fatura um contrato.","required":["call","param"],"properties":{"call":{"type":"string","enum":["FaturarContrato"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodCtr":{"type":"integer","maxLength":15,"description":"Código do Contrato de Serviço."}},"required":["nCodCtr"]}}},"example":{"call":"FaturarContrato","param":[{"nCodCtr":0}]}},"servicos_contratofat_FaturarContrato_retorno":{"type":"object","properties":{"nCodCtr":{"type":"integer","description":"Código do Contrato de Serviço."},"nCodOS":{"type":"integer","description":"Código da Ordem de Serviço gerada."},"cCodStatus":{"type":"string","description":"Código do Status"},"cDescStatus":{"type":"string","description":"Descrição do Status"}},"title":"FaturarContrato (retorno)"},"servicos_contratofat_ObterContratos":{"type":"object","title":"ObterContratos","description":"Obtém os contratos de uma etapa de faturamento.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterContratos"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cEtapa":{"type":"string","maxLength":2,"description":"Código da Etapa.\n\nValores possíveis:\n\n10 - Lista todos os contratos.\n\n20 - Lista somente os contratos ativos, que devem ser faturados até a data atual, que a data atual esteja dentro do período de vigência e ainda não foram faturados no mês.\n\n30 - Lista os contratos faturados no mês atual.\n\n40 - Lista todos os contratos ativos que precisam ser renovados nos próximos 90 dias."}},"required":["cEtapa"]}}},"example":{"call":"ObterContratos","param":[{"cEtapa":"50"}]}},"servicos_contratofat_ObterContratos_retorno":{"type":"object","properties":{"cEtapa":{"type":"string","description":"Código da Etapa. Valores possíveis: 10 - Lista todos os contratos. 20 - Lista somente os contratos ativos, que devem ser faturados até a data atual, que a data atual esteja dentro do período de vigência e ainda não foram faturados no mês. 30 - Lista os contratos faturados no mês atual. 40 - Lista todos os contratos ativos que precisam ser renovados nos próximos 90 dias."},"listaContratos":{"type":"array","items":{"type":"object","properties":{"nCodCtr":{"type":"integer","description":"Código do Contrato de Serviço."},"cNumCtr":{"type":"string","description":"Número do Contrato de Serviços (Informado pelo usuário / visualizado na tela)"}}},"description":"Lista de contratos encontrados na etapa solicitada."}},"title":"ObterContratos (retorno)"},"servicos_contratofat_ReativarContrato":{"type":"object","title":"ReativarContrato","description":"Reativar contrato","required":["call","param"],"properties":{"call":{"type":"string","enum":["ReativarContrato"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodCtr":{"type":"integer","maxLength":15,"description":"Código do Contrato de Serviço."}},"required":["nCodCtr"]}}},"example":{"call":"ReativarContrato","param":[{"nCodCtr":0}]}},"servicos_contratofat_ReativarContrato_retorno":{"type":"object","properties":{"nCodCtr":{"type":"integer","description":"Código do Contrato de Serviço."},"cCodStatus":{"type":"string","description":"Código do Status"},"cDescStatus":{"type":"string","description":"Descrição do Status"}},"title":"ReativarContrato (retorno)"},"servicos_contratofat_SuspenderContrato":{"type":"object","title":"SuspenderContrato","description":"Suspende contrato","required":["call","param"],"properties":{"call":{"type":"string","enum":["SuspenderContrato"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodCtr":{"type":"integer","maxLength":15,"description":"Código do Contrato de Serviço."}},"required":["nCodCtr"]}}},"example":{"call":"SuspenderContrato","param":[{"nCodCtr":0}]}},"servicos_contratofat_SuspenderContrato_retorno":{"type":"object","properties":{"nCodCtr":{"type":"integer","description":"Código do Contrato de Serviço."},"cCodStatus":{"type":"string","description":"Código do Status"},"cDescStatus":{"type":"string","description":"Descrição do Status"}},"title":"SuspenderContrato (retorno)"},"servicos_contratofat_ValidarContrato":{"type":"object","title":"ValidarContrato","description":"Valida os dados de um contrato para faturamento.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ValidarContrato"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodCtr":{"type":"integer","maxLength":15,"description":"Código do Contrato de Serviço."}},"required":["nCodCtr"]}}},"example":{"call":"ValidarContrato","param":[{"nCodCtr":0}]}},"servicos_contratofat_ValidarContrato_retorno":{"type":"object","properties":{"nCodCtr":{"type":"integer","description":"Código do Contrato de Serviço."},"cCodStatus":{"type":"string","description":"Código do Status"},"cDescStatus":{"type":"string","description":"Descrição do Status"}},"title":"ValidarContrato (retorno)"},"servicos_contratolote_FaturarLoteContrato":{"type":"object","title":"FaturarLoteContrato","description":"Faturar Contrato de Serviços em lote a partir da etapa informada.","required":["call","param"],"properties":{"call":{"type":"string","enum":["FaturarLoteContrato"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cCodIntLote":{"type":"string","maxLength":20,"description":"Codigo integração do Lote."}}}}},"example":{"call":"FaturarLoteContrato","param":[{"cCodIntLote":"9999999"}]}},"servicos_contratolote_FaturarLoteContrato_retorno":{"type":"object","properties":{"nQtdeFat":{"type":"integer","description":"Qtde de contratos de serviços faturados."},"nIdLoteFat":{"type":"integer","description":"Id do Lote de Processamento"},"cCodStatus":{"type":"string"},"cDesStatus":{"type":"string"}},"title":"FaturarLoteContrato (retorno)"},"servicos_contratolote_ListarLotesContrato":{"type":"object","title":"ListarLotesContrato","description":"Lista status dos Contratos de Serviços faturadas a partir da data de procesasmento do lote","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarLotesContrato"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15},"nRegistros":{"type":"integer","maxLength":15},"nIdLoteFat":{"type":"integer","maxLength":15,"description":"Id do Lote de Processamento"},"cExibirDetalhes":{"type":"string","maxLength":1,"description":"Exibe detalhamento do processamento por lote (S/N).\n\nDefault \"N\""},"dDtIncDe":{"type":"string","maxLength":10,"description":"Data de Inclusão do processamento"},"dDtIncAte":{"type":"string","maxLength":10,"description":"Data de Inclusão até do processamento"}}}}},"example":{"call":"ListarLotesContrato","param":[{"dDtIncDe":"30/09/2026","dDtIncAte":"30/09/2026"}]}},"servicos_contratolote_ListarLotesContrato_retorno":{"type":"object","properties":{"nPagina":{"type":"integer"},"nTotPaginas":{"type":"integer"},"nRegistros":{"type":"integer"},"nTotRegistros":{"type":"integer"},"lotes":{"type":"array","items":{"type":"object","properties":{"nIdLoteFat":{"type":"integer","description":"Id do Lote de Faturamento da Controle de Serviço"},"nQtdeTotal":{"type":"integer","description":"Quantidade de Contratos de Serviço na Fila"},"nQtdeProcessadas":{"type":"integer","description":"Quantidade de Contratos de Serviço processadas"},"cOrigem":{"type":"string","description":"Origem do faturamento. MAN-Manual SCH-Scheduler API - Integração"},"cStatus":{"type":"string","description":"Status do faturamento. RUNNING DONE ERROR"},"dUltimaAtual":{"type":"string"},"hUltimaAtual":{"type":"string"},"dInicioProc":{"type":"string"},"hInicioProc":{"type":"string"},"dConclusaoProc":{"type":"string"},"hConclusaoProc":{"type":"string"},"detalhes":{"type":"object","properties":{"nIdPedido":{"type":"integer","description":"Id da Ordem de Serviço gerada"},"nIdContrato":{"type":"integer","description":"Id do contrato processado"},"cStatus":{"type":"string","description":"Status do faturamento. RUNNING DONE ERROR"},"cMensagem":{"type":"string","description":"Detalhamento do Status do processamento."}},"description":"Contrato de Serviços que foram processadas pelo lote filtrado"}}},"description":"Contratos de Serviço encontrados para data de faturamento enviadas"}},"title":"ListarLotesContrato (retorno)"},"servicos_contratolote_StatusLoteContrato":{"type":"object","title":"StatusLoteContrato","description":"Status do lote faturado a partir do ID.","required":["call","param"],"properties":{"call":{"type":"string","enum":["StatusLoteContrato"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdLoteFat":{"type":"integer","maxLength":15,"description":"Id do Lote de Faturamento da Ordem de Serviço"}}}}},"example":{"call":"StatusLoteContrato","param":[{"nIdLoteFat":45223245}]}},"servicos_contratolote_StatusLoteContrato_retorno":{"type":"object","properties":{"nIdLoteFat":{"type":"integer","description":"Id do Lote de Faturamento da Ordem de Serviço"},"nQtdeTotal":{"type":"integer","description":"Quantidade de Contrato de Serviço na Fila"},"nQtdeProcessadas":{"type":"integer","description":"Quantidade de Contratos de Serviço processados"},"cOrigem":{"type":"string","description":"Origem do faturamento. MAN-Manual SCH-Scheduler API - Integração"},"cStatus":{"type":"string","description":"Status do faturamento. RUNNING DONE ERROR"},"dUltimaAtual":{"type":"string"},"hUltimaAtual":{"type":"string"},"dInicioProc":{"type":"string"},"hInicioProc":{"type":"string"},"dConclusaoProc":{"type":"string"},"hConclusaoProc":{"type":"string"}},"title":"StatusLoteContrato (retorno)"},"servicos_contratotpfat_ListarTipoFatContrato":{"type":"object","title":"ListarTipoFatContrato","description":"Lista os tipos de faturamento de contrato.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarTipoFatContrato"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"ordenar_por":{"type":"string","maxLength":100,"description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."}}}}},"example":{"call":"ListarTipoFatContrato","param":[{"pagina":1,"registros_por_pagina":20}]}},"servicos_contratotpfat_ListarTipoFatContrato_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada"},"total_de_paginas":{"type":"integer","description":"Número total de páginas"},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"total de registros encontrados"},"cadastros":{"type":"array","items":{"type":"object","properties":{"cCodigo":{"type":"string","description":"Código do tipo de faturamento de contrato."},"cDescricao":{"type":"string","description":"Descrição do tipo de faturamento de contrato."}}},"description":"Lista os tipos de faturamento de contrato."}},"title":"ListarTipoFatContrato (retorno)"},"servicos_ibpt_ListarProdutosIBPT":{"type":"object","title":"ListarProdutosIBPT","description":"Lista os produtos da Tabela do IBPT.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarProdutosIBPT"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"apenas_importado_api":{"type":"string","maxLength":1,"description":"Exibir apenas os registros gerados pela API"},"ordenar_por":{"type":"string","maxLength":100,"description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."}}}}},"example":{"call":"ListarProdutosIBPT","param":[{"pagina":1,"registros_por_pagina":20}]}},"servicos_ibpt_ListarProdutosIBPT_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada"},"total_de_paginas":{"type":"integer","description":"Número total de páginas"},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"total de registros encontrados"},"produtos":{"type":"array","items":{"type":"object","properties":{"nIdIBPT":{"type":"integer","description":"Id do IBPT. (Gerado internamente, não é visualizado na tela)"},"nIdNCM":{"type":"string","description":"Id do NCM. (Gerado internamente, não é visualizado na tela)"},"cDescricao":{"type":"string","description":"Descrição do IBPT."},"dDtInicio":{"type":"string","description":"Data de Início da vigência da Tabela do IBPT."},"dDtFinal":{"type":"string","description":"Data final da vigência da Tabela do IBPT."},"nAliqMun":{"type":"decimal","description":"Alíquota Municipal."},"nAliqEst":{"type":"decimal","description":"Alíquota Estadual."},"nAliqFedNac":{"type":"decimal","description":"Alíquota Federal - Nacional."},"nAliqFedImp":{"type":"decimal","description":"Alíquota Federal - Importação."},"cFonte":{"type":"string","description":"Fonte da Tabela do IBPT."},"cChave":{"type":"string","description":"Chave da Tabela do IBPT."},"cVersao":{"type":"string","description":"Versão da Tabela do IBPT."}}},"description":"Lista os produtos encontrados."}},"title":"ListarProdutosIBPT (retorno)"},"servicos_ibpt_ListarServicosIBPT":{"type":"object","title":"ListarServicosIBPT","description":"Lista os Serviços da Tabela do IBPT.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarServicosIBPT"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"apenas_importado_api":{"type":"string","maxLength":1,"description":"Exibir apenas os registros gerados pela API"},"ordenar_por":{"type":"string","maxLength":100,"description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."}}}}},"example":{"call":"ListarServicosIBPT","param":[{"pagina":1,"registros_por_pagina":20}]}},"servicos_ibpt_ListarServicosIBPT_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada"},"total_de_paginas":{"type":"integer","description":"Número total de páginas"},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"total de registros encontrados"},"servicos":{"type":"array","items":{"type":"object","properties":{"nIdIBPT":{"type":"integer","description":"Id do IBPT. (Gerado internamente, não é visualizado na tela)"},"nIdNBS":{"type":"string","description":"Id do NBS. (Gerado internamente, não é visualizado na tela)"},"cDescricao":{"type":"string","description":"Descrição do IBPT."},"dDtInicio":{"type":"string","description":"Data de Início da vigência da Tabela do IBPT."},"dDtFinal":{"type":"string","description":"Data final da vigência da Tabela do IBPT."},"nAliqMun":{"type":"decimal","description":"Alíquota Municipal."},"nAliqEst":{"type":"decimal","description":"Alíquota Estadual."},"nAliqFedNac":{"type":"decimal","description":"Alíquota Federal - Nacional."},"nAliqFedImp":{"type":"decimal","description":"Alíquota Federal - Importação."},"cFonte":{"type":"string","description":"Fonte da Tabela do IBPT."},"cChave":{"type":"string","description":"Chave da Tabela do IBPT."},"cVersao":{"type":"string","description":"Versão da Tabela do IBPT."}}},"description":"Lista os serviços encontrados."}},"title":"ListarServicosIBPT (retorno)"},"servicos_indoper_ListarIndOper":{"type":"object","title":"ListarIndOper","description":"Lista os indicadores de operações.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarIndOper"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"nRegistrosPorPagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página."},"cDescricao":{"type":"string","maxLength":255,"description":"Nome do Indicador de Operação."}}}}},"example":{"call":"ListarIndOper","param":[{"nPagina":1,"nRegistrosPorPagina":50}]}},"servicos_indoper_ListarIndOper_retorno":{"type":"object","properties":{"nPagina":{"type":"integer","description":"Número da página retornada"},"nTotalPaginas":{"type":"integer","description":"Número total de páginas"},"nRegistrosPorPagina":{"type":"integer","description":"Número de registros retornados na página."},"nTotalRegistros":{"type":"integer","description":"Total de registros encontrados."},"cadastros":{"type":"array","items":{"type":"object","properties":{"cCodigo":{"type":"string","description":"Código do Indicador de Operação."},"cDescricao":{"type":"string","description":"Nome do Indicador de Operação."},"cDescrCompl":{"type":"string","description":"Descrição do Indicador de Operação."}}},"description":"Lista de Indicador de Operação."}},"title":"ListarIndOper (retorno)"},"servicos_lc116_ListarLC116":{"type":"object","title":"ListarLC116","description":"Listar Serviços da LC116.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarLC116"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"ordenar_por":{"type":"string","maxLength":100,"description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."},"cCodigo":{"type":"string","maxLength":10},"apenas_importado_api":{"type":"string","maxLength":1,"description":"DEPRECATED"}}}}},"example":{"call":"ListarLC116","param":[{"pagina":1,"registros_por_pagina":20}]}},"servicos_lc116_ListarLC116_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada"},"total_de_paginas":{"type":"integer","description":"Número total de páginas"},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"total de registros encontrados"},"cadastros":{"type":"array","items":{"type":"object","properties":{"cCodigo":{"type":"string","description":"Código do Serviço."},"cDescricao":{"type":"string","description":"Descrição do Serviço."},"cDescrCompleta":{"type":"string","description":"Descrição Completa do Serviço."}}},"description":"Lista os cadastros encontrados."}},"title":"ListarLC116 (retorno)"},"servicos_listaservico_ListarServMunic":{"type":"object","title":"ListarServMunic","description":"Listar Serviços cadastrados para o município.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarServMunic"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"apenas_importado_api":{"type":"string","maxLength":1,"description":"Exibir apenas os registros gerados pela API"},"ordenar_por":{"type":"string","maxLength":100,"description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."},"cCodServMun":{"type":"string","maxLength":20},"cCodServLC116":{"type":"string","maxLength":10}}}}},"example":{"call":"ListarServMunic","param":[{"pagina":1,"registros_por_pagina":20}]}},"servicos_listaservico_ListarServMunic_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada"},"total_de_paginas":{"type":"integer","description":"Número total de páginas"},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"total de registros encontrados"},"cadastros":{"type":"array","items":{"type":"object","properties":{"nIdCodServMun":{"type":"integer","description":"Id do Código do Serviço no Município. (Gerado internamente, não é visualizado na tela)"},"cCodServMun":{"type":"string","description":"Código do Serviço no Município."},"cDescricao":{"type":"string","description":"Descrição do Código do Serviço no Município."},"cDescrCompleta":{"type":"string","description":"Descrição Completa do Serviço no Município."},"cCodServLC116":{"type":"string","description":"Código do Serviço da LC116."},"cCidade":{"type":"string","description":"Cidade"}}},"description":"Lista os cadastros encontrados."}},"title":"ListarServMunic (retorno)"},"servicos_nbs_ListarNBS":{"type":"object","title":"ListarNBS","description":"Listagem de NBS (Nomenclatura Brasileira de Serviços).","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarNBS"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"ordenar_por":{"type":"string","maxLength":100,"description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."},"apenas_importado_api":{"type":"string","maxLength":1,"description":"DEPRECATED"}}}}},"example":{"call":"ListarNBS","param":[{"pagina":1,"registros_por_pagina":20}]}},"servicos_nbs_ListarNBS_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada"},"total_de_paginas":{"type":"integer","description":"Número total de páginas"},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"total de registros encontrados"},"cadastros":{"type":"array","items":{"type":"object","properties":{"nIdNBS":{"type":"string","description":"Id do NBS. (Gerado internamente, não é visualizado na tela)"},"cCodigo":{"type":"string","description":"Código NBS (Nomenclatura Brasileira de Serviços)."},"cDescricao":{"type":"string","description":"Descrição do NBS (Nomenclatura Brasileira de Serviços)."}}},"description":"Lista os cadastros encontrados."}},"title":"ListarNBS (retorno)"},"servicos_nfse_ListarNFSEs":{"type":"object","title":"ListarNFSEs","description":"Lista de NFS-es.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarNFSEs"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15},"nRegPorPagina":{"type":"integer","maxLength":15},"dEmiInicial":{"type":"string","maxLength":10,"description":"Data de emissão inicial."},"hEmiInicial":{"type":"string","maxLength":8,"description":"Hora de emissão inicial."},"dEmiFinal":{"type":"string","maxLength":10,"description":"Data de emissão final."},"hEmiFinal":{"type":"string","maxLength":8,"description":"Hora de emissão final."},"nNumeroNFSe":{"type":"string","maxLength":20,"description":"Número da NFS-e emitida."},"cSerieNFSe":{"type":"string","maxLength":10,"description":"Série da NFS-e emitida."},"cCodigoVerifNFSe":{"type":"string","maxLength":50,"description":"Código de Verificação da NFS-e."},"nCodNF":{"type":"integer","maxLength":15,"description":"Código da Nota Fiscal gerada.\n(Gerado Internamente, não é exibido na tela)"},"nChaveNFe":{"type":"string","maxLength":44,"description":"Chave da NF-e.\n(para emissões em Brasilia-DF)."},"cAmbienteNFSe":{"type":"string","maxLength":1,"description":"Ambiente da NFS-e.\n\nPode Ser:\n\nH-Homologação\nP-Produção."},"nCodigoCliente":{"type":"integer","maxLength":15,"description":"Código do Cliente (destinatário da NFS-e)."},"cCodigoCategoria":{"type":"string","maxLength":20,"description":"Código da Categoria."},"nCodigoCC":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente."},"nCodigoProjeto":{"type":"integer","maxLength":15,"description":"Código do Projeto."},"nCodigoVendedor":{"type":"integer","maxLength":15,"description":"Código do Vendedor."},"nCodigoOS":{"type":"integer","maxLength":15,"description":"Código da Ordem de Serviço."},"nNumeroOS":{"type":"string","maxLength":15,"description":"Número da Ordem de Serviço."},"nCodigoContrato":{"type":"integer","maxLength":15,"description":"Código do Contrato."},"cNumeroContrato":{"type":"string","maxLength":20,"description":"Número do Contrato"},"cStatusNFSe":{"type":"string","maxLength":1,"description":"Status da NFS-e.\n\nPode ser:\n\n\"C\"-Cancelada.\n\"F\"-Faturada.\n\"N\"-Não faturada."},"cExibirDepartamentos":{"type":"string","maxLength":1,"description":"Listar os departamentos da Ordem de Serviço (S/N)."},"cExibirDescricao":{"type":"string","maxLength":1,"description":"Exibir descrição do Serviço (S/N)."}}}}},"example":{"call":"ListarNFSEs","param":[{"nPagina":1,"nRegPorPagina":20}]}},"servicos_nfse_ListarNFSEs_retorno":{"type":"object","properties":{"nPagina":{"type":"integer"},"nTotPaginas":{"type":"integer"},"nRegistros":{"type":"integer"},"nTotRegistros":{"type":"integer"},"nfseEncontradas":{"type":"array","items":{"type":"object","properties":{"Cabecalho":{"type":"object","properties":{"nNumeroNFSe":{"type":"string","description":"Número da NFS-e emitida."},"cSerieNFSe":{"type":"string","description":"Série da NFS-e emitida."},"nValorNFSe":{"type":"decimal","description":"Valor da NFS-e"},"cStatusNFSe":{"type":"string","description":"Status da NFS-e. Pode ser: \"C\"-Cancelada. \"F\"-Faturada. \"N\"-Não faturada."},"cCodigoVerifNFSe":{"type":"string","description":"Código de Verificação da NFS-e."},"nCodNF":{"type":"integer","description":"Código da Nota Fiscal gerada. (Gerado Internamente, não é exibido na tela)"},"nChaveNFe":{"type":"string","description":"Chave da NF-e. (para emissões em Brasilia-DF)."},"cAmbienteNFSe":{"type":"string","description":"Ambiente da NFS-e. Pode Ser: H-Homologação P-Produção."},"cCidadeEmissor":{"type":"string","description":"Cidade do Emissor da NFS-e."},"cCNPJEmissor":{"type":"string","description":"CNPJ do Emissor."},"cIMEmissor":{"type":"string","description":"Inscrição Municipal do Emissor."},"cCNPJDestinatario":{"type":"string","description":"CNPJ do Destinatário."},"cCPFDestinatario":{"type":"string","description":"CPF do destinatário."},"cIMDestinatario":{"type":"string","description":"Inscrição Municipal do destinatário."},"nCodigoCliente":{"type":"integer","description":"Código do Cliente (destinatário da NFS-e)."},"cRazaoDestinatario":{"type":"string","description":"Razão Social ou Nome Completo do destinatário da NFS-e."},"cRazaoEmissor":{"type":"string","description":"Razão Social ou Nome Completo do emissor da NFS-e."},"cCodMunEmissor":{"type":"string","description":"Código do Município da cidade do emissor."},"cCodMunDestinatario":{"type":"string","description":"Código do Município da cidade do destinatário."}},"description":"Cabeçalho da NFS-e."},"OrdemServico":{"type":"object","properties":{"nCodigoOS":{"type":"integer","description":"Código da Ordem de Serviço."},"nNumeroOS":{"type":"string","description":"Número da Ordem de Serviço."},"nValorOS":{"type":"decimal","description":"Valor da Ordem de Serviço."},"nCodigoContrato":{"type":"integer","description":"Código do Contrato."},"cNumeroContrato":{"type":"string","description":"Número do Contrato"},"cPedidoCliente":{"type":"string","description":"Número do Pedido do Cliente."},"Departamentos":{"type":"array","items":{"type":"object","properties":{"cCodigoDepartamento":{"type":"string","description":"Código do Departamento."},"nPercentualDistribuicao":{"type":"decimal","description":"Percentual da distribuição."},"nValorDistribuicao":{"type":"decimal","description":"Valor da distribuição."},"nValorFixo":{"type":"string","description":"Indica que o valor foi fixado na distribuição (S/N)."}}},"description":"Distribuição por Departamentos."},"Categorias":{"type":"array","items":{"type":"object","properties":{"cCodigoCategoria":{"type":"string","description":"Código do Categoria."},"nPercentualDistribuicao":{"type":"decimal","description":"Percentual da distribuição."},"nValorDistribuicao":{"type":"decimal","description":"Valor da distribuição."},"nValorFixo":{"type":"string","description":"Indica que o valor foi fixado na distribuição (S/N)."}}},"description":"Distribuição por Categorias."}},"description":"Dados da Ordem de Serviço."},"RPS":{"type":"object","properties":{"nNumeroLote":{"type":"integer","description":"Número do Lote da RPS."},"nStatusLote":{"type":"string","description":"Status do Lote da RPS."},"nNumeroRPS":{"type":"string","description":"Número da RPS."},"cStatusRPS":{"type":"string","description":"Status da RPS."},"cSerieRPS":{"type":"string","description":"Série da RPS."},"cProtocoloRPS":{"type":"string","description":"Número do Protocolo do RPS."},"cDataRPS":{"type":"string","description":"Data da RPS."}},"description":"Dados da RPS"},"Adicionais":{"type":"object","properties":{"cCodigoCategoria":{"type":"string","description":"Código da Categoria."},"nCodigoCC":{"type":"integer","description":"Código da Conta Corrente."},"nCodigoProjeto":{"type":"integer","description":"Código do Projeto."},"nCodigoVendedor":{"type":"integer","description":"Código do Vendedor."},"nIdDestinatario":{"type":"integer","description":"ID Cliente para o Destinatário"}},"description":"Informações adicionais."},"Servicos":{"type":"object","properties":{"CidadePrestacao":{"type":"string","description":"Cidade da Prestação de Serviços."},"CodigoLC116":{"type":"string","description":"Código da LC116."},"CodigoServico":{"type":"string","description":"Código do Serviço no município."},"cCodigoObra":{"type":"string","description":"Código da Obra."},"cCodigoART":{"type":"string","description":"Código ART."},"cCodigoEncapsulamento":{"type":"string","description":"Código do encapsulamento."},"nQuantidade":{"type":"decimal"},"nValorUnitario":{"type":"decimal"},"nValorServico":{"type":"decimal"},"nValorTotal":{"type":"decimal"},"nValorOutrasDespesas":{"type":"decimal"},"nDescontoValor":{"type":"decimal"},"nAliquotaISS":{"type":"decimal"},"nValorISS":{"type":"decimal"},"cRetISS":{"type":"string"},"nAliquotaIR":{"type":"decimal"},"nValorIR":{"type":"decimal"},"cRetIR":{"type":"string"},"nAliquotaPIS":{"type":"decimal"},"nValorPIS":{"type":"decimal"},"cRetPIS":{"type":"string"},"nAliquotaCOFINS":{"type":"decimal"},"nValorCOFINS":{"type":"decimal"},"cRetCOFINS":{"type":"string"},"nAliquotaCSLL":{"type":"decimal"},"nValorCSLL":{"type":"decimal"},"cRetCSLL":{"type":"string"},"nAliquotaINSS":{"type":"decimal"},"nValorINSS":{"type":"decimal"},"cRetINSS":{"type":"string"},"cDescricao":{"type":"string","description":"Descrição do serviço."},"nValorCbs":{"type":"decimal","description":"Valor da CBS."},"nAliqCBS":{"type":"decimal","description":"Alíquota da CBS."},"nAliqIbsUf":{"type":"decimal","description":"Alíquota do IBS de competência das UF"},"nAliqIbsMun":{"type":"decimal","description":"Alíquota do IBS de competência do Município."},"cClassTrib":{"type":"string","description":"Código de Classificação Tributária do IBS e CBS"},"cCST":{"type":"string","description":"Código da Situação Tributária do IBS e CBS"},"nValorIbsMun":{"type":"decimal","description":"Valor do IBS de competência do Município"},"nValorIbsUf":{"type":"decimal","description":"Valor do IBS de competência da UF"},"nPercReducaoIbsUf":{"type":"decimal","description":"Percentual redução IBS estadual"},"nPercReducaoIbsMun":{"type":"decimal","description":"Percentual redução IBS municipal"},"nPercReducaoCbs":{"type":"decimal","description":"Percentual redução CBS."},"nBaseIbsCbs":{"type":"decimal","description":"Valor da Base de Calculo do IBS e CBS"}},"description":"Dados dos Serviços. Utilizar \"ListaServicos\" para ter acesso a todos os itens da NFS-e. DEPRECATED"},"Valores":{"type":"object","properties":{"nValorTotalServicos":{"type":"decimal","description":"Valor Total dos serviços."},"nValorBaseCalculo":{"type":"decimal","description":"Valor da Base de Cálculo."},"nValorDeducao":{"type":"decimal","description":"Valor da Dedução."},"cIssRetido":{"type":"string","description":"Indica que o valor do ISS será retido pelo tomador do serviço"},"nValorISS":{"type":"decimal","description":"Valor do ISS"},"nAliquotaISS":{"type":"decimal","description":"Alíquota do ISS"},"nValorPIS":{"type":"decimal","description":"Valor do PIS"},"nValorCOFINS":{"type":"decimal","description":"Valor do COFINS."},"nValorIR":{"type":"decimal","description":"Valor do IR."},"nValorINSS":{"type":"decimal","description":"Valor do INSS."},"nValorCSLL":{"type":"decimal","description":"Valor do CSLL."},"nValorLiquido":{"type":"decimal","description":"Valor líquido da Nota Fiscal."},"nBaseIbsCbs":{"type":"decimal","description":"Valor total da base de cálculo do IBS e da CBS"},"nValorCbs":{"type":"decimal","description":"Valor da CBS."},"nValorIbsMun":{"type":"decimal","description":"Valor total do IBS do município"},"nValorIbsUf":{"type":"decimal","description":"Valor do IBS da UF"}},"description":"Valores da NFS-e"},"IBPT":{"type":"object","properties":{"CodigoNBS":{"type":"string","description":"Código NBS."},"nValorEstadualIBPT":{"type":"decimal","description":"Valor do IBPT - Estadual."},"nValorFederalIBPT":{"type":"decimal","description":"Valor do IBPT - Federal."},"nValorMunicipalIBPT":{"type":"decimal","description":"Valor do IBPT - Municipal."},"nAliqEstadualIBPT":{"type":"decimal","description":"Alíquota do IBPT - Estadual."},"nAliqFederalIBPT":{"type":"decimal","description":"Alíquota do IBPT - Federal."},"nAliqMunicipalIBPT":{"type":"decimal","description":"Alíquota do IBPT - Municipal."},"cFonteIBPT":{"type":"string","description":"Fonte do IBPT."},"cChaveIBPT":{"type":"string","description":"Chave do IBPT."}},"description":"Dados do IBPT."},"Inclusao":{"type":"object","properties":{"cDataInclusao":{"type":"string","description":"Data da inclusão."},"cHoraInclusao":{"type":"string","description":"Hora de inclusão."},"cUsuarioInclusao":{"type":"string","description":"Usuário que realizou a inclusão."}},"description":"Dados da Inclusão"},"Alteracao":{"type":"object","properties":{"cDataAlteracao":{"type":"string","description":"Data da alteração."},"cHoraAlteracao":{"type":"string","description":"Hora de alteração."},"cUsuarioAlteracao":{"type":"string","description":"Usuário que realizou a alteração."}},"description":"Dados da Alteração"},"Emissao":{"type":"object","properties":{"cDataEmissao":{"type":"string","description":"Data da emissão."},"cHoraEmissao":{"type":"string","description":"Hora de emissão."},"cUsuarioEmissao":{"type":"string","description":"Usuário que realizou a emissão."}},"description":"Dados da emissão"},"Cancelamento":{"type":"object","properties":{"cDataCancelamento":{"type":"string","description":"Data da inclusão."},"cHoraCancelamento":{"type":"string","description":"Hora de inclusão."},"cUsuarioCancelamento":{"type":"string","description":"Usuário que realizou a inclusão."},"cMotivoCancelamento":{"type":"string","description":"Motivo do cancelamento da NFS-e."}},"description":"Dados do Cancelamento."},"ListaServicos":{"type":"array","items":{"type":"object","properties":{"CidadePrestacao":{"type":"string","description":"Cidade da Prestação de Serviços."},"CodigoLC116":{"type":"string","description":"Código da LC116."},"CodigoServico":{"type":"string","description":"Código do Serviço no município."},"cCodigoObra":{"type":"string","description":"Código da Obra."},"cCodigoART":{"type":"string","description":"Código ART."},"cCodigoEncapsulamento":{"type":"string","description":"Código do encapsulamento."},"nQuantidade":{"type":"decimal"},"nValorUnitario":{"type":"decimal"},"nValorServico":{"type":"decimal"},"nValorTotal":{"type":"decimal"},"nValorOutrasDespesas":{"type":"decimal"},"nDescontoValor":{"type":"decimal"},"nAliquotaISS":{"type":"decimal"},"nValorISS":{"type":"decimal"},"cRetISS":{"type":"string"},"nAliquotaIR":{"type":"decimal"},"nValorIR":{"type":"decimal"},"cRetIR":{"type":"string"},"nAliquotaPIS":{"type":"decimal"},"nValorPIS":{"type":"decimal"},"cRetPIS":{"type":"string"},"nAliquotaCOFINS":{"type":"decimal"},"nValorCOFINS":{"type":"decimal"},"cRetCOFINS":{"type":"string"},"nAliquotaCSLL":{"type":"decimal"},"nValorCSLL":{"type":"decimal"},"cRetCSLL":{"type":"string"},"nAliquotaINSS":{"type":"decimal"},"nValorINSS":{"type":"decimal"},"cRetINSS":{"type":"string"},"cDescricao":{"type":"string","description":"Descrição do serviço."},"nValorCbs":{"type":"decimal","description":"Valor da CBS."},"nAliqCBS":{"type":"decimal","description":"Alíquota da CBS."},"nAliqIbsUf":{"type":"decimal","description":"Alíquota do IBS de competência das UF"},"nAliqIbsMun":{"type":"decimal","description":"Alíquota do IBS de competência do Município."},"cClassTrib":{"type":"string","description":"Código de Classificação Tributária do IBS e CBS"},"cCST":{"type":"string","description":"Código da Situação Tributária do IBS e CBS"},"nValorIbsMun":{"type":"decimal","description":"Valor do IBS de competência do Município"},"nValorIbsUf":{"type":"decimal","description":"Valor do IBS de competência da UF"},"nPercReducaoIbsUf":{"type":"decimal","description":"Percentual redução IBS estadual"},"nPercReducaoIbsMun":{"type":"decimal","description":"Percentual redução IBS municipal"},"nPercReducaoCbs":{"type":"decimal","description":"Percentual redução CBS."},"nBaseIbsCbs":{"type":"decimal","description":"Valor da Base de Calculo do IBS e CBS"}}},"description":"Listas de itens da Nota Fiscal."}}},"description":"Lista de NF-es encontradas."}},"title":"ListarNFSEs (retorno)"},"servicos_ordemservico_AdicionarItemOs":{"type":"object","title":"AdicionarItemOs","description":"Solicitação de inclusão de item para a OS.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AdicionarItemOs"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodOS":{"type":"integer","maxLength":15,"description":"Código da ordem de serviço. Informe nCodOS, cCodIntOS ou cNumOS."},"cCodIntOS":{"type":"string","maxLength":60,"description":"Código de integração da ordem de serviço. Informe nCodOS, cCodIntOS ou cNumOS."},"cNumOS":{"type":"string","maxLength":15,"description":"Número da ordem de serviço.\nConforme visualizado na tela pelo cliente."},"nCodServico":{"type":"integer","maxLength":15,"description":"Código interno do serviço conforme cadastrado na tabela de serviços. Obrigatório.\nPossível identificar através do método: https://app.omie.com.br/api/v1/geral/servicos/#ListarServicos\nAcessando a tag \"nCodServ\" dentro do objeto \"cabec\"."},"nQtde":{"type":"number","maxLength":18,"description":"Quantidade de serviços. Padrão 1; precisa ser maior que zero."},"nValUnit":{"type":"number","maxLength":18,"description":"Valor unitário do serviço. Obrigatório e maior que zero."},"cTpDesconto":{"type":"string","maxLength":1,"description":"Pode ser:\nP - Percentual\nV - Valor"},"nValorDesconto":{"type":"number","maxLength":18,"description":"Valor do desconto."},"nAliqDesconto":{"type":"number","maxLength":18,"description":"Alíquota do desconto."},"nAliqISS":{"type":"number","maxLength":10,"description":"Alíquota de ISS do item."},"cRetemISS":{"type":"string","maxLength":1,"description":"Retém ISS (S/N)."},"cTribServ":{"type":"string","maxLength":2,"description":"Tipo de tributação do serviço.\nPossível identificar através do método: https://app.omie.com.br/api/v1/servicos/tipotrib/#ListarTiposTrib\nAcessando a tag \"cIdTrib\"."},"cCodCateg":{"type":"string","maxLength":20,"description":"Código da Categoria."},"cNaoGerarFinanceiro":{"type":"string","maxLength":1,"description":"Não gerar conta a receber para este item.\nInformar \"S\" para não gerar movimento financeiro.\nInformar \"N\" para gerar movimento financeiro."}},"required":["nCodServico","nValUnit"]}}},"example":{"call":"AdicionarItemOs","param":[{"nCodOS":0,"cCodIntOS":"","cNumOS":"","nCodServico":0,"nQtde":1,"nValUnit":25,"cTpDesconto":"V","nValorDesconto":0,"nAliqDesconto":0,"nAliqISS":5,"cRetemISS":"S","cTribServ":"01","cCodCateg":"1.01.02","cNaoGerarFinanceiro":"N"}]}},"servicos_ordemservico_AdicionarItemOs_retorno":{"type":"object","properties":{"cCodStatus":{"type":"string","description":"Código de Status"},"cDesStatus":{"type":"string","description":"Descrição do Status"},"cNumOS":{"type":"string","description":"Número da ordem de serviço."},"nCodOS":{"type":"integer","description":"Código da ordem de serviço."},"nCodItem":{"type":"integer","description":"Código do item criado na ordem de serviço."}},"title":"AdicionarItemOs (retorno)"},"servicos_ordemservico_AdicionarOs":{"type":"object","title":"AdicionarOs","description":"Solicitação de inclusão de OS resumida.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AdicionarOs"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodCC":{"type":"integer","maxLength":15,"description":"Código da conta corrente da OS. Obrigatório.\nPara enviar PIX (cEnvPix \"S\"), a conta precisa ter PIX habilitado."},"nIdCliente":{"type":"integer","maxLength":15,"description":"Código do cliente.\nObrigatório envio caso não enviar [cCnpjCpf]."},"cCnpjCpf":{"type":"string","maxLength":20,"description":"CNPJ ou CPF do cliente.\nObrigatório caso não enviar [nIdCliente]. O documento é validado e o cliente precisa já estar cadastrado (esta operação não cadastra cliente)."},"cCodParc":{"type":"string","maxLength":3,"description":"Código da condição de pagamento (parcelas). Padrão 999.\nUtilize o método \"ListarParcelas\" da API /api/v1/geral/parcelas/ para obter os códigos."},"cCodCateg":{"type":"string","maxLength":20,"description":"Código da categoria de receita da OS. Obrigatório."},"cCidPrestServ":{"type":"string","maxLength":40,"description":"Cidade da prestação do serviço, no formato \"CIDADE (UF)\". Obrigatório.\nÉ validada no cadastro de cidades."},"cEtapa":{"type":"string","maxLength":2,"description":"Etapa da OS: 00, 10, 20, 30, 40 ou 50. Padrão 10.\nSó posiciona a OS; esta operação não fatura."},"cDadosAdicNF":{"type":"string","description":"Dados adicionais para a NFS-e. Use | (pipe) como separador de linhas."},"cEnviarPara":{"type":"string","description":"E-mails para onde a NFS-e e os anexos serão enviados quando a OS for faturada."},"cEnvLink":{"type":"string","maxLength":1,"description":"Enviar o link da NFS-e por e-mail (S/N)."},"cEnvBoleto":{"type":"string","maxLength":1,"description":"Enviar boleto por e-mail (S/N). Não pode ser \"S\" junto com cEnvPix."},"cEnvPix":{"type":"string","maxLength":1,"description":"Enviar PIX por e-mail (S/N). Exige conta corrente com PIX; não pode ser \"S\" junto com cEnvBoleto."},"cEnvViaUnica":{"type":"string","maxLength":1,"description":"Enviar via única (S/N). Padrão N."},"cEnvRecibo":{"type":"string","maxLength":1,"description":"Enviar recibo (S/N). Padrão N."},"dDataPrevisao":{"type":"string","maxLength":10,"description":"Data de previsão (dd/mm/aaaa). Padrão hoje. Não pode ser anterior a 365 dias atrás."},"dDataCompetencia":{"type":"string","maxLength":10,"description":"Data de competência da NFS-e (dd/mm/aaaa). Não pode ser anterior a 365 dias atrás."},"nCodVend":{"type":"integer","maxLength":15,"description":"Código do vendedor."},"cCodObra":{"type":"string","maxLength":15,"description":"Código da obra (construção civil)."},"cCodART":{"type":"string","maxLength":20,"description":"Código da ART (Anotação de Responsabilidade Técnica)."},"cOrigem":{"type":"string","maxLength":3,"description":"Indica qual a origem da ordem de serviço.\nDefault:\nAPI - Importado via API"},"cObservacao":{"type":"string","description":"Observações internas da OS. Use | (pipe) como separador de linhas."},"cUsoConsumo":{"type":"string","maxLength":1,"description":"Uso ou consumo pessoal (S/N), para a Reforma Tributária. Padrão N."},"nIdDestinatario":{"type":"integer","maxLength":15,"description":"Código do cliente destinatário, quando diferente do tomador (Reforma Tributária)."},"ServicosPrestados":{"type":"array","items":{"type":"object","properties":{"nCodServico":{"type":"string","maxLength":20,"description":"Código interno do serviço conforme cadastrado na tabela de serviços. Obrigatório.\nPossível identificar através do método: https://app.omie.com.br/api/v1/geral/servicos/#ListarServicos\nAcessando a tag \"nCodServ\" dentro do objeto \"cabec\"."},"nQtde":{"type":"number","maxLength":18,"description":"Quantidade de serviços. Padrão 1; precisa ser maior que zero."},"nValUnit":{"type":"number","maxLength":18,"description":"Valor unitário do serviço. Obrigatório e maior que zero."},"cTpDesconto":{"type":"string","maxLength":1,"description":"Pode ser:\nP - Percentual\nV - Valor"},"nValorDesconto":{"type":"number","maxLength":18,"description":"Valor do desconto."},"nAliqDesconto":{"type":"number","maxLength":18,"description":"Alíquota do desconto."},"nValorOutrasRetencoes":{"type":"number","maxLength":18,"description":"Valor de outras retenções.\nDisponível apenas para cidades que oferecem esse recurso."},"nValorAcrescimos":{"type":"number","maxLength":18,"description":"Valor de acréscimos e taxas.\nDisponível apenas para cidades que oferecem esse recurso."},"cTribServ":{"type":"string","maxLength":2,"description":"Tipo de tributação do serviço.\nPossível identificar através do método: https://app.omie.com.br/api/v1/servicos/tipotrib/#ListarTiposTrib\nAcessando a tag \"cIdTrib\"."},"cCodCategItem":{"type":"string","maxLength":20,"description":"Código da Categoria."},"cCodServLC116":{"type":"string","maxLength":20,"description":"Código do serviço conforme Lei Complementar (LC 116)."},"cCodServMun":{"type":"string","maxLength":20,"description":"Código do serviço municipal ou CNAE.\nValores pode variar de acordo com o município. Verifique a legislação da sua cidade para obter os códigos de serviço disponíveis."},"cNaoGerarFinanceiro":{"type":"string","maxLength":1,"description":"Não gerar conta a receber para este item.\nInformar \"S\" para não gerar movimento financeiro.\nInformar \"N\" para gerar movimento financeiro."},"impostos":{"type":"object","properties":{"nValorDeducao":{"type":"number","maxLength":18,"description":"Valor de dedução.\nPor padrão, esse campo afeta a base de cálculo do ISS.\nPara atender a condições legais acordadas para cada munícipio pode afetar as Bases de Cálculos dos Impostos Federais também. Consulte a legislação do seu município."},"cUtilizaValorImposto":{"type":"string","maxLength":1,"description":"Aceita S/N, mas hoje não tem efeito nesta operação: PIS, COFINS, CSLL, IR e INSS são sempre calculados a partir da alíquota, e os valores informados desses impostos são ignorados."},"cDeduzISS":{"type":"string","maxLength":1,"description":"Deduz o ISS da base de cálculo de PIS e COFINS (S/N)."},"cRetemISS":{"type":"string","maxLength":1,"description":"Retém ISS (S/N).\nPadrão é \"N\".\nIndica se o imposto deve ser retido ou não."},"nAliqISS":{"type":"number","maxLength":10,"description":"Alíquota de ISS."},"nValorISS":{"type":"number","maxLength":18,"description":"Valor do ISS.\nSe informado, é gravado como valor do ISS do item; senão, o Omie calcula pela alíquota."},"cRetemCSLL":{"type":"string","maxLength":1,"description":"Retém CSLL  (S/N).\nPadrão é \"N\".\nIndica se o imposto deve ser retido ou não."},"nAliqCSLL":{"type":"number","maxLength":10,"description":"Alíquota de CSLL.\nLembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"nValorCSLL":{"type":"number","maxLength":18,"description":"Valor de CSLL.\nIgnorado nesta operação: o Omie calcula o valor pela alíquota informada."},"cRetemIRRF":{"type":"string","maxLength":1,"description":"Retém IRRF  (S/N).\nPadrão é \"N\".\nIndica se o imposto deve ser retido ou não."},"nAliqIRRF":{"type":"number","maxLength":10,"description":"Alíquota de IRRF.\nLembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"nValorIRRF":{"type":"number","maxLength":18,"description":"Valor do IRRF.\nIgnorado nesta operação: o Omie calcula o valor pela alíquota informada."},"nValorDeducaoIRRF":{"type":"number","maxLength":18,"description":"Valor da dedução do IR."},"cRetemINSS":{"type":"string","maxLength":1,"description":"Retém INSS  (S/N).\nPadrão é \"N\".\nIndica se o imposto deve ser retido ou não."},"nAliqINSS":{"type":"number","maxLength":10,"description":"Alíquota de INSS.\nLembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"nValorINSS":{"type":"number","maxLength":18,"description":"Valor de INSS.\nIgnorado nesta operação: o Omie calcula o valor pela alíquota informada."},"nAliqRedBaseINSS":{"type":"number","maxLength":10,"description":"Percentual de dedução da base de cálculo do INSS."},"cRetemPIS":{"type":"string","maxLength":1,"description":"Retém PIS  (S/N).\nPadrão é \"N\".\nIndica se o imposto deve ser retido ou não."},"nAliqPIS":{"type":"number","maxLength":10,"description":"Alíquota de PIS.\nLembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"nValorPIS":{"type":"number","maxLength":18,"description":"Valor do PIS.\nIgnorado nesta operação: o Omie calcula o valor pela alíquota informada."},"nAliqRedBasePIS":{"type":"number","maxLength":10,"description":"Percentual de redução da base de cálculo do PIS."},"cRetemCOFINS":{"type":"string","maxLength":1,"description":"Retém COFINS  (S/N).\nPadrão é \"N\".\nIndica se o imposto deve ser retido ou não."},"nAliqCOFINS":{"type":"number","maxLength":10,"description":"Alíquota de COFINS.\nLembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"nValorCOFINS":{"type":"number","maxLength":18,"description":"Valor do COFINS.\nIgnorado nesta operação: o Omie calcula o valor pela alíquota informada."},"nAliqRedBaseCOFINS":{"type":"number","maxLength":10,"description":"Percentual de redução da base de cálculo do COFINS."},"cCST":{"type":"string","maxLength":3,"description":"Código da Situação Tributária IBS/CBS.\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"cClassTrib":{"type":"string","maxLength":6,"description":"Código de Classificação Tributária.\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"cIndOPer":{"type":"string","maxLength":6,"description":"Código Indicador de Operação.\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"nBaseCalcIbsCbs":{"type":"number","maxLength":18,"description":"Valor da Base de Calculo do IBS e CBS."},"nAliqIbsMun":{"type":"number","maxLength":10,"description":"Alíquota do Alíquota do IBS Municipal.\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"nPercReducaoIbsMun":{"type":"number","maxLength":18,"description":"Percentual redução IBS municipal.\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"nAliqIbsUf":{"type":"number","maxLength":10,"description":"Alíquota do IBS estadual.\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"nPercReducaoIbsUf":{"type":"number","maxLength":18,"description":"Percentual redução IBS estadual.\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"nAliqCbs":{"type":"number","maxLength":10,"description":"Alíquota do CBS.\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"nPercReducaoCbs":{"type":"number","maxLength":18,"description":"Percentual redução CBS.\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."}},"description":"Impostos do item."}},"required":["nCodServico","nValUnit"]},"description":"Serviços prestados. Obrigatório, com ao menos um item."}},"required":["cCidPrestServ","cCodCateg","nCodCC"]}}},"example":{"call":"AdicionarOs","param":[{"nCodCC":0,"nIdCliente":0,"nCodVend":0,"cCnpjCpf":"455.763.860-00","cCodParc":"000","cCodCateg":"1.01.02","cCidPrestServ":"BELO HORIZONTE (MG)","cEtapa":"50","cCodObra":"","cCodART":"","cDadosAdicNF":"OS da proposta 60895665","cEnviarPara":"nfse.marketplace@mercantil.com.br","cEnvLink":"N","cEnvBoleto":"N","cEnvPix":"N","cEnvViaUnica":"N","cEnvRecibo":"N","dDataPrevisao":"23/09/2026","dDataCompetencia":"23/09/2026","cOrigem":"","cObservacao":"","ServicosPrestados":[{"nCodServico":0,"nQtde":1,"nValUnit":25,"cTpDesconto":"V","nValorDesconto":5,"nAliqDesconto":0,"nValorOutrasRetencoes":0,"nValorAcrescimos":0,"cTribServ":"01","cCodCategItem":"1.01.02","cCodServLC116":"1.04","cCodServMun":"","cNaoGerarFinanceiro":"N","impostos":{"nValorDeducao":0,"cUtilizaValorImposto":"N","cDeduzISS":"N","cRetemISS":"N","nAliqISS":0,"nValorISS":0,"cRetemCSLL":"N","nAliqCSLL":0,"nValorCSLL":0,"cRetemIRRF":"N","nAliqIRRF":0,"nValorIRRF":0,"nValorDeducaoIRRF":0,"cRetemINSS":"N","nAliqINSS":0,"nValorINSS":0,"nAliqRedBaseINSS":0,"cRetemPIS":"N","nAliqPIS":0,"nValorPIS":0,"nAliqRedBasePIS":0,"cRetemCOFINS":"N","nAliqCOFINS":0,"nValorCOFINS":0,"nAliqRedBaseCOFINS":0}}]}]}},"servicos_ordemservico_AdicionarOs_retorno":{"type":"object","properties":{"cCodStatus":{"type":"string","description":"Código de Status"},"cDesStatus":{"type":"string","description":"Descrição do Status"},"nCodOS":{"type":"integer","description":"Código da ordem de serviço gerada."},"cNumOS":{"type":"string","description":"Número da ordem de serviço gerada."}},"title":"AdicionarOs (retorno)"},"servicos_os_AlterarOS":{"type":"object","title":"AlterarOS","description":"Operação para alterar uma Ordem de Serviço.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarOS"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"Cabecalho":{"type":"object","properties":{"cCodIntOS":{"type":"string","maxLength":60,"description":"Código de Integração da OS.\nObrigatório na inclusão."},"nCodOS":{"type":"integer","maxLength":15,"description":"Código da Ordem de Serviço"},"cNumOS":{"type":"string","maxLength":15,"description":"Número da Ordem de Serviço\n(Conforme visualizada em tela pelo cliente)"},"cCodIntCli":{"type":"string","maxLength":60,"description":"Código de Integração do Cliente"},"nCodCli":{"type":"integer","maxLength":15,"description":"Código do Cliente"},"dDtPrevisao":{"type":"string","maxLength":10,"description":"Data de Previsão"},"cEtapa":{"type":"string","maxLength":2,"description":"Código da etapa do processo, sendo:\n\n10 - Primeira coluna\n20 - Segunda coluna\n30 - Terceira coluna\n40 - Quarta coluna\n50 - Faturar"},"nCodVend":{"type":"integer","maxLength":15,"description":"Código do Vendedor"},"nQtdeParc":{"type":"integer","maxLength":3,"description":"Quantidade de Parcelas"},"cCodParc":{"type":"string","maxLength":3,"description":"Código da parcela/Condição de pagamento.\n\nUtilize a tag \"nCodigo\" do método \"ListarFormasPagVendas\" da API\nhttp://app.omie.com.br/api/v1/produtos/formaspagvendas/\npara obter essa informação.\n\nO código \"999\" é o único que permite uma definição de forma de pagamento customizada. Caso você escolha essa opção, deve também informar a tag \"qtde_parcelas\" e a estrutura \"lista_parcelas\".\n\nAlguns dos valores disponíveis são:\n\n\"000\" - A Vista\n\"A03\" - Para 3 dias\n\"A05\" - Para 5 dias\n\"A07\" - Para 7 dias\n\"A08\" - Para 8 dias\n\"A09\" - Para 9 dias\n\"A10\" - Para 10 dias\n\"A13\" - Para 13 dias\n\"A14\" - Para 14 dias\n\"A15\" - Para 15 dias\n\"A17\" - Para 17 dias\n\"A20\" - Para 20 dias\n\"A21\" - Para 21 dias\n\"A25\" - Para 25 dias\n\"A26\" - Para 26 dias\n\"A28\" - Para 28 dias\n\"A35\" - Para 35 dias\n\"A36\" - Para 36 dias\n\"A40\" - Para 40 dias\n\"A42\" - Para 42 dias\n\"A45\" - Para 45 dias\n\"A50\" - Para 50 dias\n\"A56\" - Para 56 dias\n\"A60\" - Para 60 dias\n\"A70\" - Para 70 dias\n\"A75\" - Para 75 dias\n\"A90\" - Para 90 dias\n\"A98\" - Para 98 dias\n\"B20\" - Para 120 dias\n\"001\" - 1 Parcela (para 30 dias)\n\"002\" - 2 Parcelas\n\"003\" - 3 Parcelas\n\"004\" - 4 Parcelas\n\"005\" - 5 Parcelas\n\"006\" - 6 Parcelas\n\"007\" - 7 Parcelas\n\"010\" - 10 Parcelas\n\"012\" - 12 Parcelas\n\"024\" - 24 Parcelas\n\"036\" - 36 Parcelas\n\"048\" - 48 Parcelas\n\"S01\" - 30/60\n\"S02\" - 45/60\n\"S03\" - 21/28/35\n\"S04\" - 21/28/35/42\n\"S05\" - 28/35/42\n\"S06\" - 28/35/42/49\n\"S07\" - 30/45/60/75/90\n\"S08\" - 25/56\n\"S09\" - 30/45\n\"S10\" - 28/56\n\"S11\" - 10/30/60\n\"S12\" - 15/30/60\n\"S13\" - 28/35\n\"S14\" - 7/14/21\n\"S15\" - 10/30/60/90\n\"S16\" - 60/90/120\n\"S17\" - 45/60/90\n\"S18\" - 30/60/90\n\"S19\" - 14/21\n\"S20\" - 7/14\n\"S21\" - 14/21/28\n\"S22\" - 45/75\n\"S23\" - 30/45/60\n\"S24\" - 3/20/40\n\"S25\" - 30/60/90/120\n\"S26\" - 21/28\n\"S27\" - a Vista/15\n\"S28\" - a Vista/30\n\"S29\" - a Vista/30/60\n\"S30\" - a Vista/30/60/90\n\"S31\" - a Vista/30/60/90/120/150\n\"S41\" - 28/42/56\n\"S32\" - 15/45/75\n\"S33\" - 14/28/42\n\"S34\" - 14/21/28/35/42\n\"S35\" - 30/42/54/66/78/90\n\"S36\" - 14/21/28/35\n\"S37\" - 28/42\n\"S38\" - 30/45/60\n\"S39\" - 35/42/49/56\n\"S40\" - 28/42/56/70\n\"S42\" - 30/40/50/60\n\"S43\" - 30/50/70/90\n\"S44\" - 14/28\n\"S45\" - 45/60/75/90\n\"S46\" - a Vista/30/60/90/120\n\"S47\" - a vista/20/40/60\n\"S48\" - 21/42\n\"S49\" - 15/30/45\n\"S50\" - 14/42\n\"S51\" - 21/35\n\"S52\" - 28/56/84\n\"S53\" - 28/42/56/70/84\n\"S54\" - a Vista/30/45\n\"S55\" - 21/45\n\"S56\" - a Vista/28\n\"S57\" - a Vista/60/90\n\"S58\" - 35/45/55\n\"S59\" - 28/35/42/56\n\"S60\" - 30/45/60/75\n\"S61\" - 28/35/42/49/56\n\"S62\" - 40/70/100\n\"S63\" - 42/56\n\"S64\" - a Vista/28/35\n\"S65\" - 35/42\n\"S66\" - 20/40\n\"S67\" - a Vista/28/35/42"},"cDescParc":{"type":"string","maxLength":30,"description":"Descrição da parcela.\n\nUtilizado apenas para retorno do método \"ConsultarOS\"."},"nValorTotal":{"type":"number","maxLength":18,"description":"Valor total da Ordem de Serviço.\n\nNão deve ser informado na inclusão ou alteração.\nCampo calculado automaticamente."},"nValorTotalImpRet":{"type":"number","maxLength":18,"description":"Valor Total de Impostos Retidos"},"nCodCtr":{"type":"integer","maxLength":15,"description":"Código do Contrato.\nAo informar esse campo será incluído ao contrato uma Ordem de Serviço adicional.\n\nUtilizado somente na Inclusão/Alteração.\n\nUtilize a tag \"nCodCtr\" do método \"ListarContrato\" da API\n/api/v1/servicos/contrato/\npara obter essa informação"}},"description":"Cabeçalho da Ordem de Serviço"},"InformacoesAdicionais":{"type":"object","properties":{"cCodCateg":{"type":"string","maxLength":20,"description":"Categoria"},"nCodCC":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente"},"cNumPedido":{"type":"string","maxLength":30,"description":"Número do Pedido do Cliente"},"cNumContrato":{"type":"string","maxLength":20,"description":"Número do Contrato de Venda"},"cContato":{"type":"string","maxLength":100,"description":"Contato"},"cDadosAdicNF":{"type":"string","description":"Dados Adicionais da Nota Fiscal"},"cCodObra":{"type":"string","maxLength":15,"description":"Código da Obra"},"cCodART":{"type":"string","maxLength":20,"description":"Código ART"},"nCodProj":{"type":"integer","maxLength":15,"description":"Código do Projeto"},"cCidPrestServ":{"type":"string","maxLength":40,"description":"Cidade da Prestação do Serviço"},"dDataRps":{"type":"string","maxLength":10,"description":"Data da RPS"},"cNumRecibo":{"type":"string","maxLength":10,"description":"Número do Recibo gerado.\n(Gerado automaticamente. Se informado na inclusão será ignorado)."},"cUsoConsumo":{"type":"string","maxLength":1,"description":"Uso e consumo pessoal."},"nIdDestinatario":{"type":"integer","maxLength":15,"description":"ID Cliente para o Destinatário."},"DetalhesNfse":{"type":"object","properties":{"Eventos":{"type":"object","properties":{"cCidadeEvento":{"type":"string","maxLength":40,"description":"Código da Cidade da Prestação de Serviços."},"cCodPaisEvento":{"type":"string","maxLength":4,"description":"Código do país do evento."},"cEndExtEvento":{"type":"string","maxLength":255,"description":"Endereço no Exterior do evento.\n\nA tag [cExtEvento] precisa ser preenchida como \"S\"."},"cBairroEvento":{"type":"string","maxLength":60,"description":"Bairro do Evento."},"cCepEvento":{"type":"string","maxLength":10,"description":"CEP do Evento."},"cEndEvento":{"type":"string","maxLength":60,"description":"Endereço do envento."},"cNumEndEvento":{"type":"string","maxLength":10,"description":"Número do endereço do evento."},"cUfEvento":{"type":"string","maxLength":2,"description":"Estado do evento."},"dDtIniEvento":{"type":"string","description":"Data de Início do Evento."},"dDtFimEvento":{"type":"string","description":"Data Final do Evento."},"cNomeEvento":{"type":"string","maxLength":60,"description":"Nome do evento."},"cComplEvento":{"type":"string","maxLength":40,"description":"Completo do endereço do evento."},"cCodAtivEvento":{"type":"string","maxLength":30,"description":"Código de Atividade do evento."},"cExtEvento":{"type":"string","maxLength":1,"description":"Evento no Exterior S/N."},"cCidadeExtEvento":{"type":"string","maxLength":60,"description":"Cidade do evento no exterior.\n\nA tag [cExtEvento] precisa ser preenchida como \"S\"."}},"description":"Evento na Nfse."}},"description":"Detalhes da NFSE."}}},"Email":{"type":"object","properties":{"cEnvRecibo":{"type":"string","maxLength":1,"description":"Enviar um recibo de prestação de serviços (ao invés da NFS-e)"},"cEnvLink":{"type":"string","maxLength":1,"description":"Enviar ao Cliente e-mail com o link do site da prefeitura para consultar  a NFSe emitida."},"cEnvBoleto":{"type":"string","maxLength":1,"description":"Enviar ao cliente e-mail com os Boletos de Cobrança gerados pelo faturamento.\n\nÉ permitido somente o preenchimento de uma das tags \"cEnvPix\" ou \"cEnvBoleto\"."},"cEnvPix":{"type":"string","maxLength":1,"description":"Enviar ao cliente e-mail com o PIX de Cobrança gerado pelo faturamento.\n\nÉ permitido somente o preenchimento de uma das tags \"cEnvPix\" ou \"cEnvBoleto\"."},"cEnviarPara":{"type":"string","description":"Utilizar os seguintes endereços de e-mail"},"cEnvViaUnica":{"type":"string","maxLength":1,"description":"Enviar ao cliente Via Única (Notas Fiscais Modelos 21 e 22).\n\nPode ser:\nS - Sim\nN - Não"}}},"Departamentos":{"type":"array","items":{"type":"object","properties":{"cCodDepto":{"type":"string","maxLength":40,"description":"ID do Departamento.\n\nInformação localizada na Aba \"Departamentos\" do Pedido de Venda.\n\nUtilize a tag \"codigo\" do método \"ListarDepatartamentos\" da API\nhttp://app.omie.com.br/api/v1/geral/departamentos/\npara obter essa informação."},"nPerc":{"type":"number","maxLength":10,"description":"Percentual de Rateio.\n\nInformação localizada na Aba \"Departamentos\" do Pedido de Venda."},"nValor":{"type":"number","maxLength":18,"description":"Valor do Rateio.\n\nInformação localizada na Aba \"Departamentos\" do Pedido de Venda."},"nValorFixo":{"type":"string","maxLength":1,"description":"Indica que o valor foi fixado na distribuição do rateio.\n\nInformar \"S\" ou \"N\".\n\nInformação localizada na Aba \"Departamentos\" do Pedido de Venda."}}},"description":"Dados da Aba \"Departamentos\" do Pedido de Venda."},"ServicosPrestados":{"type":"array","items":{"type":"object","properties":{"nCodServico":{"type":"integer","maxLength":15,"description":"Código Interno do Serviço conforme cadastrado na tabela de serviços.\n\n\nCaso preenchido, irá assumir as informações do cadastro de serviço.\n\nSe não for preenchido, assumirá os valores informados na API."},"cCodIntServico":{"type":"string","maxLength":60,"description":"Código de Integração do Serviço conforme cadastrado na tabela de serviços.\n\n\nCaso preenchido, irá assumir as informações do cadastro de serviço.\n\nSe não for preenchido, assumirá os valores informados na API."},"cTribServ":{"type":"string","maxLength":2,"description":"Tipo de Tributação dos Serviços.\n\n\nCaso tenha informado a tag \"nCodServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço.\n\nValores pode variar de acordo com o município. Verifique a legislação da sua cidade para obter os tipos de tributação disponíveis."},"cCodServMun":{"type":"string","maxLength":20,"description":"Código do Serviço Municipal ou CNAE.\n\n\nCaso tenha informado a tag \"nCodServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço.\n\nValores pode variar de acordo com o município. Verifique a legislação da sua cidade para obter os códigos de serviço disponíveis."},"cCodServLC116":{"type":"string","maxLength":20,"description":"Código do Serviço conforme Lei Complementar (LC 116).\n\n\nCaso tenha informado a tag \"nCodServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço.\n\nTabela única para todos os municípios."},"nQtde":{"type":"number","maxLength":18,"description":"Quantidade de serviços."},"nValUnit":{"type":"number","maxLength":18,"description":"Valor Unitário do serviço.\n\n\nCaso tenha informado a tag \"nCodServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço."},"cTpDesconto":{"type":"string","maxLength":1,"description":"Tipo de Desconto.\n\n\nPode ser:\nP - Percentual\nV - Valor"},"nValorDesconto":{"type":"number","maxLength":18,"description":"Valor do Desconto."},"nAliqDesconto":{"type":"number","maxLength":18,"description":"Aliquota do Desconto."},"nValorOutrasRetencoes":{"type":"number","maxLength":18,"description":"Valor de Outras Retenções.\n\n\n(Disponível apenas para cidades que oferecem esse recurso.)"},"nValorAcrescimos":{"type":"number","maxLength":18,"description":"Valor de Acréscimos e taxas.\n\n\n(Disponível apenas para cidades que oferecem esse recurso.)"},"cDescServ":{"type":"string","description":"Descrição dos Serviços.\n\n\nCaso tenha informado a tag \"nCodServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço."},"cRetemISS":{"type":"string","maxLength":1,"description":"Retem ISS (S/N)"},"cDadosAdicItem":{"type":"string","description":"Dados adicionais do Item."},"cNbs":{"type":"string","maxLength":9,"description":"Código da Nomenclatura Brasileira de Serviços (NBS).\n\n\nCaso tenha informado a tag \"nCodServico\" irá assumir o valor informado no cadastro do respectivo serviço."},"impostos":{"type":"object","properties":{"cFixarISS":{"type":"string","maxLength":1,"description":"Indica se o imposto foi alterado pelo usuário ou informado via importação de planilha ou API.\n\nEsse campo é preenchido automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"nAliqISS":{"type":"number","maxLength":10,"description":"Alíquota de ISS."},"nBaseISS":{"type":"number","maxLength":18,"description":"Base de Cálculo do ISS.\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"nTotDeducao":{"type":"number","maxLength":18,"description":"Valor de Dedução da Base de Cálculo.\n\n\nPor padrão, esse campo afeta a Base de Cálculo do ISS.\n\nPara atender a condições legais acordadas para cada munícipio pode afetar as Bases de Cálculos dos Impostos Federais também. Consulte a legislação do seu município."},"nValorDeducao":{"type":"number","maxLength":18,"description":"Valor das deduções do item.\n\nUtilizado apenas nos métodos de Consulta/Listagem."},"nValorISS":{"type":"number","maxLength":18,"description":"Valor do ISS.\n\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"cUtilizaValorImposto":{"type":"string","maxLength":1,"description":"Indica se o valor informado para os Impostos Federais deverá ser mantido ao invés de ser recalculado a partir da alíquota.\n\n\nAssim:\n\nCaso seja informado \"N\", indica que valor do imposto deve ser calculado a partir da alíquota e base de cálculo.\n\nCaso seja informado \"S\", indica que o valor do imposto será mantido e a alíquota será recalculada a partir do valor do imposto e base de cálculo."},"cFixarIRRF":{"type":"string","maxLength":1,"description":"Indica se o imposto foi alterado pelo usuário ou informado via importação de planilha ou API.\n\nEsse campo é preenchido automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"nAliqIRRF":{"type":"number","maxLength":10,"description":"Alíquota de IRRF.\n\n\nPara o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\".\n\nLembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"nValorIRRF":{"type":"number","maxLength":18,"description":"Valor do IRRF.\n\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\".\n\nCaso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"nValorDeducaoIRRF":{"type":"number","maxLength":18,"description":"Valor da dedução da base do IR."},"cRetemIRRF":{"type":"string","maxLength":1,"description":"Retém IRRF  (S/N).\n\n\nIndica se o imposto deve ser retido ou não."},"cFixarPIS":{"type":"string","maxLength":1,"description":"Indica se o imposto foi alterado pelo usuário ou informado via importação de planilha ou API.\n\nEsse campo é preenchido automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"nAliqPIS":{"type":"number","maxLength":10,"description":"Alíquota de PIS.\n\n\nPara o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\".\n\nLembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"nValorPIS":{"type":"number","maxLength":18,"description":"Valor do PIS.\n\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\".\n\nCaso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"cRetemPIS":{"type":"string","maxLength":1,"description":"Retém PIS  (S/N).\n\n\nIndica se o imposto deve ser retido ou não."},"cFixarCOFINS":{"type":"string","maxLength":1,"description":"Indica se o imposto foi alterado pelo usuário ou informado via importação de planilha ou API.\n\nEsse campo é preenchido automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"nAliqCOFINS":{"type":"number","maxLength":10,"description":"Alíquota de COFINS.\n\n\nPara o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\".\n\nLembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"nValorCOFINS":{"type":"number","maxLength":18,"description":"Valor do COFINS.\n\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\".\n\nCaso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"cRetemCOFINS":{"type":"string","maxLength":1,"description":"Retém COFINS  (S/N).\n\n\nIndica se o imposto deve ser retido ou não."},"cFixarCSLL":{"type":"string","maxLength":1,"description":"Indica se o imposto foi alterado pelo usuário ou informado via importação de planilha ou API.\n\nEsse campo é preenchido automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"nAliqCSLL":{"type":"number","maxLength":10,"description":"Alíquota de CSLL.\n\nPara o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\".\n\nLembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"nValorCSLL":{"type":"number","maxLength":18,"description":"Valor de CSLL.\n\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\".\n\nCaso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"cRetemCSLL":{"type":"string","maxLength":1,"description":"Retém CSLL  (S/N).\n\n\nIndica se o imposto deve ser retido ou não."},"cFixarINSS":{"type":"string","maxLength":1,"description":"Indica se o imposto foi alterado pelo usuário ou informado via importação de planilha ou API.\n\nEsse campo é preenchido automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"nAliqINSS":{"type":"number","maxLength":10,"description":"Alíquota de INSS.\n\n\nPara o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\".\n\nLembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"nValorINSS":{"type":"number","maxLength":18,"description":"Valor de INSS.\n\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\".\n\nCaso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"cRetemINSS":{"type":"string","maxLength":1,"description":"Retém INSS  (S/N).\n\n\nIndica se o imposto deve ser retido ou não."},"nAliqRedBaseINSS":{"type":"number","maxLength":10,"description":"Percentual de Redução da Base de Cálculo do INSS."},"nAliqRedBaseCOFINS":{"type":"number","maxLength":10,"description":"Percentual de Redução da Base de Cálculo do COFINS."},"nAliqRedBasePIS":{"type":"number","maxLength":10,"description":"Percentual de Redução da Base de Cálculo do PIS."},"lDeduzISS":{"type":"boolean","description":"Deduz o ISS da Base de Cálculo de PIS e COFINS"},"cCST":{"type":"string","maxLength":3,"description":"Código da Situação Tributária IBS/CBS.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"cClassTrib":{"type":"string","maxLength":6,"description":"Código de Classificação Tributária.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"nAliqIbsUf":{"type":"number","maxLength":10,"description":"Alíquota do IBS estadual.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"nAliqIbsMun":{"type":"number","maxLength":10,"description":"Alíquota do IBS Municipal.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"nPercReducaoIbsUf":{"type":"number","maxLength":18,"description":"Percentual redução IBS estadual.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"nPercReducaoIbsMun":{"type":"number","maxLength":18,"description":"Percentual redução IBS municipal.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"nAliqCbs":{"type":"number","maxLength":10,"description":"Alíquota da CBS\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"nPercReducaoCbs":{"type":"number","maxLength":18,"description":"Percentual redução CBS.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"cIndOPer":{"type":"string","maxLength":6,"description":"Código Indicador de Operação.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"nValorIbsUf":{"type":"number","maxLength":18,"description":"Valor do IBS Estadual.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"nValorIbsMun":{"type":"number","maxLength":18,"description":"Valor do IBS Municipal.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"nValorCbs":{"type":"number","maxLength":18,"description":"Valor da CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"cManCbs":{"type":"string","maxLength":1,"description":"Indica que houve alteração manual da alíquota de CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"cManIbsMun":{"type":"string","maxLength":1,"description":"Indica que houve alteração manual da alíquota de IBS Municipal.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"cManIbsUf":{"type":"string","maxLength":1,"description":"Indica que houve alteração manual da alíquota de IBS Estadual.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"nBaseCalcIbsCbs":{"type":"number","maxLength":18,"description":"Valor da Base de Calculo do IBS e CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"nAliqFederalIBPT":{"type":"number","maxLength":10,"description":"Alíquota da Carga Tribut. Aproximada Federal."},"nAliqEstadualIBPT":{"type":"number","maxLength":10,"description":"Alíquota da Carga Tribut. Aproximada Estadual."},"nAliqMunicipalIBPT":{"type":"number","maxLength":10,"description":"Alíquota da Carga Tribut. Aproximada Municipal."}},"required":["nAliqCOFINS","nAliqCSLL","nAliqINSS","nAliqIRRF","nAliqPIS"],"description":"Dados do impostos do serviço."},"DeducoesIss":{"type":"array","items":{"type":"object","properties":{"cFormaDeducao":{"type":"string","maxLength":1,"description":"Tipo de dedução. Informe 'P' para Percentual ou 'V' para Valor."},"nPercDeducao":{"type":"number","maxLength":18,"description":"Percentual de dedução."},"nValorDeducao":{"type":"number","maxLength":18,"description":"Valor da Dedução."},"cTipoDeduducao":{"type":"string","maxLength":1,"description":"Tipo da Dedução. Informe  '1' para  Materiais ou 2 para Sub-Empreitada"},"cNFReferencia":{"type":"string","maxLength":20,"description":"Nota Fiscal de Referência."},"cCnpjFornecedor":{"type":"string","maxLength":20,"description":"CPF ou CNPJ do Fornecedor"},"nValorTotNfRef":{"type":"number","maxLength":18,"description":"Valor total NF de Referência"},"nQuantMateriais":{"type":"number","maxLength":18,"description":"Quantidade de Material"},"cDescMateriais":{"type":"string","maxLength":100,"description":"Descrição do material."}}},"description":"Informe aqui as Deduções para o ISS."},"cNaoGerarFinanceiro":{"type":"string","maxLength":1,"description":"Não gerar conta a receber para este item.\n\n\nInformar \"S\" para não gerar movimento financeiro.\nInformar \"N\" para gerar movimento financeiro."},"cCodCategItem":{"type":"string","maxLength":20,"description":"Código da Categoria."},"nSeqItem":{"type":"integer","maxLength":4,"description":"Sequencia do Item\n\n\nDeve ser preenchido com uma sequencia de 1 a 199."},"nIdItem":{"type":"integer","maxLength":15,"description":"ID do Item da Ordem de Serviço.\n\nNão deve ser informado na inclusão.\n\nPode ser informado na alteração para identificar o item."},"cAcaoItem":{"type":"string","maxLength":1,"description":"Ação a ser realizada na alteração do item.\n\nPode ser:\n\n\"A\" - Alterar o item (padrão).\n\"E\" - Excluir o item.\n\"I\"  - Incluir o item na alteração."},"viaUnica":{"type":"object","properties":{"cModeloNF":{"type":"string","maxLength":2,"description":"Indica qual modelo de NF será emitida para o serviço.\n\nObrigatório quando a tag cEnvViaUnica for igual a \"S\".\n\nPode ser:\n21 - Nota Fiscal de Serviço de Comunicação\n22 - Nota Fiscal de Serviço de Telecomunicação"},"cCFOP":{"type":"string","maxLength":10,"description":"Código CFOP para NF Via Única (Modelos 21 e 22).\n\nObrigatório quando a tag cEnvViaUnica for igual a \"S\".\n\nUtilize a tag \"nCodigo\" do método \"ListarCFOP\" da API  /api/v1/produtos/cfop/ para obter essa informação."},"cClassifServico":{"type":"string","maxLength":4,"description":"Código da Classificação para NF Via Única (Modelos 21 e 22).\n\nObrigatório quando a tag cEnvViaUnica for igual a \"S\".\n\nUtilize a tag \"cCodigo\" do método \"ListarClassificacaoServico\" da API\n/api/v1/servicos/classificacaoservico/ para obter essa informação."},"cTipoReceita":{"type":"string","maxLength":1,"description":"Indicador do Tipo de Receita para NF Via Única (Modelos 21 e 22).\n\nObrigatório quando a tag cEnvViaUnica for igual a \"S\".\n\nPode ser:\n0 - Receita própria - serviços prestados\n1 - Receita própria - cobrança de débitos\n2 - Receita própria - venda de mercadorias\n3 - Receita própria - venda de serviço pré-pago\n4 - Outras receitas próprias\n5 - Receitas de terceiros (co-faturamento)\n9 - Outras receitas de terceiros"},"cTipoUtilizacao":{"type":"string","maxLength":1,"description":"Código do tipo de utilização para NF Via Única (Modelos 21 e 22).\n\nObrigatório quando a tag cEnvViaUnica for igual a \"S\".\n\nUtilize a tag \"cCodigo\" do método \"ListarTipoUtilizacao\" da API\n/api/v1/servicos/tipoutilizacao/ para obter essa informação."}},"description":"Informações referente ao serviço de NF modelo 21 ou 22."},"cReembolso":{"type":"string","maxLength":1,"description":"Identificação se o item é despesa reembolsável."},"cCodigo":{"type":"string","maxLength":20,"description":"Código do serviço.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta."}}},"description":"Item da Ordem serviço"},"Parcelas":{"type":"array","items":{"type":"object","properties":{"nParcela":{"type":"integer","maxLength":3,"description":"Número da Parcela.\nEx.:\n1 para indicar a parcela 1,\n2 para indicar a parcela 2."},"dDtVenc":{"type":"string","maxLength":10,"description":"Data de Vencimento da parcela.\nEx:\n01/02/2016"},"nValor":{"type":"number","maxLength":18,"description":"Valor da Parcela.\nEx:\n100.23"},"nPercentual":{"type":"number","maxLength":9,"description":"Percentual do valor da parcela."},"nDias":{"type":"integer","maxLength":4,"description":"Número de dias até o vencimento.\nO preenchimento deste campo não é obrigatório.\nEx:\n28 para vencimento para 28 dias."},"tipo_documento":{"type":"string","maxLength":5,"description":"Tipo de Documento.\n\n\nInformação localizada na Aba \"Parcelas\" da Ordem de Serviço.\n\nPode ser:\n13S   13o. Salário\n99999 Outros\nACO   Acordo\nACOB  Acordo - Boleto\nACOT  Acordo - Transferência\nADI   Adiantamento\nANT   Antecipação\nAPL   Aplicação\nAPO   Apólice\nAPOR  Aporte\nASS   Assinatura\nBIL   Bilhete\nBOL   Boleto\nBOLV  Boleto à Vista\nBONUS Bonus\nCAP   Capitalização\nCART  Carteira\nCF    Cupom Fiscal\nCHD   Cheque Devolvido\nCHP   Cheque Pré\nCHQ   Cheque\nCHT   Cheque de Terceiros\nCNT   Crédito em Conta\nCOB   Cobrança\nCOM   Comissão\nCON   Convênios\nCONC  Cobrança de Concessionária\nCOND  Condicional\nCONS  Consignado\nCONSO Consórcio\nCRC   Cartão de Crédito\nCRD   Cartão de Débito\nCRE   Crediário\nCRP   Cartão Pré-Pago\nCRT   Cartão\nCRTO  Cartório\nCTE   CT-e\nCTR   Contrato\nCUSJ  Custos Judiciais\nDACTE DACTE\nDAE   DAE\nDAJE  DAJE\nDAM   DAM\nDANFE DANFE\nDAR   DAR\nDARE  DARE\nDARJ  DARJ\nDARM  DARM\nDAS   DAS\nDDA   DDA\nDEB   Débito em Conta\nDEBA  Débito Automático\nDEP   Depósito\nDEV   Devolução\nDFE   Documento Fiscal Equivalente\nDIN   Dinheiro\nDLC   Distribuição de Lucros\nDNF   Documento não fiscal\nDNFSE DANFSE\nDOA   Doação\nDOC   DOC\nDPVAT DPVAT\nDRF   DARF\nDUA   DUA\nDUAM  DUAM\nDUP   Duplicata\nEMP   Empréstimo\nENC   Encargos\nETAR  Estorno de Tarifa\nFAT   Fatura\nFER   Férias\nFIA   Fiado\nFIN   Financiamento\nFPGT  Folha de Pagamento\nGAR   Garantia\nGARE  GARE\nGNRE  GNRE\nGPS   GPS\nGRCS  GRCS\nGRCSU GRCSU\nGRF   Guia de Recolhimento do FGTS\nGRU   GRU\nGUIA  Guia de Recolhimento\nHOL   Holerite\nIMP   Imposto\nINV   Invoice\nIPTU  IPTU\nIPVA  IPVA\nJUROS Juros Limite\nMED   Medição\nMULTA Multas\nMUTUO Mútuo\nNC    Nota de Crédito\nND    Nota de Débito\nNF    Nota Fiscal\nNF3E  Nota Fiscal de Energia Elétrica Eletrônica\nNFA   Nota Fiscal de Abastecimento\nNFC   Nota Fiscal de Consumidor\nNFCE  Nota Fiscal de Consumidor Eletrônica\nNFD   Nota Fiscal de Devolução\nNFE   Nota Fiscal Eletrônica\nNFEE  Nota Fiscal Energia Elétrica\nNFS   Nota Fiscal de Serviço\nNFST  Nota Fiscal de Telecomunicações\nNFSTM Nota Fiscal de Serviço Tomado\nPDD   PDD\nPED   Pedido\nPEN   Pensão Alimentícia\nPER   Permuta\nPIX   Pix\nPROF  Proforma Invoice\nPROL  Pro-Labore\nPROT  Protesto\nPROV  Provisão\nREC   Recibo\nREE   Reembolso\nREND  Rendimentos\nRES   Resgate\nRET   Rescisão Trabalhista\nRPA   RPA\nSAN   Sangria\nSAQ   Saque\nSUP   Suprimento\nTAR   Tarifa\nTED   TED\nTFE   Taxa de Fiscalização de Estabelecimentos\nTIC   Ticket\nTID   Título Descontado\nTRA   Transferência\nTRAV  Transferência à Vista\nTRLAV Licenciamento\nTX    Taxa\nVIST  A Vista\nVOU   Voucher\nWSITE Website\n\nListagem completa disponível na API:\n/api/v1/ger"},"meio_pagamento":{"type":"string","maxLength":100,"description":"Meio de Pagamento - Utilizado apenas para emissão de NFS-e (campo \"tPag\" do XML).\nEsse campo indica como a parcela da nota será paga.\n\n\nInformação localizada na Aba \"Parcelas\" da Ordem de Serviço.\n\nCaso informado na estrutura \"informacoes_adicionais\" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura \"parcela\".\n\nPode ser:\n01  Dinheiro\n02  Cheque\n03  Cartão de Crédito\n04  Cartão de Débito\n05  Crédito Loja\n10  Vale Alimentação\n11  Vale Refeição\n12  Vale Presente\n13  Vale Combustível\n15  Boleto Bancário\n16  Depósito Bancário\n17  Pagamento Instantâneo (PIX)\n18  Transferência bancária, Carteira Digital\n19  Programa de fidelidade, Cashback, Crédito Virtual.\n90  Sem Pagamento\n99  Outros\n\nListagem completa disponível na API:\n/api/v1/geral/meiospagamento/"},"nsu":{"type":"string","maxLength":100,"description":"Número Sequencial Único NSU - Para identificar vendas por cartões ou TransactionID TID - Para identificar vendas de comercio eletrônico."},"nao_gerar_boleto":{"type":"string","maxLength":1,"description":"Não gerar boleto para esta parcela ao emitir a nota fiscal.\n\nInforme \"S\" para não gerar o boleto. O padrão é \"N\".\n\n\nInformação localizada na Aba \"Parcelas\" da Ordem de Serviço."},"parcela_adiantamento":{"type":"string","maxLength":1,"description":"Está é uma parcela de Adiantamento do Cliente.\n\nInforme \"S\" para indicar que é uma parcela de adiantamento.\nO padrão é \"N\".\n\n\nInformação localizada na Aba \"Parcelas\" da Ordem de Serviço."},"categoria_adiantamento":{"type":"string","maxLength":20,"description":"Código da Categoria para o Adiantamento.\nSerá utilizada na conta a receber que representa o adiantamento desta parcela.\n\n\nInformação localizada na Aba \"Parcelas\" da Ordem de Serviço."},"conta_corrente_adiantamento":{"type":"integer","maxLength":15,"description":"Conta Corrente de Adiantamento.\n\n\nInformação localizada na Aba \"Parcelas\" da Ordem de Serviço."}},"required":["nDias","nParcela"]},"description":"Permite que o parcelamento seja realizado de forma manual."},"Observacoes":{"type":"object","properties":{"cObsOS":{"type":"string","description":"Observações da Ordem de Serviço. (Essas informação não serão exibidas na Nota Fiscal)."}}},"InfoCadastro":{"type":"object","properties":{"cCancelada":{"type":"string","maxLength":1,"example":"S","description":"Ordem de Serviço cancelada?"},"cFaturada":{"type":"string","maxLength":1,"example":"S","description":"Ordem de Serviço faturada com sucesso?"},"cAmbiente":{"type":"string","maxLength":1,"description":"Ambiente de emissão da NFS-e.\n\nPode ser:\n\nH - Homologação\nP - Produção"},"dDtInc":{"type":"string","maxLength":10,"description":"Data de Inclusão da Ordem de Serviço"},"cHrInc":{"type":"string","maxLength":8,"description":"Hora de inclusão da Ordem de Serviço"},"uInc":{"type":"string","maxLength":10,"description":"Usuário da Inclusão.\n\nNão deve ser informado na Inclusão/Alteração."},"dDtAlt":{"type":"string","maxLength":10,"description":"Data de Alteração da Ordem de Serviço"},"cHrAlt":{"type":"string","maxLength":8,"description":"Hora de Alteração da Ordem de Serviço"},"uAlt":{"type":"string","maxLength":10,"description":"Usuário da Alteração.\n\nNão deve ser informado na Inclusão/Alteração."},"dDtFat":{"type":"string","maxLength":10,"description":"Data de Faturamento"},"cHrFat":{"type":"string","maxLength":8,"description":"Hora do Faturamento"},"dDtCanc":{"type":"string","maxLength":10,"description":"Data de Cancelamento"},"cHrCanc":{"type":"string","maxLength":8,"description":"Hora do Cancelamento"},"cOrigem":{"type":"string","maxLength":3,"description":"Origem da Ordem de Serviço"}},"description":"Informações do cadastro da Ordem de Serviço."},"despesasReembolsaveis":{"type":"object","properties":{"cCodCategReemb":{"type":"string","maxLength":20,"description":"Código da categoria para reembolso"},"despesaReembolsavel":{"type":"array","items":{"type":"object","properties":{"nCodReemb":{"type":"integer","maxLength":15,"description":"ID do Reembolso.\n\n(Código interno utilizado apenas na API, utilizado somente na Alteração e Exclusão).\nEsse código não aparece na tela do Omie.\nUtilize esse código para identificar a despesa via API."},"cAcaoReemb":{"type":"string","maxLength":1,"description":"Pode ser:\n\n\"A\" - Alterar a despesa.\n\"E\" - Excluir a despesa.\n\"I\" - Incluir a despesa na alteração."},"cDescReemb":{"type":"string","maxLength":200,"description":"Descrição da despesa."},"nValorReemb":{"type":"number","maxLength":18,"description":"Valor da despesa."},"dDataReemb":{"type":"string","maxLength":10,"description":"Data da despesa."}}},"description":"Despesa reembolsável"}},"description":"Despesas reembolsáveis."},"produtosUtilizados":{"type":"object","properties":{"cAcaoProdUtilizados":{"type":"string","maxLength":3,"description":"Pode ser:\nREM - Será gerado uma remessa dos produtos para o cliente.\nEST - Será gerado uma saída de estoque.\n\nObrigatório na inclusão."},"cCodCategRem":{"type":"string","maxLength":20,"description":"Código da Categoria da Remessa ou Pedido de Venda.\n\nObrigatório quando usar cAcaoFaturamento como 'REM' ou 'PED'"},"produtoUtilizado":{"type":"array","items":{"type":"object","properties":{"nIdItemPU":{"type":"integer","maxLength":15,"description":"(Código interno utilizado apenas na API).\nNão informar na inclusão.\n\nEsse código não aparece na tela do Omie."},"cAcaoItemPU":{"type":"string","maxLength":1,"description":"Pode ser:\n\n\"A\" - Alterar o item.\n\"E\" - Excluir o item.\n\"I\" - Incluir o item na alteração."},"nCodProdutoPU":{"type":"integer","maxLength":15,"description":"Código interno do produto.\n(utilizado apenas na API).\nEsse código não aparece na tela do Omie."},"nQtdePU":{"type":"number","maxLength":18,"description":"Quantidade."},"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do Local do Estoque."},"lote_validade":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","maxLength":15,"description":"Id do Lote do produto.\n\nObrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.."},"nQtdLote":{"type":"number","maxLength":18,"description":"Informe aqui a quantidade do Lote para o produto.\n\nÉ obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações."}},"required":["nQtdLote"]},"description":"Informações referentes ao lote e validade do produto.\n\nA tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes \"manualmente\" por API."}}},"description":"rodutos utilizados no serviço."}},"description":"Produtos Utilizados na Ordem de Serviço."},"Tarefas":{"type":"array","items":{"type":"object","properties":{"nCodTarefa":{"type":"integer","maxLength":15,"description":"Código único da tarefa."},"cCodIntTarefa":{"type":"string","maxLength":20},"cDescricao":{"type":"string","maxLength":10,"description":"Descrição da tarefa."},"dData":{"type":"string"},"hHora":{"type":"string","maxLength":5},"nCodDoc":{"type":"integer","maxLength":15,"description":"Id do documento vinculado a tarefa.\n\nEsse campo varia conforme a origem da tarefa.\nEle permite vincular a tarefa a um documento específico, seja ele relacionado a uma oportunidade, contas a pagar, contas a receber, entre outros.\n\nExemplo:\nSe a origem da tarefa for \"pedido-compra\", esse campo reflete o código do pedido de compra.\nSe a origem da tarefa for \"contas-receber\", esse campo reflete o código da conta a receber."},"nCodUserAtb":{"type":"integer","maxLength":15,"description":"Código do usuário atribuído."},"cNomeUserAtb":{"type":"string","maxLength":800}}},"description":"Lista com as tarefas relacionadas a ordem de serviço.\n\nRetornado apenas no método de consulta e quando preenchida a tag \"cIncluirTarefas\" como \"S\"."},"Caracteristicas":{"type":"array","items":{"type":"object","properties":{"cConteudo":{"type":"string","maxLength":7000,"description":"Conteúdo da Característica."},"cNome":{"type":"string","maxLength":70,"description":"Nome da característica."},"nIdCampo":{"type":"integer","maxLength":15,"description":"Id do campo característica."},"nIdCaracteristica":{"type":"integer","maxLength":15,"description":"ID da Característica."}}},"description":"Características da Ordem de Serviço."}}}}},"example":{"call":"AlterarOS","param":[{"Cabecalho":{"nCodOS":"1790776458","cCodParc":"999","cEtapa":"20","dDtPrevisao":"30/09/2026","nCodCli":2485994,"nQtdeParc":7},"Departamentos":[],"Email":{"cEnvBoleto":"N","cEnvLink":"N","cEnviarPara":"teste@omie.com.br"},"InformacoesAdicionais":{"cCidPrestServ":"SAO PAULO (SP)","cCodCateg":"1.01.02","cDadosAdicNF":"OS incluida via API de teste 72628","nCodCC":11850365},"ServicosPrestados":[{"cCodServLC116":"7.07","cCodServMun":"01015","cDadosAdicItem":"Serviços prestados","cDescServ":"Serviço prestado 001","cRetemISS":"N","cTribServ":"01","impostos":{"cRetemIRRF":"S","cRetemPIS":"S","nAliqCOFINS":0,"nAliqCSLL":0,"nAliqIRRF":15,"nAliqISS":3,"nAliqPIS":4.5},"nQtde":3,"nValUnit":1000},{"impostos":{"cRetemIRRF":"S","cRetemPIS":"S","nAliqIRRF":15,"nAliqISS":3,"nAliqPIS":4.5},"nCodServico":2342423,"nQtde":12,"nValUnit":35}]}]}},"servicos_os_AlterarOS_retorno":{"type":"object","properties":{"cCodIntOS":{"type":"string","description":"Código de Integração da Ordem de Serviço"},"nCodOS":{"type":"integer","description":"Código da Ordem de Serviço"},"cNumOS":{"type":"string","description":"Número da Ordem de Serviço (Conforme visualizada em tela pelo cliente)"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDescStatus":{"type":"string","description":"Descrição do Status"}},"title":"AlterarOS (retorno)"},"servicos_os_ConsultarOS":{"type":"object","title":"ConsultarOS","description":"Consulta da Ordem de Serviço.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarOS"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cCodIntOS":{"type":"string","maxLength":60,"description":"Código de Integração da OS"},"nCodOS":{"type":"integer","maxLength":15,"description":"Código da Ordem de Serviço"},"cNumOS":{"type":"string","maxLength":15,"description":"Número da Ordem de Serviço\nConforme visualizada na tela pelo cliente."},"despesasReembolsaveis":{"type":"object","properties":{"cCodCategReemb":{"type":"string","maxLength":20,"description":"Código da categoria para reembolso"},"despesaReembolsavel":{"type":"array","items":{"type":"object","properties":{"nCodReemb":{"type":"integer","maxLength":15,"description":"ID do Reembolso.\n\n(Código interno utilizado apenas na API, utilizado somente na Alteração e Exclusão).\nEsse código não aparece na tela do Omie.\nUtilize esse código para identificar a despesa via API."},"cAcaoReemb":{"type":"string","maxLength":1,"description":"Pode ser:\n\n\"A\" - Alterar a despesa.\n\"E\" - Excluir a despesa.\n\"I\" - Incluir a despesa na alteração."},"cDescReemb":{"type":"string","maxLength":200,"description":"Descrição da despesa."},"nValorReemb":{"type":"number","maxLength":18,"description":"Valor da despesa."},"dDataReemb":{"type":"string","maxLength":10,"description":"Data da despesa."}}},"description":"Despesa reembolsável"}},"description":"Despesas reembolsáveis."},"cIncluirTarefas":{"type":"string","maxLength":1,"description":"Indica se deve incluir as tarefas vinculadas a ordem de serviço no retorno (S/N).\n\nComo default é \"N\".\n\nDeve ser utilizado apenas no método de consulta."}}}}},"example":{"call":"ConsultarOS","param":[{"cCodIntOS":"","nCodOS":0,"cNumOS":""}]}},"servicos_os_ConsultarOS_retorno":{"type":"object","properties":{"Cabecalho":{"type":"object","properties":{"cCodIntOS":{"type":"string","description":"Código de Integração da OS. Obrigatório na inclusão."},"nCodOS":{"type":"integer","description":"Código da Ordem de Serviço"},"cNumOS":{"type":"string","description":"Número da Ordem de Serviço (Conforme visualizada em tela pelo cliente)"},"cCodIntCli":{"type":"string","description":"Código de Integração do Cliente"},"nCodCli":{"type":"integer","description":"Código do Cliente"},"dDtPrevisao":{"type":"string","description":"Data de Previsão"},"cEtapa":{"type":"string","description":"Código da etapa do processo, sendo: 10 - Primeira coluna 20 - Segunda coluna 30 - Terceira coluna 40 - Quarta coluna 50 - Faturar"},"nCodVend":{"type":"integer","description":"Código do Vendedor"},"nQtdeParc":{"type":"integer","description":"Quantidade de Parcelas"},"cCodParc":{"type":"string","description":"Código da parcela/Condição de pagamento. Utilize a tag \"nCodigo\" do método \"ListarFormasPagVendas\" da API http://app.omie.com.br/api/v1/produtos/formaspagvendas/ para obter essa informação. O código \"999\" é o único que permite uma definição de forma de pagamento customizada. Caso você escolha essa opção, deve também informar a tag \"qtde_parcelas\" e a estrutura \"lista_parcelas\". Alguns dos valores disponíveis são: \"000\" - A Vista \"A03\" - Para 3 dias \"A05\" - Para 5 dias \"A07\" - Para 7 dias \"A08\" - Para 8 dias \"A09\" - Para 9 dias \"A10\" - Para 10 dias \"A13\" - Para 13 dias \"A14\" - Para 14 dias \"A15\" - Para 15 dias \"A17\" - Para 17 dias \"A20\" - Para 20 dias \"A21\" - Para 21 dias \"A25\" - Para 25 dias \"A26\" - Para 26 dias \"A28\" - Para 28 dias \"A35\" - Para 35 dias \"A36\" - Para 36 dias \"A40\" - Para 40 dias \"A42\" - Para 42 dias \"A45\" - Para 45 dias \"A50\" - Para 50 dias \"A56\" - Para 56 dias \"A60\" - Para 60 dias \"A70\" - Para 70 dias \"A75\" - Para 75 dias \"A90\" - Para 90 dias \"A98\" - Para 98 dias \"B20\" - Para 120 dias \"001\" - 1 Parcela (para 30 dias) \"002\" - 2 Parcelas \"003\" - 3 Parcelas \"004\" - 4 Parcelas \"005\" - 5 Parcelas \"006\" - 6 Parcelas \"007\" - 7 Parcelas \"010\" - 10 Parcelas \"012\" - 12 Parcelas \"024\" - 24 Parcelas \"036\" - 36 Parcelas \"048\" - 48 Parcelas \"S01\" - 30/60 \"S02\" - 45/60 \"S03\" - 21/28/35 \"S04\" - 21/28/35/42 \"S05\" - 28/35/42 \"S06\" - 28/35/42/49 \"S07\" - 30/45/60/75/90 \"S08\" - 25/56 \"S09\" - 30/45 \"S10\" - 28/56 \"S11\" - 10/30/60 \"S12\" - 15/30/60 \"S13\" - 28/35 \"S14\" - 7/14/21 \"S15\" - 10/30/60/90 \"S16\" - 60/90/120 \"S17\" - 45/60/90 \"S18\" - 30/60/90 \"S19\" - 14/21 \"S20\" - 7/14 \"S21\" - 14/21/28 \"S22\" - 45/75 \"S23\" - 30/45/60 \"S24\" - 3/20/40 \"S25\" - 30/60/90/120 \"S26\" - 21/28 \"S27\" - a Vista/15 \"S28\" - a Vista/30 \"S29\" - a Vista/30/60 \"S30\" - a Vista/30/60/90 \"S31\" - a Vista/30/60/90/120/150 \"S41\" - 28/42/56 \"S32\" - 15/45/75 \"S33\" - 14/28/42 \"S34\" - 14/21/28/35/42 \"S35\" - 30/42/54/66/78/90 \"S36\" - 14/21/28/35 \"S37\" - 28/42 \"S38\" - 30/45/60 \"S39\" - 35/42/49/56 \"S40\" - 28/42/56/70 \"S42\" - 30/40/50/60 \"S43\" - 30/50/70/90 \"S44\" - 14/28 \"S45\" - 45/60/75/90 \"S46\" - a Vista/30/60/90/120 \"S47\" - a vista/20/40/60 \"S48\" - 21/42 \"S49\" - 15/30/45 \"S50\" - 14/42 \"S51\" - 21/35 \"S52\" - 28/56/84 \"S53\" - 28/42/56/70/84 \"S54\" - a Vista/30/45 \"S55\" - 21/45 \"S56\" - a Vista/28 \"S57\" - a Vista/60/90 \"S58\" - 35/45/55 \"S59\" - 28/35/42/56 \"S60\" - 30/45/60/75 \"S61\" - 28/35/42/49/56 \"S62\" - 40/70/100 \"S63\" - 42/56 \"S64\" - a Vista/28/35 \"S65\" - 35/42 \"S66\" - 20/40 \"S67\" - a Vista/28/35/42"},"cDescParc":{"type":"string","description":"Descrição da parcela. Utilizado apenas para retorno do método \"ConsultarOS\"."},"nValorTotal":{"type":"decimal","description":"Valor total da Ordem de Serviço. Não deve ser informado na inclusão ou alteração. Campo calculado automaticamente."},"nValorTotalImpRet":{"type":"decimal","description":"Valor Total de Impostos Retidos"},"nCodCtr":{"type":"integer","description":"Código do Contrato. Ao informar esse campo será incluído ao contrato uma Ordem de Serviço adicional. Utilizado somente na Inclusão/Alteração. Utilize a tag \"nCodCtr\" do método \"ListarContrato\" da API /api/v1/servicos/contrato/ para obter essa informação"}},"description":"Cabeçalho da Ordem de Serviço"},"InformacoesAdicionais":{"type":"object","properties":{"cCodCateg":{"type":"string","description":"Categoria"},"nCodCC":{"type":"integer","description":"Código da Conta Corrente"},"cNumPedido":{"type":"string","description":"Número do Pedido do Cliente"},"cNumContrato":{"type":"string","description":"Número do Contrato de Venda"},"cContato":{"type":"string","description":"Contato"},"cDadosAdicNF":{"type":"string","description":"Dados Adicionais da Nota Fiscal"},"cCodObra":{"type":"string","description":"Código da Obra"},"cCodART":{"type":"string","description":"Código ART"},"nCodProj":{"type":"integer","description":"Código do Projeto"},"cCidPrestServ":{"type":"string","description":"Cidade da Prestação do Serviço"},"dDataRps":{"type":"string","description":"Data da RPS"},"cNumRecibo":{"type":"string","description":"Número do Recibo gerado. (Gerado automaticamente. Se informado na inclusão será ignorado)."},"cUsoConsumo":{"type":"string","description":"Uso e consumo pessoal."},"nIdDestinatario":{"type":"integer","description":"ID Cliente para o Destinatário."},"DetalhesNfse":{"type":"object","properties":{"Eventos":{"type":"object","properties":{"cCidadeEvento":{"type":"string","description":"Código da Cidade da Prestação de Serviços."},"cCodPaisEvento":{"type":"string","description":"Código do país do evento."},"cEndExtEvento":{"type":"string","description":"Endereço no Exterior do evento. A tag [cExtEvento] precisa ser preenchida como \"S\"."},"cBairroEvento":{"type":"string","description":"Bairro do Evento."},"cCepEvento":{"type":"string","description":"CEP do Evento."},"cEndEvento":{"type":"string","description":"Endereço do envento."},"cNumEndEvento":{"type":"string","description":"Número do endereço do evento."},"cUfEvento":{"type":"string","description":"Estado do evento."},"dDtIniEvento":{"type":"string","description":"Data de Início do Evento."},"dDtFimEvento":{"type":"string","description":"Data Final do Evento."},"cNomeEvento":{"type":"string","description":"Nome do evento."},"cComplEvento":{"type":"string","description":"Completo do endereço do evento."},"cCodAtivEvento":{"type":"string","description":"Código de Atividade do evento."},"cExtEvento":{"type":"string","description":"Evento no Exterior S/N."},"cCidadeExtEvento":{"type":"string","description":"Cidade do evento no exterior. A tag [cExtEvento] precisa ser preenchida como \"S\"."}},"description":"Evento na Nfse."}},"description":"Detalhes da NFSE."}}},"Email":{"type":"object","properties":{"cEnvRecibo":{"type":"string","description":"Enviar um recibo de prestação de serviços (ao invés da NFS-e)"},"cEnvLink":{"type":"string","description":"Enviar ao Cliente e-mail com o link do site da prefeitura para consultar a NFSe emitida."},"cEnvBoleto":{"type":"string","description":"Enviar ao cliente e-mail com os Boletos de Cobrança gerados pelo faturamento. É permitido somente o preenchimento de uma das tags \"cEnvPix\" ou \"cEnvBoleto\"."},"cEnvPix":{"type":"string","description":"Enviar ao cliente e-mail com o PIX de Cobrança gerado pelo faturamento. É permitido somente o preenchimento de uma das tags \"cEnvPix\" ou \"cEnvBoleto\"."},"cEnviarPara":{"type":"string","description":"Utilizar os seguintes endereços de e-mail"},"cEnvViaUnica":{"type":"string","description":"Enviar ao cliente Via Única (Notas Fiscais Modelos 21 e 22). Pode ser: S - Sim N - Não"}}},"Departamentos":{"type":"array","items":{"type":"object","properties":{"cCodDepto":{"type":"string","description":"ID do Departamento. Informação localizada na Aba \"Departamentos\" do Pedido de Venda. Utilize a tag \"codigo\" do método \"ListarDepatartamentos\" da API http://app.omie.com.br/api/v1/geral/departamentos/ para obter essa informação."},"nPerc":{"type":"decimal","description":"Percentual de Rateio. Informação localizada na Aba \"Departamentos\" do Pedido de Venda."},"nValor":{"type":"decimal","description":"Valor do Rateio. Informação localizada na Aba \"Departamentos\" do Pedido de Venda."},"nValorFixo":{"type":"string","description":"Indica que o valor foi fixado na distribuição do rateio. Informar \"S\" ou \"N\". Informação localizada na Aba \"Departamentos\" do Pedido de Venda."}}},"description":"Dados da Aba \"Departamentos\" do Pedido de Venda."},"ServicosPrestados":{"type":"array","items":{"type":"object","properties":{"nCodServico":{"type":"integer","description":"Código Interno do Serviço conforme cadastrado na tabela de serviços. Caso preenchido, irá assumir as informações do cadastro de serviço. Se não for preenchido, assumirá os valores informados na API."},"cCodIntServico":{"type":"string","description":"Código de Integração do Serviço conforme cadastrado na tabela de serviços. Caso preenchido, irá assumir as informações do cadastro de serviço. Se não for preenchido, assumirá os valores informados na API."},"cTribServ":{"type":"string","description":"Tipo de Tributação dos Serviços. Caso tenha informado a tag \"nCodServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. Valores pode variar de acordo com o município. Verifique a legislação da sua cidade para obter os tipos de tributação disponíveis."},"cCodServMun":{"type":"string","description":"Código do Serviço Municipal ou CNAE. Caso tenha informado a tag \"nCodServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. Valores pode variar de acordo com o município. Verifique a legislação da sua cidade para obter os códigos de serviço disponíveis."},"cCodServLC116":{"type":"string","description":"Código do Serviço conforme Lei Complementar (LC 116). Caso tenha informado a tag \"nCodServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. Tabela única para todos os municípios."},"nQtde":{"type":"decimal","description":"Quantidade de serviços."},"nValUnit":{"type":"decimal","description":"Valor Unitário do serviço. Caso tenha informado a tag \"nCodServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço."},"cTpDesconto":{"type":"string","description":"Tipo de Desconto. Pode ser: P - Percentual V - Valor"},"nValorDesconto":{"type":"decimal","description":"Valor do Desconto."},"nAliqDesconto":{"type":"decimal","description":"Aliquota do Desconto."},"nValorOutrasRetencoes":{"type":"decimal","description":"Valor de Outras Retenções. (Disponível apenas para cidades que oferecem esse recurso.)"},"nValorAcrescimos":{"type":"decimal","description":"Valor de Acréscimos e taxas. (Disponível apenas para cidades que oferecem esse recurso.)"},"cDescServ":{"type":"string","description":"Descrição dos Serviços. Caso tenha informado a tag \"nCodServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço."},"cRetemISS":{"type":"string","description":"Retem ISS (S/N)"},"cDadosAdicItem":{"type":"string","description":"Dados adicionais do Item."},"cNbs":{"type":"string","description":"Código da Nomenclatura Brasileira de Serviços (NBS). Caso tenha informado a tag \"nCodServico\" irá assumir o valor informado no cadastro do respectivo serviço."},"impostos":{"type":"object","properties":{"cFixarISS":{"type":"string","description":"Indica se o imposto foi alterado pelo usuário ou informado via importação de planilha ou API. Esse campo é preenchido automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"nAliqISS":{"type":"decimal","description":"Alíquota de ISS."},"nBaseISS":{"type":"decimal","description":"Base de Cálculo do ISS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"nTotDeducao":{"type":"decimal","description":"Valor de Dedução da Base de Cálculo. Por padrão, esse campo afeta a Base de Cálculo do ISS. Para atender a condições legais acordadas para cada munícipio pode afetar as Bases de Cálculos dos Impostos Federais também. Consulte a legislação do seu município."},"nValorDeducao":{"type":"decimal","description":"Valor das deduções do item. Utilizado apenas nos métodos de Consulta/Listagem."},"nValorISS":{"type":"decimal","description":"Valor do ISS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"cUtilizaValorImposto":{"type":"string","description":"Indica se o valor informado para os Impostos Federais deverá ser mantido ao invés de ser recalculado a partir da alíquota. Assim: Caso seja informado \"N\", indica que valor do imposto deve ser calculado a partir da alíquota e base de cálculo. Caso seja informado \"S\", indica que o valor do imposto será mantido e a alíquota será recalculada a partir do valor do imposto e base de cálculo."},"cFixarIRRF":{"type":"string","description":"Indica se o imposto foi alterado pelo usuário ou informado via importação de planilha ou API. Esse campo é preenchido automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"nAliqIRRF":{"type":"decimal","description":"Alíquota de IRRF. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"nValorIRRF":{"type":"decimal","description":"Valor do IRRF. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\". Caso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"nValorDeducaoIRRF":{"type":"decimal","description":"Valor da dedução da base do IR."},"cRetemIRRF":{"type":"string","description":"Retém IRRF (S/N). Indica se o imposto deve ser retido ou não."},"cFixarPIS":{"type":"string","description":"Indica se o imposto foi alterado pelo usuário ou informado via importação de planilha ou API. Esse campo é preenchido automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"nAliqPIS":{"type":"decimal","description":"Alíquota de PIS. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"nValorPIS":{"type":"decimal","description":"Valor do PIS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\". Caso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"cRetemPIS":{"type":"string","description":"Retém PIS (S/N). Indica se o imposto deve ser retido ou não."},"cFixarCOFINS":{"type":"string","description":"Indica se o imposto foi alterado pelo usuário ou informado via importação de planilha ou API. Esse campo é preenchido automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"nAliqCOFINS":{"type":"decimal","description":"Alíquota de COFINS. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"nValorCOFINS":{"type":"decimal","description":"Valor do COFINS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\". Caso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"cRetemCOFINS":{"type":"string","description":"Retém COFINS (S/N). Indica se o imposto deve ser retido ou não."},"cFixarCSLL":{"type":"string","description":"Indica se o imposto foi alterado pelo usuário ou informado via importação de planilha ou API. Esse campo é preenchido automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"nAliqCSLL":{"type":"decimal","description":"Alíquota de CSLL. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"nValorCSLL":{"type":"decimal","description":"Valor de CSLL. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\". Caso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"cRetemCSLL":{"type":"string","description":"Retém CSLL (S/N). Indica se o imposto deve ser retido ou não."},"cFixarINSS":{"type":"string","description":"Indica se o imposto foi alterado pelo usuário ou informado via importação de planilha ou API. Esse campo é preenchido automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"nAliqINSS":{"type":"decimal","description":"Alíquota de INSS. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"nValorINSS":{"type":"decimal","description":"Valor de INSS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\". Caso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"cRetemINSS":{"type":"string","description":"Retém INSS (S/N). Indica se o imposto deve ser retido ou não."},"nAliqRedBaseINSS":{"type":"decimal","description":"Percentual de Redução da Base de Cálculo do INSS."},"nAliqRedBaseCOFINS":{"type":"decimal","description":"Percentual de Redução da Base de Cálculo do COFINS."},"nAliqRedBasePIS":{"type":"decimal","description":"Percentual de Redução da Base de Cálculo do PIS."},"lDeduzISS":{"type":"boolean","description":"Deduz o ISS da Base de Cálculo de PIS e COFINS"},"cCST":{"type":"string","description":"Código da Situação Tributária IBS/CBS. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"cClassTrib":{"type":"string","description":"Código de Classificação Tributária. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"nAliqIbsUf":{"type":"decimal","description":"Alíquota do IBS estadual. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"nAliqIbsMun":{"type":"decimal","description":"Alíquota do IBS Municipal. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"nPercReducaoIbsUf":{"type":"decimal","description":"Percentual redução IBS estadual. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"nPercReducaoIbsMun":{"type":"decimal","description":"Percentual redução IBS municipal. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"nAliqCbs":{"type":"decimal","description":"Alíquota da CBS Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"nPercReducaoCbs":{"type":"decimal","description":"Percentual redução CBS. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"cIndOPer":{"type":"string","description":"Código Indicador de Operação. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"nValorIbsUf":{"type":"decimal","description":"Valor do IBS Estadual. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"nValorIbsMun":{"type":"decimal","description":"Valor do IBS Municipal. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"nValorCbs":{"type":"decimal","description":"Valor da CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"cManCbs":{"type":"string","description":"Indica que houve alteração manual da alíquota de CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"cManIbsMun":{"type":"string","description":"Indica que houve alteração manual da alíquota de IBS Municipal. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"cManIbsUf":{"type":"string","description":"Indica que houve alteração manual da alíquota de IBS Estadual. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"nBaseCalcIbsCbs":{"type":"decimal","description":"Valor da Base de Calculo do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"nAliqFederalIBPT":{"type":"decimal","description":"Alíquota da Carga Tribut. Aproximada Federal."},"nAliqEstadualIBPT":{"type":"decimal","description":"Alíquota da Carga Tribut. Aproximada Estadual."},"nAliqMunicipalIBPT":{"type":"decimal","description":"Alíquota da Carga Tribut. Aproximada Municipal."}},"description":"Dados do impostos do serviço."},"DeducoesIss":{"type":"array","items":{"type":"object","properties":{"cFormaDeducao":{"type":"string","description":"Tipo de dedução. Informe 'P' para Percentual ou 'V' para Valor."},"nPercDeducao":{"type":"decimal","description":"Percentual de dedução."},"nValorDeducao":{"type":"decimal","description":"Valor da Dedução."},"cTipoDeduducao":{"type":"string","description":"Tipo da Dedução. Informe '1' para Materiais ou 2 para Sub-Empreitada"},"cNFReferencia":{"type":"string","description":"Nota Fiscal de Referência."},"cCnpjFornecedor":{"type":"string","description":"CPF ou CNPJ do Fornecedor"},"nValorTotNfRef":{"type":"decimal","description":"Valor total NF de Referência"},"nQuantMateriais":{"type":"decimal","description":"Quantidade de Material"},"cDescMateriais":{"type":"string","description":"Descrição do material."}}},"description":"Informe aqui as Deduções para o ISS."},"cNaoGerarFinanceiro":{"type":"string","description":"Não gerar conta a receber para este item. Informar \"S\" para não gerar movimento financeiro. Informar \"N\" para gerar movimento financeiro."},"cCodCategItem":{"type":"string","description":"Código da Categoria."},"nSeqItem":{"type":"integer","description":"Sequencia do Item Deve ser preenchido com uma sequencia de 1 a 199."},"nIdItem":{"type":"integer","description":"ID do Item da Ordem de Serviço. Não deve ser informado na inclusão. Pode ser informado na alteração para identificar o item."},"cAcaoItem":{"type":"string","description":"Ação a ser realizada na alteração do item. Pode ser: \"A\" - Alterar o item (padrão). \"E\" - Excluir o item. \"I\" - Incluir o item na alteração."},"viaUnica":{"type":"object","properties":{"cModeloNF":{"type":"string","description":"Indica qual modelo de NF será emitida para o serviço. Obrigatório quando a tag cEnvViaUnica for igual a \"S\". Pode ser: 21 - Nota Fiscal de Serviço de Comunicação 22 - Nota Fiscal de Serviço de Telecomunicação"},"cCFOP":{"type":"string","description":"Código CFOP para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a \"S\". Utilize a tag \"nCodigo\" do método \"ListarCFOP\" da API /api/v1/produtos/cfop/ para obter essa informação."},"cClassifServico":{"type":"string","description":"Código da Classificação para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a \"S\". Utilize a tag \"cCodigo\" do método \"ListarClassificacaoServico\" da API /api/v1/servicos/classificacaoservico/ para obter essa informação."},"cTipoReceita":{"type":"string","description":"Indicador do Tipo de Receita para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a \"S\". Pode ser: 0 - Receita própria - serviços prestados 1 - Receita própria - cobrança de débitos 2 - Receita própria - venda de mercadorias 3 - Receita própria - venda de serviço pré-pago 4 - Outras receitas próprias 5 - Receitas de terceiros (co-faturamento) 9 - Outras receitas de terceiros"},"cTipoUtilizacao":{"type":"string","description":"Código do tipo de utilização para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a \"S\". Utilize a tag \"cCodigo\" do método \"ListarTipoUtilizacao\" da API /api/v1/servicos/tipoutilizacao/ para obter essa informação."}},"description":"Informações referente ao serviço de NF modelo 21 ou 22."},"cReembolso":{"type":"string","description":"Identificação se o item é despesa reembolsável."},"cCodigo":{"type":"string","description":"Código do serviço. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta."}}},"description":"Item da Ordem serviço"},"Parcelas":{"type":"array","items":{"type":"object","properties":{"nParcela":{"type":"integer","description":"Número da Parcela. Ex.: 1 para indicar a parcela 1, 2 para indicar a parcela 2."},"dDtVenc":{"type":"string","description":"Data de Vencimento da parcela. Ex: 01/02/2016"},"nValor":{"type":"decimal","description":"Valor da Parcela. Ex: 100.23"},"nPercentual":{"type":"decimal","description":"Percentual do valor da parcela."},"nDias":{"type":"integer","description":"Número de dias até o vencimento. O preenchimento deste campo não é obrigatório. Ex: 28 para vencimento para 28 dias."},"tipo_documento":{"type":"string","description":"Tipo de Documento. Informação localizada na Aba \"Parcelas\" da Ordem de Serviço. Pode ser: 13S 13o. Salário 99999 Outros ACO Acordo ACOB Acordo - Boleto ACOT Acordo - Transferência ADI Adiantamento ANT Antecipação APL Aplicação APO Apólice APOR Aporte ASS Assinatura BIL Bilhete BOL Boleto BOLV Boleto à Vista BONUS Bonus CAP Capitalização CART Carteira CF Cupom Fiscal CHD Cheque Devolvido CHP Cheque Pré CHQ Cheque CHT Cheque de Terceiros CNT Crédito em Conta COB Cobrança COM Comissão CON Convênios CONC Cobrança de Concessionária COND Condicional CONS Consignado CONSO Consórcio CRC Cartão de Crédito CRD Cartão de Débito CRE Crediário CRP Cartão Pré-Pago CRT Cartão CRTO Cartório CTE CT-e CTR Contrato CUSJ Custos Judiciais DACTE DACTE DAE DAE DAJE DAJE DAM DAM DANFE DANFE DAR DAR DARE DARE DARJ DARJ DARM DARM DAS DAS DDA DDA DEB Débito em Conta DEBA Débito Automático DEP Depósito DEV Devolução DFE Documento Fiscal Equivalente DIN Dinheiro DLC Distribuição de Lucros DNF Documento não fiscal DNFSE DANFSE DOA Doação DOC DOC DPVAT DPVAT DRF DARF DUA DUA DUAM DUAM DUP Duplicata EMP Empréstimo ENC Encargos ETAR Estorno de Tarifa FAT Fatura FER Férias FIA Fiado FIN Financiamento FPGT Folha de Pagamento GAR Garantia GARE GARE GNRE GNRE GPS GPS GRCS GRCS GRCSU GRCSU GRF Guia de Recolhimento do FGTS GRU GRU GUIA Guia de Recolhimento HOL Holerite IMP Imposto INV Invoice IPTU IPTU IPVA IPVA JUROS Juros Limite MED Medição MULTA Multas MUTUO Mútuo NC Nota de Crédito ND Nota de Débito NF Nota Fiscal NF3E Nota Fiscal de Energia Elétrica Eletrônica NFA Nota Fiscal de Abastecimento NFC Nota Fiscal de Consumidor NFCE Nota Fiscal de Consumidor Eletrônica NFD Nota Fiscal de Devolução NFE Nota Fiscal Eletrônica NFEE Nota Fiscal Energia Elétrica NFS Nota Fiscal de Serviço NFST Nota Fiscal de Telecomunicações NFSTM Nota Fiscal de Serviço Tomado PDD PDD PED Pedido PEN Pensão Alimentícia PER Permuta PIX Pix PROF Proforma Invoice PROL Pro-Labore PROT Protesto PROV Provisão REC Recibo REE Reembolso REND Rendimentos RES Resgate RET Rescisão Trabalhista RPA RPA SAN Sangria SAQ Saque SUP Suprimento TAR Tarifa TED TED TFE Taxa de Fiscalização de Estabelecimentos TIC Ticket TID Título Descontado TRA Transferência TRAV Transferência à Vista TRLAV Licenciamento TX Taxa VIST A Vista VOU Voucher WSITE Website Listagem completa disponível na API: /api/v1/ger"},"meio_pagamento":{"type":"string","description":"Meio de Pagamento - Utilizado apenas para emissão de NFS-e (campo \"tPag\" do XML). Esse campo indica como a parcela da nota será paga. Informação localizada na Aba \"Parcelas\" da Ordem de Serviço. Caso informado na estrutura \"informacoes_adicionais\" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura \"parcela\". Pode ser: 01 Dinheiro 02 Cheque 03 Cartão de Crédito 04 Cartão de Débito 05 Crédito Loja 10 Vale Alimentação 11 Vale Refeição 12 Vale Presente 13 Vale Combustível 15 Boleto Bancário 16 Depósito Bancário 17 Pagamento Instantâneo (PIX) 18 Transferência bancária, Carteira Digital 19 Programa de fidelidade, Cashback, Crédito Virtual. 90 Sem Pagamento 99 Outros Listagem completa disponível na API: /api/v1/geral/meiospagamento/"},"nsu":{"type":"string","description":"Número Sequencial Único NSU - Para identificar vendas por cartões ou TransactionID TID - Para identificar vendas de comercio eletrônico."},"nao_gerar_boleto":{"type":"string","description":"Não gerar boleto para esta parcela ao emitir a nota fiscal. Informe \"S\" para não gerar o boleto. O padrão é \"N\". Informação localizada na Aba \"Parcelas\" da Ordem de Serviço."},"parcela_adiantamento":{"type":"string","description":"Está é uma parcela de Adiantamento do Cliente. Informe \"S\" para indicar que é uma parcela de adiantamento. O padrão é \"N\". Informação localizada na Aba \"Parcelas\" da Ordem de Serviço."},"categoria_adiantamento":{"type":"string","description":"Código da Categoria para o Adiantamento. Será utilizada na conta a receber que representa o adiantamento desta parcela. Informação localizada na Aba \"Parcelas\" da Ordem de Serviço."},"conta_corrente_adiantamento":{"type":"integer","description":"Conta Corrente de Adiantamento. Informação localizada na Aba \"Parcelas\" da Ordem de Serviço."}}},"description":"Permite que o parcelamento seja realizado de forma manual."},"Observacoes":{"type":"object","properties":{"cObsOS":{"type":"string","description":"Observações da Ordem de Serviço. (Essas informação não serão exibidas na Nota Fiscal)."}}},"InfoCadastro":{"type":"object","properties":{"cCancelada":{"type":"string","description":"Ordem de Serviço cancelada?"},"cFaturada":{"type":"string","description":"Ordem de Serviço faturada com sucesso?"},"cAmbiente":{"type":"string","description":"Ambiente de emissão da NFS-e. Pode ser: H - Homologação P - Produção"},"dDtInc":{"type":"string","description":"Data de Inclusão da Ordem de Serviço"},"cHrInc":{"type":"string","description":"Hora de inclusão da Ordem de Serviço"},"uInc":{"type":"string","description":"Usuário da Inclusão. Não deve ser informado na Inclusão/Alteração."},"dDtAlt":{"type":"string","description":"Data de Alteração da Ordem de Serviço"},"cHrAlt":{"type":"string","description":"Hora de Alteração da Ordem de Serviço"},"uAlt":{"type":"string","description":"Usuário da Alteração. Não deve ser informado na Inclusão/Alteração."},"dDtFat":{"type":"string","description":"Data de Faturamento"},"cHrFat":{"type":"string","description":"Hora do Faturamento"},"dDtCanc":{"type":"string","description":"Data de Cancelamento"},"cHrCanc":{"type":"string","description":"Hora do Cancelamento"},"cOrigem":{"type":"string","description":"Origem da Ordem de Serviço"}},"description":"Informações do cadastro da Ordem de Serviço."},"despesasReembolsaveis":{"type":"object","properties":{"cCodCategReemb":{"type":"string","description":"Código da categoria para reembolso"},"despesaReembolsavel":{"type":"array","items":{"type":"object","properties":{"nCodReemb":{"type":"integer","description":"ID do Reembolso. (Código interno utilizado apenas na API, utilizado somente na Alteração e Exclusão). Esse código não aparece na tela do Omie. Utilize esse código para identificar a despesa via API."},"cAcaoReemb":{"type":"string","description":"Pode ser: \"A\" - Alterar a despesa. \"E\" - Excluir a despesa. \"I\" - Incluir a despesa na alteração."},"cDescReemb":{"type":"string","description":"Descrição da despesa."},"nValorReemb":{"type":"decimal","description":"Valor da despesa."},"dDataReemb":{"type":"string","description":"Data da despesa."}}},"description":"Despesa reembolsável"}},"description":"Despesas reembolsáveis."},"produtosUtilizados":{"type":"object","properties":{"cAcaoProdUtilizados":{"type":"string","description":"Pode ser: REM - Será gerado uma remessa dos produtos para o cliente. EST - Será gerado uma saída de estoque. Obrigatório na inclusão."},"cCodCategRem":{"type":"string","description":"Código da Categoria da Remessa ou Pedido de Venda. Obrigatório quando usar cAcaoFaturamento como 'REM' ou 'PED'"},"produtoUtilizado":{"type":"array","items":{"type":"object","properties":{"nIdItemPU":{"type":"integer","description":"(Código interno utilizado apenas na API). Não informar na inclusão. Esse código não aparece na tela do Omie."},"cAcaoItemPU":{"type":"string","description":"Pode ser: \"A\" - Alterar o item. \"E\" - Excluir o item. \"I\" - Incluir o item na alteração."},"nCodProdutoPU":{"type":"integer","description":"Código interno do produto. (utilizado apenas na API). Esse código não aparece na tela do Omie."},"nQtdePU":{"type":"decimal","description":"Quantidade."},"codigo_local_estoque":{"type":"integer","description":"Código do Local do Estoque."},"lote_validade":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","description":"Id do Lote do produto. Obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.."},"nQtdLote":{"type":"decimal","description":"Informe aqui a quantidade do Lote para o produto. É obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações."}}},"description":"Informações referentes ao lote e validade do produto. A tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes \"manualmente\" por API."}}},"description":"rodutos utilizados no serviço."}},"description":"Produtos Utilizados na Ordem de Serviço."},"Tarefas":{"type":"array","items":{"type":"object","properties":{"nCodTarefa":{"type":"integer","description":"Código único da tarefa."},"cCodIntTarefa":{"type":"string"},"cDescricao":{"type":"string","description":"Descrição da tarefa."},"dData":{"type":"string"},"hHora":{"type":"string"},"nCodDoc":{"type":"integer","description":"Id do documento vinculado a tarefa. Esse campo varia conforme a origem da tarefa. Ele permite vincular a tarefa a um documento específico, seja ele relacionado a uma oportunidade, contas a pagar, contas a receber, entre outros. Exemplo: Se a origem da tarefa for \"pedido-compra\", esse campo reflete o código do pedido de compra. Se a origem da tarefa for \"contas-receber\", esse campo reflete o código da conta a receber."},"nCodUserAtb":{"type":"integer","description":"Código do usuário atribuído."},"cNomeUserAtb":{"type":"string"}}},"description":"Lista com as tarefas relacionadas a ordem de serviço. Retornado apenas no método de consulta e quando preenchida a tag \"cIncluirTarefas\" como \"S\"."},"Caracteristicas":{"type":"array","items":{"type":"object","properties":{"cConteudo":{"type":"string","description":"Conteúdo da Característica."},"cNome":{"type":"string","description":"Nome da característica."},"nIdCampo":{"type":"integer","description":"Id do campo característica."},"nIdCaracteristica":{"type":"integer","description":"ID da Característica."}}},"description":"Características da Ordem de Serviço."}},"title":"ConsultarOS (retorno)"},"servicos_os_ExcluirOS":{"type":"object","title":"ExcluirOS","description":"Operação para excluir uma Ordem de Serviço.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirOS"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cCodIntOS":{"type":"string","maxLength":60,"description":"Código de Integração da OS"},"nCodOS":{"type":"integer","maxLength":15,"description":"Código da Ordem de Serviço"},"cNumOS":{"type":"string","maxLength":15,"description":"Número da Ordem de Serviço\nConforme visualizada na tela pelo cliente."},"despesasReembolsaveis":{"type":"object","properties":{"cCodCategReemb":{"type":"string","maxLength":20,"description":"Código da categoria para reembolso"},"despesaReembolsavel":{"type":"array","items":{"type":"object","properties":{"nCodReemb":{"type":"integer","maxLength":15,"description":"ID do Reembolso.\n\n(Código interno utilizado apenas na API, utilizado somente na Alteração e Exclusão).\nEsse código não aparece na tela do Omie.\nUtilize esse código para identificar a despesa via API."},"cAcaoReemb":{"type":"string","maxLength":1,"description":"Pode ser:\n\n\"A\" - Alterar a despesa.\n\"E\" - Excluir a despesa.\n\"I\" - Incluir a despesa na alteração."},"cDescReemb":{"type":"string","maxLength":200,"description":"Descrição da despesa."},"nValorReemb":{"type":"number","maxLength":18,"description":"Valor da despesa."},"dDataReemb":{"type":"string","maxLength":10,"description":"Data da despesa."}}},"description":"Despesa reembolsável"}},"description":"Despesas reembolsáveis."},"cIncluirTarefas":{"type":"string","maxLength":1,"description":"Indica se deve incluir as tarefas vinculadas a ordem de serviço no retorno (S/N).\n\nComo default é \"N\".\n\nDeve ser utilizado apenas no método de consulta."}}}}},"example":{"call":"ExcluirOS","param":[{"cCodIntOS":"","nCodOS":0,"cNumOS":""}]}},"servicos_os_ExcluirOS_retorno":{"type":"object","properties":{"cCodIntOS":{"type":"string","description":"Código de Integração da Ordem de Serviço"},"nCodOS":{"type":"integer","description":"Código da Ordem de Serviço"},"cNumOS":{"type":"string","description":"Número da Ordem de Serviço (Conforme visualizada em tela pelo cliente)"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDescStatus":{"type":"string","description":"Descrição do Status"}},"title":"ExcluirOS (retorno)"},"servicos_os_IncluirOS":{"type":"object","title":"IncluirOS","description":"Operação para incluir uma Ordem de Serviço","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirOS"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"Cabecalho":{"type":"object","properties":{"cCodIntOS":{"type":"string","maxLength":60,"description":"Código de Integração da OS.\nObrigatório na inclusão."},"nCodOS":{"type":"integer","maxLength":15,"description":"Código da Ordem de Serviço"},"cNumOS":{"type":"string","maxLength":15,"description":"Número da Ordem de Serviço\n(Conforme visualizada em tela pelo cliente)"},"cCodIntCli":{"type":"string","maxLength":60,"description":"Código de Integração do Cliente"},"nCodCli":{"type":"integer","maxLength":15,"description":"Código do Cliente"},"dDtPrevisao":{"type":"string","maxLength":10,"description":"Data de Previsão"},"cEtapa":{"type":"string","maxLength":2,"description":"Código da etapa do processo, sendo:\n\n10 - Primeira coluna\n20 - Segunda coluna\n30 - Terceira coluna\n40 - Quarta coluna\n50 - Faturar"},"nCodVend":{"type":"integer","maxLength":15,"description":"Código do Vendedor"},"nQtdeParc":{"type":"integer","maxLength":3,"description":"Quantidade de Parcelas"},"cCodParc":{"type":"string","maxLength":3,"description":"Código da parcela/Condição de pagamento.\n\nUtilize a tag \"nCodigo\" do método \"ListarFormasPagVendas\" da API\nhttp://app.omie.com.br/api/v1/produtos/formaspagvendas/\npara obter essa informação.\n\nO código \"999\" é o único que permite uma definição de forma de pagamento customizada. Caso você escolha essa opção, deve também informar a tag \"qtde_parcelas\" e a estrutura \"lista_parcelas\".\n\nAlguns dos valores disponíveis são:\n\n\"000\" - A Vista\n\"A03\" - Para 3 dias\n\"A05\" - Para 5 dias\n\"A07\" - Para 7 dias\n\"A08\" - Para 8 dias\n\"A09\" - Para 9 dias\n\"A10\" - Para 10 dias\n\"A13\" - Para 13 dias\n\"A14\" - Para 14 dias\n\"A15\" - Para 15 dias\n\"A17\" - Para 17 dias\n\"A20\" - Para 20 dias\n\"A21\" - Para 21 dias\n\"A25\" - Para 25 dias\n\"A26\" - Para 26 dias\n\"A28\" - Para 28 dias\n\"A35\" - Para 35 dias\n\"A36\" - Para 36 dias\n\"A40\" - Para 40 dias\n\"A42\" - Para 42 dias\n\"A45\" - Para 45 dias\n\"A50\" - Para 50 dias\n\"A56\" - Para 56 dias\n\"A60\" - Para 60 dias\n\"A70\" - Para 70 dias\n\"A75\" - Para 75 dias\n\"A90\" - Para 90 dias\n\"A98\" - Para 98 dias\n\"B20\" - Para 120 dias\n\"001\" - 1 Parcela (para 30 dias)\n\"002\" - 2 Parcelas\n\"003\" - 3 Parcelas\n\"004\" - 4 Parcelas\n\"005\" - 5 Parcelas\n\"006\" - 6 Parcelas\n\"007\" - 7 Parcelas\n\"010\" - 10 Parcelas\n\"012\" - 12 Parcelas\n\"024\" - 24 Parcelas\n\"036\" - 36 Parcelas\n\"048\" - 48 Parcelas\n\"S01\" - 30/60\n\"S02\" - 45/60\n\"S03\" - 21/28/35\n\"S04\" - 21/28/35/42\n\"S05\" - 28/35/42\n\"S06\" - 28/35/42/49\n\"S07\" - 30/45/60/75/90\n\"S08\" - 25/56\n\"S09\" - 30/45\n\"S10\" - 28/56\n\"S11\" - 10/30/60\n\"S12\" - 15/30/60\n\"S13\" - 28/35\n\"S14\" - 7/14/21\n\"S15\" - 10/30/60/90\n\"S16\" - 60/90/120\n\"S17\" - 45/60/90\n\"S18\" - 30/60/90\n\"S19\" - 14/21\n\"S20\" - 7/14\n\"S21\" - 14/21/28\n\"S22\" - 45/75\n\"S23\" - 30/45/60\n\"S24\" - 3/20/40\n\"S25\" - 30/60/90/120\n\"S26\" - 21/28\n\"S27\" - a Vista/15\n\"S28\" - a Vista/30\n\"S29\" - a Vista/30/60\n\"S30\" - a Vista/30/60/90\n\"S31\" - a Vista/30/60/90/120/150\n\"S41\" - 28/42/56\n\"S32\" - 15/45/75\n\"S33\" - 14/28/42\n\"S34\" - 14/21/28/35/42\n\"S35\" - 30/42/54/66/78/90\n\"S36\" - 14/21/28/35\n\"S37\" - 28/42\n\"S38\" - 30/45/60\n\"S39\" - 35/42/49/56\n\"S40\" - 28/42/56/70\n\"S42\" - 30/40/50/60\n\"S43\" - 30/50/70/90\n\"S44\" - 14/28\n\"S45\" - 45/60/75/90\n\"S46\" - a Vista/30/60/90/120\n\"S47\" - a vista/20/40/60\n\"S48\" - 21/42\n\"S49\" - 15/30/45\n\"S50\" - 14/42\n\"S51\" - 21/35\n\"S52\" - 28/56/84\n\"S53\" - 28/42/56/70/84\n\"S54\" - a Vista/30/45\n\"S55\" - 21/45\n\"S56\" - a Vista/28\n\"S57\" - a Vista/60/90\n\"S58\" - 35/45/55\n\"S59\" - 28/35/42/56\n\"S60\" - 30/45/60/75\n\"S61\" - 28/35/42/49/56\n\"S62\" - 40/70/100\n\"S63\" - 42/56\n\"S64\" - a Vista/28/35\n\"S65\" - 35/42\n\"S66\" - 20/40\n\"S67\" - a Vista/28/35/42"},"cDescParc":{"type":"string","maxLength":30,"description":"Descrição da parcela.\n\nUtilizado apenas para retorno do método \"ConsultarOS\"."},"nValorTotal":{"type":"number","maxLength":18,"description":"Valor total da Ordem de Serviço.\n\nNão deve ser informado na inclusão ou alteração.\nCampo calculado automaticamente."},"nValorTotalImpRet":{"type":"number","maxLength":18,"description":"Valor Total de Impostos Retidos"},"nCodCtr":{"type":"integer","maxLength":15,"description":"Código do Contrato.\nAo informar esse campo será incluído ao contrato uma Ordem de Serviço adicional.\n\nUtilizado somente na Inclusão/Alteração.\n\nUtilize a tag \"nCodCtr\" do método \"ListarContrato\" da API\n/api/v1/servicos/contrato/\npara obter essa informação"}},"description":"Cabeçalho da Ordem de Serviço"},"InformacoesAdicionais":{"type":"object","properties":{"cCodCateg":{"type":"string","maxLength":20,"description":"Categoria"},"nCodCC":{"type":"integer","maxLength":15,"description":"Código da Conta Corrente"},"cNumPedido":{"type":"string","maxLength":30,"description":"Número do Pedido do Cliente"},"cNumContrato":{"type":"string","maxLength":20,"description":"Número do Contrato de Venda"},"cContato":{"type":"string","maxLength":100,"description":"Contato"},"cDadosAdicNF":{"type":"string","description":"Dados Adicionais da Nota Fiscal"},"cCodObra":{"type":"string","maxLength":15,"description":"Código da Obra"},"cCodART":{"type":"string","maxLength":20,"description":"Código ART"},"nCodProj":{"type":"integer","maxLength":15,"description":"Código do Projeto"},"cCidPrestServ":{"type":"string","maxLength":40,"description":"Cidade da Prestação do Serviço"},"dDataRps":{"type":"string","maxLength":10,"description":"Data da RPS"},"cNumRecibo":{"type":"string","maxLength":10,"description":"Número do Recibo gerado.\n(Gerado automaticamente. Se informado na inclusão será ignorado)."},"cUsoConsumo":{"type":"string","maxLength":1,"description":"Uso e consumo pessoal."},"nIdDestinatario":{"type":"integer","maxLength":15,"description":"ID Cliente para o Destinatário."},"DetalhesNfse":{"type":"object","properties":{"Eventos":{"type":"object","properties":{"cCidadeEvento":{"type":"string","maxLength":40,"description":"Código da Cidade da Prestação de Serviços."},"cCodPaisEvento":{"type":"string","maxLength":4,"description":"Código do país do evento."},"cEndExtEvento":{"type":"string","maxLength":255,"description":"Endereço no Exterior do evento.\n\nA tag [cExtEvento] precisa ser preenchida como \"S\"."},"cBairroEvento":{"type":"string","maxLength":60,"description":"Bairro do Evento."},"cCepEvento":{"type":"string","maxLength":10,"description":"CEP do Evento."},"cEndEvento":{"type":"string","maxLength":60,"description":"Endereço do envento."},"cNumEndEvento":{"type":"string","maxLength":10,"description":"Número do endereço do evento."},"cUfEvento":{"type":"string","maxLength":2,"description":"Estado do evento."},"dDtIniEvento":{"type":"string","description":"Data de Início do Evento."},"dDtFimEvento":{"type":"string","description":"Data Final do Evento."},"cNomeEvento":{"type":"string","maxLength":60,"description":"Nome do evento."},"cComplEvento":{"type":"string","maxLength":40,"description":"Completo do endereço do evento."},"cCodAtivEvento":{"type":"string","maxLength":30,"description":"Código de Atividade do evento."},"cExtEvento":{"type":"string","maxLength":1,"description":"Evento no Exterior S/N."},"cCidadeExtEvento":{"type":"string","maxLength":60,"description":"Cidade do evento no exterior.\n\nA tag [cExtEvento] precisa ser preenchida como \"S\"."}},"description":"Evento na Nfse."}},"description":"Detalhes da NFSE."}}},"Email":{"type":"object","properties":{"cEnvRecibo":{"type":"string","maxLength":1,"description":"Enviar um recibo de prestação de serviços (ao invés da NFS-e)"},"cEnvLink":{"type":"string","maxLength":1,"description":"Enviar ao Cliente e-mail com o link do site da prefeitura para consultar  a NFSe emitida."},"cEnvBoleto":{"type":"string","maxLength":1,"description":"Enviar ao cliente e-mail com os Boletos de Cobrança gerados pelo faturamento.\n\nÉ permitido somente o preenchimento de uma das tags \"cEnvPix\" ou \"cEnvBoleto\"."},"cEnvPix":{"type":"string","maxLength":1,"description":"Enviar ao cliente e-mail com o PIX de Cobrança gerado pelo faturamento.\n\nÉ permitido somente o preenchimento de uma das tags \"cEnvPix\" ou \"cEnvBoleto\"."},"cEnviarPara":{"type":"string","description":"Utilizar os seguintes endereços de e-mail"},"cEnvViaUnica":{"type":"string","maxLength":1,"description":"Enviar ao cliente Via Única (Notas Fiscais Modelos 21 e 22).\n\nPode ser:\nS - Sim\nN - Não"}}},"Departamentos":{"type":"array","items":{"type":"object","properties":{"cCodDepto":{"type":"string","maxLength":40,"description":"ID do Departamento.\n\nInformação localizada na Aba \"Departamentos\" do Pedido de Venda.\n\nUtilize a tag \"codigo\" do método \"ListarDepatartamentos\" da API\nhttp://app.omie.com.br/api/v1/geral/departamentos/\npara obter essa informação."},"nPerc":{"type":"number","maxLength":10,"description":"Percentual de Rateio.\n\nInformação localizada na Aba \"Departamentos\" do Pedido de Venda."},"nValor":{"type":"number","maxLength":18,"description":"Valor do Rateio.\n\nInformação localizada na Aba \"Departamentos\" do Pedido de Venda."},"nValorFixo":{"type":"string","maxLength":1,"description":"Indica que o valor foi fixado na distribuição do rateio.\n\nInformar \"S\" ou \"N\".\n\nInformação localizada na Aba \"Departamentos\" do Pedido de Venda."}}},"description":"Dados da Aba \"Departamentos\" do Pedido de Venda."},"ServicosPrestados":{"type":"array","items":{"type":"object","properties":{"nCodServico":{"type":"integer","maxLength":15,"description":"Código Interno do Serviço conforme cadastrado na tabela de serviços.\n\n\nCaso preenchido, irá assumir as informações do cadastro de serviço.\n\nSe não for preenchido, assumirá os valores informados na API."},"cCodIntServico":{"type":"string","maxLength":60,"description":"Código de Integração do Serviço conforme cadastrado na tabela de serviços.\n\n\nCaso preenchido, irá assumir as informações do cadastro de serviço.\n\nSe não for preenchido, assumirá os valores informados na API."},"cTribServ":{"type":"string","maxLength":2,"description":"Tipo de Tributação dos Serviços.\n\n\nCaso tenha informado a tag \"nCodServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço.\n\nValores pode variar de acordo com o município. Verifique a legislação da sua cidade para obter os tipos de tributação disponíveis."},"cCodServMun":{"type":"string","maxLength":20,"description":"Código do Serviço Municipal ou CNAE.\n\n\nCaso tenha informado a tag \"nCodServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço.\n\nValores pode variar de acordo com o município. Verifique a legislação da sua cidade para obter os códigos de serviço disponíveis."},"cCodServLC116":{"type":"string","maxLength":20,"description":"Código do Serviço conforme Lei Complementar (LC 116).\n\n\nCaso tenha informado a tag \"nCodServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço.\n\nTabela única para todos os municípios."},"nQtde":{"type":"number","maxLength":18,"description":"Quantidade de serviços."},"nValUnit":{"type":"number","maxLength":18,"description":"Valor Unitário do serviço.\n\n\nCaso tenha informado a tag \"nCodServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço."},"cTpDesconto":{"type":"string","maxLength":1,"description":"Tipo de Desconto.\n\n\nPode ser:\nP - Percentual\nV - Valor"},"nValorDesconto":{"type":"number","maxLength":18,"description":"Valor do Desconto."},"nAliqDesconto":{"type":"number","maxLength":18,"description":"Aliquota do Desconto."},"nValorOutrasRetencoes":{"type":"number","maxLength":18,"description":"Valor de Outras Retenções.\n\n\n(Disponível apenas para cidades que oferecem esse recurso.)"},"nValorAcrescimos":{"type":"number","maxLength":18,"description":"Valor de Acréscimos e taxas.\n\n\n(Disponível apenas para cidades que oferecem esse recurso.)"},"cDescServ":{"type":"string","description":"Descrição dos Serviços.\n\n\nCaso tenha informado a tag \"nCodServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço."},"cRetemISS":{"type":"string","maxLength":1,"description":"Retem ISS (S/N)"},"cDadosAdicItem":{"type":"string","description":"Dados adicionais do Item."},"cNbs":{"type":"string","maxLength":9,"description":"Código da Nomenclatura Brasileira de Serviços (NBS).\n\n\nCaso tenha informado a tag \"nCodServico\" irá assumir o valor informado no cadastro do respectivo serviço."},"impostos":{"type":"object","properties":{"cFixarISS":{"type":"string","maxLength":1,"description":"Indica se o imposto foi alterado pelo usuário ou informado via importação de planilha ou API.\n\nEsse campo é preenchido automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"nAliqISS":{"type":"number","maxLength":10,"description":"Alíquota de ISS."},"nBaseISS":{"type":"number","maxLength":18,"description":"Base de Cálculo do ISS.\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"nTotDeducao":{"type":"number","maxLength":18,"description":"Valor de Dedução da Base de Cálculo.\n\n\nPor padrão, esse campo afeta a Base de Cálculo do ISS.\n\nPara atender a condições legais acordadas para cada munícipio pode afetar as Bases de Cálculos dos Impostos Federais também. Consulte a legislação do seu município."},"nValorDeducao":{"type":"number","maxLength":18,"description":"Valor das deduções do item.\n\nUtilizado apenas nos métodos de Consulta/Listagem."},"nValorISS":{"type":"number","maxLength":18,"description":"Valor do ISS.\n\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"cUtilizaValorImposto":{"type":"string","maxLength":1,"description":"Indica se o valor informado para os Impostos Federais deverá ser mantido ao invés de ser recalculado a partir da alíquota.\n\n\nAssim:\n\nCaso seja informado \"N\", indica que valor do imposto deve ser calculado a partir da alíquota e base de cálculo.\n\nCaso seja informado \"S\", indica que o valor do imposto será mantido e a alíquota será recalculada a partir do valor do imposto e base de cálculo."},"cFixarIRRF":{"type":"string","maxLength":1,"description":"Indica se o imposto foi alterado pelo usuário ou informado via importação de planilha ou API.\n\nEsse campo é preenchido automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"nAliqIRRF":{"type":"number","maxLength":10,"description":"Alíquota de IRRF.\n\n\nPara o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\".\n\nLembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"nValorIRRF":{"type":"number","maxLength":18,"description":"Valor do IRRF.\n\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\".\n\nCaso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"nValorDeducaoIRRF":{"type":"number","maxLength":18,"description":"Valor da dedução da base do IR."},"cRetemIRRF":{"type":"string","maxLength":1,"description":"Retém IRRF  (S/N).\n\n\nIndica se o imposto deve ser retido ou não."},"cFixarPIS":{"type":"string","maxLength":1,"description":"Indica se o imposto foi alterado pelo usuário ou informado via importação de planilha ou API.\n\nEsse campo é preenchido automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"nAliqPIS":{"type":"number","maxLength":10,"description":"Alíquota de PIS.\n\n\nPara o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\".\n\nLembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"nValorPIS":{"type":"number","maxLength":18,"description":"Valor do PIS.\n\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\".\n\nCaso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"cRetemPIS":{"type":"string","maxLength":1,"description":"Retém PIS  (S/N).\n\n\nIndica se o imposto deve ser retido ou não."},"cFixarCOFINS":{"type":"string","maxLength":1,"description":"Indica se o imposto foi alterado pelo usuário ou informado via importação de planilha ou API.\n\nEsse campo é preenchido automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"nAliqCOFINS":{"type":"number","maxLength":10,"description":"Alíquota de COFINS.\n\n\nPara o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\".\n\nLembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"nValorCOFINS":{"type":"number","maxLength":18,"description":"Valor do COFINS.\n\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\".\n\nCaso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"cRetemCOFINS":{"type":"string","maxLength":1,"description":"Retém COFINS  (S/N).\n\n\nIndica se o imposto deve ser retido ou não."},"cFixarCSLL":{"type":"string","maxLength":1,"description":"Indica se o imposto foi alterado pelo usuário ou informado via importação de planilha ou API.\n\nEsse campo é preenchido automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"nAliqCSLL":{"type":"number","maxLength":10,"description":"Alíquota de CSLL.\n\nPara o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\".\n\nLembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"nValorCSLL":{"type":"number","maxLength":18,"description":"Valor de CSLL.\n\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\".\n\nCaso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"cRetemCSLL":{"type":"string","maxLength":1,"description":"Retém CSLL  (S/N).\n\n\nIndica se o imposto deve ser retido ou não."},"cFixarINSS":{"type":"string","maxLength":1,"description":"Indica se o imposto foi alterado pelo usuário ou informado via importação de planilha ou API.\n\nEsse campo é preenchido automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"nAliqINSS":{"type":"number","maxLength":10,"description":"Alíquota de INSS.\n\n\nPara o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\".\n\nLembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"nValorINSS":{"type":"number","maxLength":18,"description":"Valor de INSS.\n\n\nEsse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\".\n\nCaso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"cRetemINSS":{"type":"string","maxLength":1,"description":"Retém INSS  (S/N).\n\n\nIndica se o imposto deve ser retido ou não."},"nAliqRedBaseINSS":{"type":"number","maxLength":10,"description":"Percentual de Redução da Base de Cálculo do INSS."},"nAliqRedBaseCOFINS":{"type":"number","maxLength":10,"description":"Percentual de Redução da Base de Cálculo do COFINS."},"nAliqRedBasePIS":{"type":"number","maxLength":10,"description":"Percentual de Redução da Base de Cálculo do PIS."},"lDeduzISS":{"type":"boolean","description":"Deduz o ISS da Base de Cálculo de PIS e COFINS"},"cCST":{"type":"string","maxLength":3,"description":"Código da Situação Tributária IBS/CBS.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"cClassTrib":{"type":"string","maxLength":6,"description":"Código de Classificação Tributária.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"nAliqIbsUf":{"type":"number","maxLength":10,"description":"Alíquota do IBS estadual.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"nAliqIbsMun":{"type":"number","maxLength":10,"description":"Alíquota do IBS Municipal.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"nPercReducaoIbsUf":{"type":"number","maxLength":18,"description":"Percentual redução IBS estadual.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"nPercReducaoIbsMun":{"type":"number","maxLength":18,"description":"Percentual redução IBS municipal.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"nAliqCbs":{"type":"number","maxLength":10,"description":"Alíquota da CBS\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"nPercReducaoCbs":{"type":"number","maxLength":18,"description":"Percentual redução CBS.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"cIndOPer":{"type":"string","maxLength":6,"description":"Código Indicador de Operação.\n\nCaso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"nValorIbsUf":{"type":"number","maxLength":18,"description":"Valor do IBS Estadual.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"nValorIbsMun":{"type":"number","maxLength":18,"description":"Valor do IBS Municipal.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"nValorCbs":{"type":"number","maxLength":18,"description":"Valor da CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"cManCbs":{"type":"string","maxLength":1,"description":"Indica que houve alteração manual da alíquota de CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"cManIbsMun":{"type":"string","maxLength":1,"description":"Indica que houve alteração manual da alíquota de IBS Municipal.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"cManIbsUf":{"type":"string","maxLength":1,"description":"Indica que houve alteração manual da alíquota de IBS Estadual.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"nBaseCalcIbsCbs":{"type":"number","maxLength":18,"description":"Valor da Base de Calculo do IBS e CBS.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta.\n\nPara os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"nAliqFederalIBPT":{"type":"number","maxLength":10,"description":"Alíquota da Carga Tribut. Aproximada Federal."},"nAliqEstadualIBPT":{"type":"number","maxLength":10,"description":"Alíquota da Carga Tribut. Aproximada Estadual."},"nAliqMunicipalIBPT":{"type":"number","maxLength":10,"description":"Alíquota da Carga Tribut. Aproximada Municipal."}},"required":["nAliqCOFINS","nAliqCSLL","nAliqINSS","nAliqIRRF","nAliqPIS"],"description":"Dados do impostos do serviço."},"DeducoesIss":{"type":"array","items":{"type":"object","properties":{"cFormaDeducao":{"type":"string","maxLength":1,"description":"Tipo de dedução. Informe 'P' para Percentual ou 'V' para Valor."},"nPercDeducao":{"type":"number","maxLength":18,"description":"Percentual de dedução."},"nValorDeducao":{"type":"number","maxLength":18,"description":"Valor da Dedução."},"cTipoDeduducao":{"type":"string","maxLength":1,"description":"Tipo da Dedução. Informe  '1' para  Materiais ou 2 para Sub-Empreitada"},"cNFReferencia":{"type":"string","maxLength":20,"description":"Nota Fiscal de Referência."},"cCnpjFornecedor":{"type":"string","maxLength":20,"description":"CPF ou CNPJ do Fornecedor"},"nValorTotNfRef":{"type":"number","maxLength":18,"description":"Valor total NF de Referência"},"nQuantMateriais":{"type":"number","maxLength":18,"description":"Quantidade de Material"},"cDescMateriais":{"type":"string","maxLength":100,"description":"Descrição do material."}}},"description":"Informe aqui as Deduções para o ISS."},"cNaoGerarFinanceiro":{"type":"string","maxLength":1,"description":"Não gerar conta a receber para este item.\n\n\nInformar \"S\" para não gerar movimento financeiro.\nInformar \"N\" para gerar movimento financeiro."},"cCodCategItem":{"type":"string","maxLength":20,"description":"Código da Categoria."},"nSeqItem":{"type":"integer","maxLength":4,"description":"Sequencia do Item\n\n\nDeve ser preenchido com uma sequencia de 1 a 199."},"nIdItem":{"type":"integer","maxLength":15,"description":"ID do Item da Ordem de Serviço.\n\nNão deve ser informado na inclusão.\n\nPode ser informado na alteração para identificar o item."},"cAcaoItem":{"type":"string","maxLength":1,"description":"Ação a ser realizada na alteração do item.\n\nPode ser:\n\n\"A\" - Alterar o item (padrão).\n\"E\" - Excluir o item.\n\"I\"  - Incluir o item na alteração."},"viaUnica":{"type":"object","properties":{"cModeloNF":{"type":"string","maxLength":2,"description":"Indica qual modelo de NF será emitida para o serviço.\n\nObrigatório quando a tag cEnvViaUnica for igual a \"S\".\n\nPode ser:\n21 - Nota Fiscal de Serviço de Comunicação\n22 - Nota Fiscal de Serviço de Telecomunicação"},"cCFOP":{"type":"string","maxLength":10,"description":"Código CFOP para NF Via Única (Modelos 21 e 22).\n\nObrigatório quando a tag cEnvViaUnica for igual a \"S\".\n\nUtilize a tag \"nCodigo\" do método \"ListarCFOP\" da API  /api/v1/produtos/cfop/ para obter essa informação."},"cClassifServico":{"type":"string","maxLength":4,"description":"Código da Classificação para NF Via Única (Modelos 21 e 22).\n\nObrigatório quando a tag cEnvViaUnica for igual a \"S\".\n\nUtilize a tag \"cCodigo\" do método \"ListarClassificacaoServico\" da API\n/api/v1/servicos/classificacaoservico/ para obter essa informação."},"cTipoReceita":{"type":"string","maxLength":1,"description":"Indicador do Tipo de Receita para NF Via Única (Modelos 21 e 22).\n\nObrigatório quando a tag cEnvViaUnica for igual a \"S\".\n\nPode ser:\n0 - Receita própria - serviços prestados\n1 - Receita própria - cobrança de débitos\n2 - Receita própria - venda de mercadorias\n3 - Receita própria - venda de serviço pré-pago\n4 - Outras receitas próprias\n5 - Receitas de terceiros (co-faturamento)\n9 - Outras receitas de terceiros"},"cTipoUtilizacao":{"type":"string","maxLength":1,"description":"Código do tipo de utilização para NF Via Única (Modelos 21 e 22).\n\nObrigatório quando a tag cEnvViaUnica for igual a \"S\".\n\nUtilize a tag \"cCodigo\" do método \"ListarTipoUtilizacao\" da API\n/api/v1/servicos/tipoutilizacao/ para obter essa informação."}},"description":"Informações referente ao serviço de NF modelo 21 ou 22."},"cReembolso":{"type":"string","maxLength":1,"description":"Identificação se o item é despesa reembolsável."},"cCodigo":{"type":"string","maxLength":20,"description":"Código do serviço.\n\nNão deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta."}}},"description":"Item da Ordem serviço"},"Parcelas":{"type":"array","items":{"type":"object","properties":{"nParcela":{"type":"integer","maxLength":3,"description":"Número da Parcela.\nEx.:\n1 para indicar a parcela 1,\n2 para indicar a parcela 2."},"dDtVenc":{"type":"string","maxLength":10,"description":"Data de Vencimento da parcela.\nEx:\n01/02/2016"},"nValor":{"type":"number","maxLength":18,"description":"Valor da Parcela.\nEx:\n100.23"},"nPercentual":{"type":"number","maxLength":9,"description":"Percentual do valor da parcela."},"nDias":{"type":"integer","maxLength":4,"description":"Número de dias até o vencimento.\nO preenchimento deste campo não é obrigatório.\nEx:\n28 para vencimento para 28 dias."},"tipo_documento":{"type":"string","maxLength":5,"description":"Tipo de Documento.\n\n\nInformação localizada na Aba \"Parcelas\" da Ordem de Serviço.\n\nPode ser:\n13S   13o. Salário\n99999 Outros\nACO   Acordo\nACOB  Acordo - Boleto\nACOT  Acordo - Transferência\nADI   Adiantamento\nANT   Antecipação\nAPL   Aplicação\nAPO   Apólice\nAPOR  Aporte\nASS   Assinatura\nBIL   Bilhete\nBOL   Boleto\nBOLV  Boleto à Vista\nBONUS Bonus\nCAP   Capitalização\nCART  Carteira\nCF    Cupom Fiscal\nCHD   Cheque Devolvido\nCHP   Cheque Pré\nCHQ   Cheque\nCHT   Cheque de Terceiros\nCNT   Crédito em Conta\nCOB   Cobrança\nCOM   Comissão\nCON   Convênios\nCONC  Cobrança de Concessionária\nCOND  Condicional\nCONS  Consignado\nCONSO Consórcio\nCRC   Cartão de Crédito\nCRD   Cartão de Débito\nCRE   Crediário\nCRP   Cartão Pré-Pago\nCRT   Cartão\nCRTO  Cartório\nCTE   CT-e\nCTR   Contrato\nCUSJ  Custos Judiciais\nDACTE DACTE\nDAE   DAE\nDAJE  DAJE\nDAM   DAM\nDANFE DANFE\nDAR   DAR\nDARE  DARE\nDARJ  DARJ\nDARM  DARM\nDAS   DAS\nDDA   DDA\nDEB   Débito em Conta\nDEBA  Débito Automático\nDEP   Depósito\nDEV   Devolução\nDFE   Documento Fiscal Equivalente\nDIN   Dinheiro\nDLC   Distribuição de Lucros\nDNF   Documento não fiscal\nDNFSE DANFSE\nDOA   Doação\nDOC   DOC\nDPVAT DPVAT\nDRF   DARF\nDUA   DUA\nDUAM  DUAM\nDUP   Duplicata\nEMP   Empréstimo\nENC   Encargos\nETAR  Estorno de Tarifa\nFAT   Fatura\nFER   Férias\nFIA   Fiado\nFIN   Financiamento\nFPGT  Folha de Pagamento\nGAR   Garantia\nGARE  GARE\nGNRE  GNRE\nGPS   GPS\nGRCS  GRCS\nGRCSU GRCSU\nGRF   Guia de Recolhimento do FGTS\nGRU   GRU\nGUIA  Guia de Recolhimento\nHOL   Holerite\nIMP   Imposto\nINV   Invoice\nIPTU  IPTU\nIPVA  IPVA\nJUROS Juros Limite\nMED   Medição\nMULTA Multas\nMUTUO Mútuo\nNC    Nota de Crédito\nND    Nota de Débito\nNF    Nota Fiscal\nNF3E  Nota Fiscal de Energia Elétrica Eletrônica\nNFA   Nota Fiscal de Abastecimento\nNFC   Nota Fiscal de Consumidor\nNFCE  Nota Fiscal de Consumidor Eletrônica\nNFD   Nota Fiscal de Devolução\nNFE   Nota Fiscal Eletrônica\nNFEE  Nota Fiscal Energia Elétrica\nNFS   Nota Fiscal de Serviço\nNFST  Nota Fiscal de Telecomunicações\nNFSTM Nota Fiscal de Serviço Tomado\nPDD   PDD\nPED   Pedido\nPEN   Pensão Alimentícia\nPER   Permuta\nPIX   Pix\nPROF  Proforma Invoice\nPROL  Pro-Labore\nPROT  Protesto\nPROV  Provisão\nREC   Recibo\nREE   Reembolso\nREND  Rendimentos\nRES   Resgate\nRET   Rescisão Trabalhista\nRPA   RPA\nSAN   Sangria\nSAQ   Saque\nSUP   Suprimento\nTAR   Tarifa\nTED   TED\nTFE   Taxa de Fiscalização de Estabelecimentos\nTIC   Ticket\nTID   Título Descontado\nTRA   Transferência\nTRAV  Transferência à Vista\nTRLAV Licenciamento\nTX    Taxa\nVIST  A Vista\nVOU   Voucher\nWSITE Website\n\nListagem completa disponível na API:\n/api/v1/ger"},"meio_pagamento":{"type":"string","maxLength":100,"description":"Meio de Pagamento - Utilizado apenas para emissão de NFS-e (campo \"tPag\" do XML).\nEsse campo indica como a parcela da nota será paga.\n\n\nInformação localizada na Aba \"Parcelas\" da Ordem de Serviço.\n\nCaso informado na estrutura \"informacoes_adicionais\" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura \"parcela\".\n\nPode ser:\n01  Dinheiro\n02  Cheque\n03  Cartão de Crédito\n04  Cartão de Débito\n05  Crédito Loja\n10  Vale Alimentação\n11  Vale Refeição\n12  Vale Presente\n13  Vale Combustível\n15  Boleto Bancário\n16  Depósito Bancário\n17  Pagamento Instantâneo (PIX)\n18  Transferência bancária, Carteira Digital\n19  Programa de fidelidade, Cashback, Crédito Virtual.\n90  Sem Pagamento\n99  Outros\n\nListagem completa disponível na API:\n/api/v1/geral/meiospagamento/"},"nsu":{"type":"string","maxLength":100,"description":"Número Sequencial Único NSU - Para identificar vendas por cartões ou TransactionID TID - Para identificar vendas de comercio eletrônico."},"nao_gerar_boleto":{"type":"string","maxLength":1,"description":"Não gerar boleto para esta parcela ao emitir a nota fiscal.\n\nInforme \"S\" para não gerar o boleto. O padrão é \"N\".\n\n\nInformação localizada na Aba \"Parcelas\" da Ordem de Serviço."},"parcela_adiantamento":{"type":"string","maxLength":1,"description":"Está é uma parcela de Adiantamento do Cliente.\n\nInforme \"S\" para indicar que é uma parcela de adiantamento.\nO padrão é \"N\".\n\n\nInformação localizada na Aba \"Parcelas\" da Ordem de Serviço."},"categoria_adiantamento":{"type":"string","maxLength":20,"description":"Código da Categoria para o Adiantamento.\nSerá utilizada na conta a receber que representa o adiantamento desta parcela.\n\n\nInformação localizada na Aba \"Parcelas\" da Ordem de Serviço."},"conta_corrente_adiantamento":{"type":"integer","maxLength":15,"description":"Conta Corrente de Adiantamento.\n\n\nInformação localizada na Aba \"Parcelas\" da Ordem de Serviço."}},"required":["nDias","nParcela"]},"description":"Permite que o parcelamento seja realizado de forma manual."},"Observacoes":{"type":"object","properties":{"cObsOS":{"type":"string","description":"Observações da Ordem de Serviço. (Essas informação não serão exibidas na Nota Fiscal)."}}},"InfoCadastro":{"type":"object","properties":{"cCancelada":{"type":"string","maxLength":1,"example":"S","description":"Ordem de Serviço cancelada?"},"cFaturada":{"type":"string","maxLength":1,"example":"S","description":"Ordem de Serviço faturada com sucesso?"},"cAmbiente":{"type":"string","maxLength":1,"description":"Ambiente de emissão da NFS-e.\n\nPode ser:\n\nH - Homologação\nP - Produção"},"dDtInc":{"type":"string","maxLength":10,"description":"Data de Inclusão da Ordem de Serviço"},"cHrInc":{"type":"string","maxLength":8,"description":"Hora de inclusão da Ordem de Serviço"},"uInc":{"type":"string","maxLength":10,"description":"Usuário da Inclusão.\n\nNão deve ser informado na Inclusão/Alteração."},"dDtAlt":{"type":"string","maxLength":10,"description":"Data de Alteração da Ordem de Serviço"},"cHrAlt":{"type":"string","maxLength":8,"description":"Hora de Alteração da Ordem de Serviço"},"uAlt":{"type":"string","maxLength":10,"description":"Usuário da Alteração.\n\nNão deve ser informado na Inclusão/Alteração."},"dDtFat":{"type":"string","maxLength":10,"description":"Data de Faturamento"},"cHrFat":{"type":"string","maxLength":8,"description":"Hora do Faturamento"},"dDtCanc":{"type":"string","maxLength":10,"description":"Data de Cancelamento"},"cHrCanc":{"type":"string","maxLength":8,"description":"Hora do Cancelamento"},"cOrigem":{"type":"string","maxLength":3,"description":"Origem da Ordem de Serviço"}},"description":"Informações do cadastro da Ordem de Serviço."},"despesasReembolsaveis":{"type":"object","properties":{"cCodCategReemb":{"type":"string","maxLength":20,"description":"Código da categoria para reembolso"},"despesaReembolsavel":{"type":"array","items":{"type":"object","properties":{"nCodReemb":{"type":"integer","maxLength":15,"description":"ID do Reembolso.\n\n(Código interno utilizado apenas na API, utilizado somente na Alteração e Exclusão).\nEsse código não aparece na tela do Omie.\nUtilize esse código para identificar a despesa via API."},"cAcaoReemb":{"type":"string","maxLength":1,"description":"Pode ser:\n\n\"A\" - Alterar a despesa.\n\"E\" - Excluir a despesa.\n\"I\" - Incluir a despesa na alteração."},"cDescReemb":{"type":"string","maxLength":200,"description":"Descrição da despesa."},"nValorReemb":{"type":"number","maxLength":18,"description":"Valor da despesa."},"dDataReemb":{"type":"string","maxLength":10,"description":"Data da despesa."}}},"description":"Despesa reembolsável"}},"description":"Despesas reembolsáveis."},"produtosUtilizados":{"type":"object","properties":{"cAcaoProdUtilizados":{"type":"string","maxLength":3,"description":"Pode ser:\nREM - Será gerado uma remessa dos produtos para o cliente.\nEST - Será gerado uma saída de estoque.\n\nObrigatório na inclusão."},"cCodCategRem":{"type":"string","maxLength":20,"description":"Código da Categoria da Remessa ou Pedido de Venda.\n\nObrigatório quando usar cAcaoFaturamento como 'REM' ou 'PED'"},"produtoUtilizado":{"type":"array","items":{"type":"object","properties":{"nIdItemPU":{"type":"integer","maxLength":15,"description":"(Código interno utilizado apenas na API).\nNão informar na inclusão.\n\nEsse código não aparece na tela do Omie."},"cAcaoItemPU":{"type":"string","maxLength":1,"description":"Pode ser:\n\n\"A\" - Alterar o item.\n\"E\" - Excluir o item.\n\"I\" - Incluir o item na alteração."},"nCodProdutoPU":{"type":"integer","maxLength":15,"description":"Código interno do produto.\n(utilizado apenas na API).\nEsse código não aparece na tela do Omie."},"nQtdePU":{"type":"number","maxLength":18,"description":"Quantidade."},"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do Local do Estoque."},"lote_validade":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","maxLength":15,"description":"Id do Lote do produto.\n\nObrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.."},"nQtdLote":{"type":"number","maxLength":18,"description":"Informe aqui a quantidade do Lote para o produto.\n\nÉ obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações."}},"required":["nQtdLote"]},"description":"Informações referentes ao lote e validade do produto.\n\nA tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes \"manualmente\" por API."}}},"description":"rodutos utilizados no serviço."}},"description":"Produtos Utilizados na Ordem de Serviço."},"Tarefas":{"type":"array","items":{"type":"object","properties":{"nCodTarefa":{"type":"integer","maxLength":15,"description":"Código único da tarefa."},"cCodIntTarefa":{"type":"string","maxLength":20},"cDescricao":{"type":"string","maxLength":10,"description":"Descrição da tarefa."},"dData":{"type":"string"},"hHora":{"type":"string","maxLength":5},"nCodDoc":{"type":"integer","maxLength":15,"description":"Id do documento vinculado a tarefa.\n\nEsse campo varia conforme a origem da tarefa.\nEle permite vincular a tarefa a um documento específico, seja ele relacionado a uma oportunidade, contas a pagar, contas a receber, entre outros.\n\nExemplo:\nSe a origem da tarefa for \"pedido-compra\", esse campo reflete o código do pedido de compra.\nSe a origem da tarefa for \"contas-receber\", esse campo reflete o código da conta a receber."},"nCodUserAtb":{"type":"integer","maxLength":15,"description":"Código do usuário atribuído."},"cNomeUserAtb":{"type":"string","maxLength":800}}},"description":"Lista com as tarefas relacionadas a ordem de serviço.\n\nRetornado apenas no método de consulta e quando preenchida a tag \"cIncluirTarefas\" como \"S\"."},"Caracteristicas":{"type":"array","items":{"type":"object","properties":{"cConteudo":{"type":"string","maxLength":7000,"description":"Conteúdo da Característica."},"cNome":{"type":"string","maxLength":70,"description":"Nome da característica."},"nIdCampo":{"type":"integer","maxLength":15,"description":"Id do campo característica."},"nIdCaracteristica":{"type":"integer","maxLength":15,"description":"ID da Característica."}}},"description":"Características da Ordem de Serviço."}}}}},"example":{"call":"IncluirOS","param":[{"Cabecalho":{"cCodIntOS":"1790776458","cCodParc":"999","cEtapa":"20","dDtPrevisao":"30/09/2026","nCodCli":2485994,"nQtdeParc":7},"Departamentos":[],"Email":{"cEnvBoleto":"N","cEnvLink":"N","cEnviarPara":"teste@omie.com.br"},"InformacoesAdicionais":{"cCidPrestServ":"SAO PAULO (SP)","cCodCateg":"1.01.02","cDadosAdicNF":"OS incluida via API de teste 79056","nCodCC":11850365},"ServicosPrestados":[{"cCodServLC116":"7.07","cCodServMun":"01015","cDadosAdicItem":"Serviços prestados","cDescServ":"Serviço prestado 001","cRetemISS":"N","cTribServ":"01","impostos":{"cRetemIRRF":"S","cRetemPIS":"S","nAliqCOFINS":0,"nAliqCSLL":0,"nAliqIRRF":15,"nAliqISS":3,"nAliqPIS":4.5},"nQtde":3,"nValUnit":1000},{"impostos":{"cRetemIRRF":"S","cRetemPIS":"S","nAliqIRRF":15,"nAliqISS":3,"nAliqPIS":4.5},"nCodServico":2342423,"nQtde":12,"nValUnit":35}]}]}},"servicos_os_IncluirOS_retorno":{"type":"object","properties":{"cCodIntOS":{"type":"string","description":"Código de Integração da Ordem de Serviço"},"nCodOS":{"type":"integer","description":"Código da Ordem de Serviço"},"cNumOS":{"type":"string","description":"Número da Ordem de Serviço (Conforme visualizada em tela pelo cliente)"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDescStatus":{"type":"string","description":"Descrição do Status"}},"title":"IncluirOS (retorno)"},"servicos_os_ListarOS":{"type":"object","title":"ListarOS","description":"Lista as Ordens de Serviços.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarOS"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15},"registros_por_pagina":{"type":"integer","maxLength":15},"apenas_importado_api":{"type":"string","maxLength":1},"ordenar_por":{"type":"string","maxLength":100,"description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Ordem Crescente ou Decrescente."},"filtrar_por_data_de":{"type":"string","maxLength":10,"description":"Data de inclusão e/ou alteração inicial."},"filtrar_por_data_ate":{"type":"string","maxLength":10,"description":"Data de inclusão e/ou alteração final."},"filtrar_apenas_inclusao":{"type":"string","maxLength":1},"filtrar_apenas_alteracao":{"type":"string","maxLength":1},"filtrar_por_codigo":{"type":"array","items":{"type":"object","properties":{"nCodOS":{"type":"integer","maxLength":15,"description":"Código da Ordem de Serviço.\n(Código interno utilizado apenas na API)."},"cCodIntOS":{"type":"string","maxLength":60,"description":"Código de Integração da OS."}}},"description":"Lista de códigos de Ordem de Serviço."},"filtrar_por_status":{"type":"string","maxLength":1,"description":"Status da OS:\n\nF-Faturada\nN-Não faturada\nC-Cancelada"},"filtrar_por_etapa":{"type":"string","maxLength":2,"description":"Etapa da Ordem de Serviço."},"filtrar_por_cliente":{"type":"integer","maxLength":15,"description":"Filtra pelo ID do cliente."},"filtrar_por_data_previsao_de":{"type":"string","maxLength":10,"description":"Data de previsão inicial"},"filtrar_por_data_previsao_ate":{"type":"string","maxLength":10,"description":"Data de previsão final."},"filtrar_por_data_faturamento_de":{"type":"string","maxLength":10,"description":"Data de faturamento inicial."},"filtrar_por_data_faturamento_ate":{"type":"string","maxLength":10,"description":"Data de faturamento final."},"filtrar_por_data_cancelamento_de":{"type":"string","maxLength":10,"description":"Data de cancelamento inicial."},"filtrar_por_data_cancelamento_ate":{"type":"string","maxLength":10,"description":"Data de cancelamento final."},"ordem_descrescente":{"type":"string","maxLength":1,"description":"Descontinuado."},"cExibirDespesas":{"type":"string","maxLength":1,"description":"Exibir as despesas reembolsáveis (S/N).\n\n\nPreencher com \"S\" ou \"N\"."},"cExibirProdutos":{"type":"string","maxLength":1,"description":"Exibir os produtos utilizados (S/N).\n\n\nPreencher com \"S\" ou \"N\"."},"cTipoFat":{"type":"string","maxLength":3,"description":"Tipo de faturamento:\n\nPode ser:\n\nREC - Recibo\nNFS - NFS-e\nVUF - Via única não autorizada\nVUA - Via única autorizada"},"cExibirCaracteristicas":{"type":"string","maxLength":1,"description":"Exibir as características  (S/N).\n\n\nPreencher com \"S\" ou \"N\"."}}}}},"example":{"call":"ListarOS","param":[{"pagina":1,"registros_por_pagina":50,"apenas_importado_api":"N"}]}},"servicos_os_ListarOS_retorno":{"type":"object","properties":{"pagina":{"type":"integer"},"total_de_paginas":{"type":"integer"},"registros":{"type":"integer"},"total_de_registros":{"type":"integer"},"osCadastro":{"type":"array","items":{"type":"object","properties":{"Cabecalho":{"type":"object","properties":{"cCodIntOS":{"type":"string","description":"Código de Integração da OS. Obrigatório na inclusão."},"nCodOS":{"type":"integer","description":"Código da Ordem de Serviço"},"cNumOS":{"type":"string","description":"Número da Ordem de Serviço (Conforme visualizada em tela pelo cliente)"},"cCodIntCli":{"type":"string","description":"Código de Integração do Cliente"},"nCodCli":{"type":"integer","description":"Código do Cliente"},"dDtPrevisao":{"type":"string","description":"Data de Previsão"},"cEtapa":{"type":"string","description":"Código da etapa do processo, sendo: 10 - Primeira coluna 20 - Segunda coluna 30 - Terceira coluna 40 - Quarta coluna 50 - Faturar"},"nCodVend":{"type":"integer","description":"Código do Vendedor"},"nQtdeParc":{"type":"integer","description":"Quantidade de Parcelas"},"cCodParc":{"type":"string","description":"Código da parcela/Condição de pagamento. Utilize a tag \"nCodigo\" do método \"ListarFormasPagVendas\" da API http://app.omie.com.br/api/v1/produtos/formaspagvendas/ para obter essa informação. O código \"999\" é o único que permite uma definição de forma de pagamento customizada. Caso você escolha essa opção, deve também informar a tag \"qtde_parcelas\" e a estrutura \"lista_parcelas\". Alguns dos valores disponíveis são: \"000\" - A Vista \"A03\" - Para 3 dias \"A05\" - Para 5 dias \"A07\" - Para 7 dias \"A08\" - Para 8 dias \"A09\" - Para 9 dias \"A10\" - Para 10 dias \"A13\" - Para 13 dias \"A14\" - Para 14 dias \"A15\" - Para 15 dias \"A17\" - Para 17 dias \"A20\" - Para 20 dias \"A21\" - Para 21 dias \"A25\" - Para 25 dias \"A26\" - Para 26 dias \"A28\" - Para 28 dias \"A35\" - Para 35 dias \"A36\" - Para 36 dias \"A40\" - Para 40 dias \"A42\" - Para 42 dias \"A45\" - Para 45 dias \"A50\" - Para 50 dias \"A56\" - Para 56 dias \"A60\" - Para 60 dias \"A70\" - Para 70 dias \"A75\" - Para 75 dias \"A90\" - Para 90 dias \"A98\" - Para 98 dias \"B20\" - Para 120 dias \"001\" - 1 Parcela (para 30 dias) \"002\" - 2 Parcelas \"003\" - 3 Parcelas \"004\" - 4 Parcelas \"005\" - 5 Parcelas \"006\" - 6 Parcelas \"007\" - 7 Parcelas \"010\" - 10 Parcelas \"012\" - 12 Parcelas \"024\" - 24 Parcelas \"036\" - 36 Parcelas \"048\" - 48 Parcelas \"S01\" - 30/60 \"S02\" - 45/60 \"S03\" - 21/28/35 \"S04\" - 21/28/35/42 \"S05\" - 28/35/42 \"S06\" - 28/35/42/49 \"S07\" - 30/45/60/75/90 \"S08\" - 25/56 \"S09\" - 30/45 \"S10\" - 28/56 \"S11\" - 10/30/60 \"S12\" - 15/30/60 \"S13\" - 28/35 \"S14\" - 7/14/21 \"S15\" - 10/30/60/90 \"S16\" - 60/90/120 \"S17\" - 45/60/90 \"S18\" - 30/60/90 \"S19\" - 14/21 \"S20\" - 7/14 \"S21\" - 14/21/28 \"S22\" - 45/75 \"S23\" - 30/45/60 \"S24\" - 3/20/40 \"S25\" - 30/60/90/120 \"S26\" - 21/28 \"S27\" - a Vista/15 \"S28\" - a Vista/30 \"S29\" - a Vista/30/60 \"S30\" - a Vista/30/60/90 \"S31\" - a Vista/30/60/90/120/150 \"S41\" - 28/42/56 \"S32\" - 15/45/75 \"S33\" - 14/28/42 \"S34\" - 14/21/28/35/42 \"S35\" - 30/42/54/66/78/90 \"S36\" - 14/21/28/35 \"S37\" - 28/42 \"S38\" - 30/45/60 \"S39\" - 35/42/49/56 \"S40\" - 28/42/56/70 \"S42\" - 30/40/50/60 \"S43\" - 30/50/70/90 \"S44\" - 14/28 \"S45\" - 45/60/75/90 \"S46\" - a Vista/30/60/90/120 \"S47\" - a vista/20/40/60 \"S48\" - 21/42 \"S49\" - 15/30/45 \"S50\" - 14/42 \"S51\" - 21/35 \"S52\" - 28/56/84 \"S53\" - 28/42/56/70/84 \"S54\" - a Vista/30/45 \"S55\" - 21/45 \"S56\" - a Vista/28 \"S57\" - a Vista/60/90 \"S58\" - 35/45/55 \"S59\" - 28/35/42/56 \"S60\" - 30/45/60/75 \"S61\" - 28/35/42/49/56 \"S62\" - 40/70/100 \"S63\" - 42/56 \"S64\" - a Vista/28/35 \"S65\" - 35/42 \"S66\" - 20/40 \"S67\" - a Vista/28/35/42"},"cDescParc":{"type":"string","description":"Descrição da parcela. Utilizado apenas para retorno do método \"ConsultarOS\"."},"nValorTotal":{"type":"decimal","description":"Valor total da Ordem de Serviço. Não deve ser informado na inclusão ou alteração. Campo calculado automaticamente."},"nValorTotalImpRet":{"type":"decimal","description":"Valor Total de Impostos Retidos"},"nCodCtr":{"type":"integer","description":"Código do Contrato. Ao informar esse campo será incluído ao contrato uma Ordem de Serviço adicional. Utilizado somente na Inclusão/Alteração. Utilize a tag \"nCodCtr\" do método \"ListarContrato\" da API /api/v1/servicos/contrato/ para obter essa informação"}},"description":"Cabeçalho da Ordem de Serviço"},"InformacoesAdicionais":{"type":"object","properties":{"cCodCateg":{"type":"string","description":"Categoria"},"nCodCC":{"type":"integer","description":"Código da Conta Corrente"},"cNumPedido":{"type":"string","description":"Número do Pedido do Cliente"},"cNumContrato":{"type":"string","description":"Número do Contrato de Venda"},"cContato":{"type":"string","description":"Contato"},"cDadosAdicNF":{"type":"string","description":"Dados Adicionais da Nota Fiscal"},"cCodObra":{"type":"string","description":"Código da Obra"},"cCodART":{"type":"string","description":"Código ART"},"nCodProj":{"type":"integer","description":"Código do Projeto"},"cCidPrestServ":{"type":"string","description":"Cidade da Prestação do Serviço"},"dDataRps":{"type":"string","description":"Data da RPS"},"cNumRecibo":{"type":"string","description":"Número do Recibo gerado. (Gerado automaticamente. Se informado na inclusão será ignorado)."},"cUsoConsumo":{"type":"string","description":"Uso e consumo pessoal."},"nIdDestinatario":{"type":"integer","description":"ID Cliente para o Destinatário."},"DetalhesNfse":{"type":"object","properties":{"Eventos":{"type":"object","properties":{"cCidadeEvento":{"type":"string","description":"Código da Cidade da Prestação de Serviços."},"cCodPaisEvento":{"type":"string","description":"Código do país do evento."},"cEndExtEvento":{"type":"string","description":"Endereço no Exterior do evento. A tag [cExtEvento] precisa ser preenchida como \"S\"."},"cBairroEvento":{"type":"string","description":"Bairro do Evento."},"cCepEvento":{"type":"string","description":"CEP do Evento."},"cEndEvento":{"type":"string","description":"Endereço do envento."},"cNumEndEvento":{"type":"string","description":"Número do endereço do evento."},"cUfEvento":{"type":"string","description":"Estado do evento."},"dDtIniEvento":{"type":"string","description":"Data de Início do Evento."},"dDtFimEvento":{"type":"string","description":"Data Final do Evento."},"cNomeEvento":{"type":"string","description":"Nome do evento."},"cComplEvento":{"type":"string","description":"Completo do endereço do evento."},"cCodAtivEvento":{"type":"string","description":"Código de Atividade do evento."},"cExtEvento":{"type":"string","description":"Evento no Exterior S/N."},"cCidadeExtEvento":{"type":"string","description":"Cidade do evento no exterior. A tag [cExtEvento] precisa ser preenchida como \"S\"."}},"description":"Evento na Nfse."}},"description":"Detalhes da NFSE."}}},"Email":{"type":"object","properties":{"cEnvRecibo":{"type":"string","description":"Enviar um recibo de prestação de serviços (ao invés da NFS-e)"},"cEnvLink":{"type":"string","description":"Enviar ao Cliente e-mail com o link do site da prefeitura para consultar a NFSe emitida."},"cEnvBoleto":{"type":"string","description":"Enviar ao cliente e-mail com os Boletos de Cobrança gerados pelo faturamento. É permitido somente o preenchimento de uma das tags \"cEnvPix\" ou \"cEnvBoleto\"."},"cEnvPix":{"type":"string","description":"Enviar ao cliente e-mail com o PIX de Cobrança gerado pelo faturamento. É permitido somente o preenchimento de uma das tags \"cEnvPix\" ou \"cEnvBoleto\"."},"cEnviarPara":{"type":"string","description":"Utilizar os seguintes endereços de e-mail"},"cEnvViaUnica":{"type":"string","description":"Enviar ao cliente Via Única (Notas Fiscais Modelos 21 e 22). Pode ser: S - Sim N - Não"}}},"Departamentos":{"type":"array","items":{"type":"object","properties":{"cCodDepto":{"type":"string","description":"ID do Departamento. Informação localizada na Aba \"Departamentos\" do Pedido de Venda. Utilize a tag \"codigo\" do método \"ListarDepatartamentos\" da API http://app.omie.com.br/api/v1/geral/departamentos/ para obter essa informação."},"nPerc":{"type":"decimal","description":"Percentual de Rateio. Informação localizada na Aba \"Departamentos\" do Pedido de Venda."},"nValor":{"type":"decimal","description":"Valor do Rateio. Informação localizada na Aba \"Departamentos\" do Pedido de Venda."},"nValorFixo":{"type":"string","description":"Indica que o valor foi fixado na distribuição do rateio. Informar \"S\" ou \"N\". Informação localizada na Aba \"Departamentos\" do Pedido de Venda."}}},"description":"Dados da Aba \"Departamentos\" do Pedido de Venda."},"ServicosPrestados":{"type":"array","items":{"type":"object","properties":{"nCodServico":{"type":"integer","description":"Código Interno do Serviço conforme cadastrado na tabela de serviços. Caso preenchido, irá assumir as informações do cadastro de serviço. Se não for preenchido, assumirá os valores informados na API."},"cCodIntServico":{"type":"string","description":"Código de Integração do Serviço conforme cadastrado na tabela de serviços. Caso preenchido, irá assumir as informações do cadastro de serviço. Se não for preenchido, assumirá os valores informados na API."},"cTribServ":{"type":"string","description":"Tipo de Tributação dos Serviços. Caso tenha informado a tag \"nCodServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. Valores pode variar de acordo com o município. Verifique a legislação da sua cidade para obter os tipos de tributação disponíveis."},"cCodServMun":{"type":"string","description":"Código do Serviço Municipal ou CNAE. Caso tenha informado a tag \"nCodServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. Valores pode variar de acordo com o município. Verifique a legislação da sua cidade para obter os códigos de serviço disponíveis."},"cCodServLC116":{"type":"string","description":"Código do Serviço conforme Lei Complementar (LC 116). Caso tenha informado a tag \"nCodServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço. Tabela única para todos os municípios."},"nQtde":{"type":"decimal","description":"Quantidade de serviços."},"nValUnit":{"type":"decimal","description":"Valor Unitário do serviço. Caso tenha informado a tag \"nCodServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço."},"cTpDesconto":{"type":"string","description":"Tipo de Desconto. Pode ser: P - Percentual V - Valor"},"nValorDesconto":{"type":"decimal","description":"Valor do Desconto."},"nAliqDesconto":{"type":"decimal","description":"Aliquota do Desconto."},"nValorOutrasRetencoes":{"type":"decimal","description":"Valor de Outras Retenções. (Disponível apenas para cidades que oferecem esse recurso.)"},"nValorAcrescimos":{"type":"decimal","description":"Valor de Acréscimos e taxas. (Disponível apenas para cidades que oferecem esse recurso.)"},"cDescServ":{"type":"string","description":"Descrição dos Serviços. Caso tenha informado a tag \"nCodServico\" o preenchimento passa a ser opcional e irá assumir o valor informado no cadastro do respectivo serviço."},"cRetemISS":{"type":"string","description":"Retem ISS (S/N)"},"cDadosAdicItem":{"type":"string","description":"Dados adicionais do Item."},"cNbs":{"type":"string","description":"Código da Nomenclatura Brasileira de Serviços (NBS). Caso tenha informado a tag \"nCodServico\" irá assumir o valor informado no cadastro do respectivo serviço."},"impostos":{"type":"object","properties":{"cFixarISS":{"type":"string","description":"Indica se o imposto foi alterado pelo usuário ou informado via importação de planilha ou API. Esse campo é preenchido automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"nAliqISS":{"type":"decimal","description":"Alíquota de ISS."},"nBaseISS":{"type":"decimal","description":"Base de Cálculo do ISS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"nTotDeducao":{"type":"decimal","description":"Valor de Dedução da Base de Cálculo. Por padrão, esse campo afeta a Base de Cálculo do ISS. Para atender a condições legais acordadas para cada munícipio pode afetar as Bases de Cálculos dos Impostos Federais também. Consulte a legislação do seu município."},"nValorDeducao":{"type":"decimal","description":"Valor das deduções do item. Utilizado apenas nos métodos de Consulta/Listagem."},"nValorISS":{"type":"decimal","description":"Valor do ISS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"cUtilizaValorImposto":{"type":"string","description":"Indica se o valor informado para os Impostos Federais deverá ser mantido ao invés de ser recalculado a partir da alíquota. Assim: Caso seja informado \"N\", indica que valor do imposto deve ser calculado a partir da alíquota e base de cálculo. Caso seja informado \"S\", indica que o valor do imposto será mantido e a alíquota será recalculada a partir do valor do imposto e base de cálculo."},"cFixarIRRF":{"type":"string","description":"Indica se o imposto foi alterado pelo usuário ou informado via importação de planilha ou API. Esse campo é preenchido automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"nAliqIRRF":{"type":"decimal","description":"Alíquota de IRRF. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"nValorIRRF":{"type":"decimal","description":"Valor do IRRF. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\". Caso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"nValorDeducaoIRRF":{"type":"decimal","description":"Valor da dedução da base do IR."},"cRetemIRRF":{"type":"string","description":"Retém IRRF (S/N). Indica se o imposto deve ser retido ou não."},"cFixarPIS":{"type":"string","description":"Indica se o imposto foi alterado pelo usuário ou informado via importação de planilha ou API. Esse campo é preenchido automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"nAliqPIS":{"type":"decimal","description":"Alíquota de PIS. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"nValorPIS":{"type":"decimal","description":"Valor do PIS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\". Caso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"cRetemPIS":{"type":"string","description":"Retém PIS (S/N). Indica se o imposto deve ser retido ou não."},"cFixarCOFINS":{"type":"string","description":"Indica se o imposto foi alterado pelo usuário ou informado via importação de planilha ou API. Esse campo é preenchido automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"nAliqCOFINS":{"type":"decimal","description":"Alíquota de COFINS. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"nValorCOFINS":{"type":"decimal","description":"Valor do COFINS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\". Caso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"cRetemCOFINS":{"type":"string","description":"Retém COFINS (S/N). Indica se o imposto deve ser retido ou não."},"cFixarCSLL":{"type":"string","description":"Indica se o imposto foi alterado pelo usuário ou informado via importação de planilha ou API. Esse campo é preenchido automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"nAliqCSLL":{"type":"decimal","description":"Alíquota de CSLL. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"nValorCSLL":{"type":"decimal","description":"Valor de CSLL. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\". Caso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"cRetemCSLL":{"type":"string","description":"Retém CSLL (S/N). Indica se o imposto deve ser retido ou não."},"cFixarINSS":{"type":"string","description":"Indica se o imposto foi alterado pelo usuário ou informado via importação de planilha ou API. Esse campo é preenchido automaticamente pelo Omie e não deve ser informado na inclusão/alteração."},"nAliqINSS":{"type":"decimal","description":"Alíquota de INSS. Para o cálculo do imposto o preenchimento é obrigatório caso a tag [cUtilizaValorImposto] seja diferente de \"S\". Lembre-se também de indicar se o imposto deve ser retido ou não na tag correspondente."},"nValorINSS":{"type":"decimal","description":"Valor de INSS. Esse campo é calculado automaticamente pelo Omie e não deve ser informado na inclusão/alteração caso a tag [cUtilizarValorImposto] seja diferente de \"S\". Caso a tag [cUtilizarValorImposto] seja preenchida com \"S\", indicará que o valor informado deve ser preservado e que a respectiva alíquota deve ser calculada ao invés do valor do imposto. Nesse caso, o alíquota informada na tag correspondente será desprezada."},"cRetemINSS":{"type":"string","description":"Retém INSS (S/N). Indica se o imposto deve ser retido ou não."},"nAliqRedBaseINSS":{"type":"decimal","description":"Percentual de Redução da Base de Cálculo do INSS."},"nAliqRedBaseCOFINS":{"type":"decimal","description":"Percentual de Redução da Base de Cálculo do COFINS."},"nAliqRedBasePIS":{"type":"decimal","description":"Percentual de Redução da Base de Cálculo do PIS."},"lDeduzISS":{"type":"boolean","description":"Deduz o ISS da Base de Cálculo de PIS e COFINS"},"cCST":{"type":"string","description":"Código da Situação Tributária IBS/CBS. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"cClassTrib":{"type":"string","description":"Código de Classificação Tributária. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"nAliqIbsUf":{"type":"decimal","description":"Alíquota do IBS estadual. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"nAliqIbsMun":{"type":"decimal","description":"Alíquota do IBS Municipal. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"nPercReducaoIbsUf":{"type":"decimal","description":"Percentual redução IBS estadual. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"nPercReducaoIbsMun":{"type":"decimal","description":"Percentual redução IBS municipal. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"nAliqCbs":{"type":"decimal","description":"Alíquota da CBS Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"nPercReducaoCbs":{"type":"decimal","description":"Percentual redução CBS. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"cIndOPer":{"type":"string","description":"Código Indicador de Operação. Caso não preenchido para um novo item nos métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço ou configuração padrão da reforma tributária no Omie."},"nValorIbsUf":{"type":"decimal","description":"Valor do IBS Estadual. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"nValorIbsMun":{"type":"decimal","description":"Valor do IBS Municipal. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"nValorCbs":{"type":"decimal","description":"Valor da CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"cManCbs":{"type":"string","description":"Indica que houve alteração manual da alíquota de CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"cManIbsMun":{"type":"string","description":"Indica que houve alteração manual da alíquota de IBS Municipal. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"cManIbsUf":{"type":"string","description":"Indica que houve alteração manual da alíquota de IBS Estadual. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"nBaseCalcIbsCbs":{"type":"decimal","description":"Valor da Base de Calculo do IBS e CBS. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta. Para os métodos de inclusão e alteração, esse campo será preenchido conforme o cadastro do serviço no Omie."},"nAliqFederalIBPT":{"type":"decimal","description":"Alíquota da Carga Tribut. Aproximada Federal."},"nAliqEstadualIBPT":{"type":"decimal","description":"Alíquota da Carga Tribut. Aproximada Estadual."},"nAliqMunicipalIBPT":{"type":"decimal","description":"Alíquota da Carga Tribut. Aproximada Municipal."}},"description":"Dados do impostos do serviço."},"DeducoesIss":{"type":"array","items":{"type":"object","properties":{"cFormaDeducao":{"type":"string","description":"Tipo de dedução. Informe 'P' para Percentual ou 'V' para Valor."},"nPercDeducao":{"type":"decimal","description":"Percentual de dedução."},"nValorDeducao":{"type":"decimal","description":"Valor da Dedução."},"cTipoDeduducao":{"type":"string","description":"Tipo da Dedução. Informe '1' para Materiais ou 2 para Sub-Empreitada"},"cNFReferencia":{"type":"string","description":"Nota Fiscal de Referência."},"cCnpjFornecedor":{"type":"string","description":"CPF ou CNPJ do Fornecedor"},"nValorTotNfRef":{"type":"decimal","description":"Valor total NF de Referência"},"nQuantMateriais":{"type":"decimal","description":"Quantidade de Material"},"cDescMateriais":{"type":"string","description":"Descrição do material."}}},"description":"Informe aqui as Deduções para o ISS."},"cNaoGerarFinanceiro":{"type":"string","description":"Não gerar conta a receber para este item. Informar \"S\" para não gerar movimento financeiro. Informar \"N\" para gerar movimento financeiro."},"cCodCategItem":{"type":"string","description":"Código da Categoria."},"nSeqItem":{"type":"integer","description":"Sequencia do Item Deve ser preenchido com uma sequencia de 1 a 199."},"nIdItem":{"type":"integer","description":"ID do Item da Ordem de Serviço. Não deve ser informado na inclusão. Pode ser informado na alteração para identificar o item."},"cAcaoItem":{"type":"string","description":"Ação a ser realizada na alteração do item. Pode ser: \"A\" - Alterar o item (padrão). \"E\" - Excluir o item. \"I\" - Incluir o item na alteração."},"viaUnica":{"type":"object","properties":{"cModeloNF":{"type":"string","description":"Indica qual modelo de NF será emitida para o serviço. Obrigatório quando a tag cEnvViaUnica for igual a \"S\". Pode ser: 21 - Nota Fiscal de Serviço de Comunicação 22 - Nota Fiscal de Serviço de Telecomunicação"},"cCFOP":{"type":"string","description":"Código CFOP para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a \"S\". Utilize a tag \"nCodigo\" do método \"ListarCFOP\" da API /api/v1/produtos/cfop/ para obter essa informação."},"cClassifServico":{"type":"string","description":"Código da Classificação para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a \"S\". Utilize a tag \"cCodigo\" do método \"ListarClassificacaoServico\" da API /api/v1/servicos/classificacaoservico/ para obter essa informação."},"cTipoReceita":{"type":"string","description":"Indicador do Tipo de Receita para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a \"S\". Pode ser: 0 - Receita própria - serviços prestados 1 - Receita própria - cobrança de débitos 2 - Receita própria - venda de mercadorias 3 - Receita própria - venda de serviço pré-pago 4 - Outras receitas próprias 5 - Receitas de terceiros (co-faturamento) 9 - Outras receitas de terceiros"},"cTipoUtilizacao":{"type":"string","description":"Código do tipo de utilização para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cEnvViaUnica for igual a \"S\". Utilize a tag \"cCodigo\" do método \"ListarTipoUtilizacao\" da API /api/v1/servicos/tipoutilizacao/ para obter essa informação."}},"description":"Informações referente ao serviço de NF modelo 21 ou 22."},"cReembolso":{"type":"string","description":"Identificação se o item é despesa reembolsável."},"cCodigo":{"type":"string","description":"Código do serviço. Não deve ser informado na Inclusão/Alteração. Campo disponível apenas para consulta."}}},"description":"Item da Ordem serviço"},"Parcelas":{"type":"array","items":{"type":"object","properties":{"nParcela":{"type":"integer","description":"Número da Parcela. Ex.: 1 para indicar a parcela 1, 2 para indicar a parcela 2."},"dDtVenc":{"type":"string","description":"Data de Vencimento da parcela. Ex: 01/02/2016"},"nValor":{"type":"decimal","description":"Valor da Parcela. Ex: 100.23"},"nPercentual":{"type":"decimal","description":"Percentual do valor da parcela."},"nDias":{"type":"integer","description":"Número de dias até o vencimento. O preenchimento deste campo não é obrigatório. Ex: 28 para vencimento para 28 dias."},"tipo_documento":{"type":"string","description":"Tipo de Documento. Informação localizada na Aba \"Parcelas\" da Ordem de Serviço. Pode ser: 13S 13o. Salário 99999 Outros ACO Acordo ACOB Acordo - Boleto ACOT Acordo - Transferência ADI Adiantamento ANT Antecipação APL Aplicação APO Apólice APOR Aporte ASS Assinatura BIL Bilhete BOL Boleto BOLV Boleto à Vista BONUS Bonus CAP Capitalização CART Carteira CF Cupom Fiscal CHD Cheque Devolvido CHP Cheque Pré CHQ Cheque CHT Cheque de Terceiros CNT Crédito em Conta COB Cobrança COM Comissão CON Convênios CONC Cobrança de Concessionária COND Condicional CONS Consignado CONSO Consórcio CRC Cartão de Crédito CRD Cartão de Débito CRE Crediário CRP Cartão Pré-Pago CRT Cartão CRTO Cartório CTE CT-e CTR Contrato CUSJ Custos Judiciais DACTE DACTE DAE DAE DAJE DAJE DAM DAM DANFE DANFE DAR DAR DARE DARE DARJ DARJ DARM DARM DAS DAS DDA DDA DEB Débito em Conta DEBA Débito Automático DEP Depósito DEV Devolução DFE Documento Fiscal Equivalente DIN Dinheiro DLC Distribuição de Lucros DNF Documento não fiscal DNFSE DANFSE DOA Doação DOC DOC DPVAT DPVAT DRF DARF DUA DUA DUAM DUAM DUP Duplicata EMP Empréstimo ENC Encargos ETAR Estorno de Tarifa FAT Fatura FER Férias FIA Fiado FIN Financiamento FPGT Folha de Pagamento GAR Garantia GARE GARE GNRE GNRE GPS GPS GRCS GRCS GRCSU GRCSU GRF Guia de Recolhimento do FGTS GRU GRU GUIA Guia de Recolhimento HOL Holerite IMP Imposto INV Invoice IPTU IPTU IPVA IPVA JUROS Juros Limite MED Medição MULTA Multas MUTUO Mútuo NC Nota de Crédito ND Nota de Débito NF Nota Fiscal NF3E Nota Fiscal de Energia Elétrica Eletrônica NFA Nota Fiscal de Abastecimento NFC Nota Fiscal de Consumidor NFCE Nota Fiscal de Consumidor Eletrônica NFD Nota Fiscal de Devolução NFE Nota Fiscal Eletrônica NFEE Nota Fiscal Energia Elétrica NFS Nota Fiscal de Serviço NFST Nota Fiscal de Telecomunicações NFSTM Nota Fiscal de Serviço Tomado PDD PDD PED Pedido PEN Pensão Alimentícia PER Permuta PIX Pix PROF Proforma Invoice PROL Pro-Labore PROT Protesto PROV Provisão REC Recibo REE Reembolso REND Rendimentos RES Resgate RET Rescisão Trabalhista RPA RPA SAN Sangria SAQ Saque SUP Suprimento TAR Tarifa TED TED TFE Taxa de Fiscalização de Estabelecimentos TIC Ticket TID Título Descontado TRA Transferência TRAV Transferência à Vista TRLAV Licenciamento TX Taxa VIST A Vista VOU Voucher WSITE Website Listagem completa disponível na API: /api/v1/ger"},"meio_pagamento":{"type":"string","description":"Meio de Pagamento - Utilizado apenas para emissão de NFS-e (campo \"tPag\" do XML). Esse campo indica como a parcela da nota será paga. Informação localizada na Aba \"Parcelas\" da Ordem de Serviço. Caso informado na estrutura \"informacoes_adicionais\" grava o valor como padrão para todas as parcelas geradas na integração que não tiverem esse campo preenchido a partir da estrutura \"parcela\". Pode ser: 01 Dinheiro 02 Cheque 03 Cartão de Crédito 04 Cartão de Débito 05 Crédito Loja 10 Vale Alimentação 11 Vale Refeição 12 Vale Presente 13 Vale Combustível 15 Boleto Bancário 16 Depósito Bancário 17 Pagamento Instantâneo (PIX) 18 Transferência bancária, Carteira Digital 19 Programa de fidelidade, Cashback, Crédito Virtual. 90 Sem Pagamento 99 Outros Listagem completa disponível na API: /api/v1/geral/meiospagamento/"},"nsu":{"type":"string","description":"Número Sequencial Único NSU - Para identificar vendas por cartões ou TransactionID TID - Para identificar vendas de comercio eletrônico."},"nao_gerar_boleto":{"type":"string","description":"Não gerar boleto para esta parcela ao emitir a nota fiscal. Informe \"S\" para não gerar o boleto. O padrão é \"N\". Informação localizada na Aba \"Parcelas\" da Ordem de Serviço."},"parcela_adiantamento":{"type":"string","description":"Está é uma parcela de Adiantamento do Cliente. Informe \"S\" para indicar que é uma parcela de adiantamento. O padrão é \"N\". Informação localizada na Aba \"Parcelas\" da Ordem de Serviço."},"categoria_adiantamento":{"type":"string","description":"Código da Categoria para o Adiantamento. Será utilizada na conta a receber que representa o adiantamento desta parcela. Informação localizada na Aba \"Parcelas\" da Ordem de Serviço."},"conta_corrente_adiantamento":{"type":"integer","description":"Conta Corrente de Adiantamento. Informação localizada na Aba \"Parcelas\" da Ordem de Serviço."}}},"description":"Permite que o parcelamento seja realizado de forma manual."},"Observacoes":{"type":"object","properties":{"cObsOS":{"type":"string","description":"Observações da Ordem de Serviço. (Essas informação não serão exibidas na Nota Fiscal)."}}},"InfoCadastro":{"type":"object","properties":{"cCancelada":{"type":"string","description":"Ordem de Serviço cancelada?"},"cFaturada":{"type":"string","description":"Ordem de Serviço faturada com sucesso?"},"cAmbiente":{"type":"string","description":"Ambiente de emissão da NFS-e. Pode ser: H - Homologação P - Produção"},"dDtInc":{"type":"string","description":"Data de Inclusão da Ordem de Serviço"},"cHrInc":{"type":"string","description":"Hora de inclusão da Ordem de Serviço"},"uInc":{"type":"string","description":"Usuário da Inclusão. Não deve ser informado na Inclusão/Alteração."},"dDtAlt":{"type":"string","description":"Data de Alteração da Ordem de Serviço"},"cHrAlt":{"type":"string","description":"Hora de Alteração da Ordem de Serviço"},"uAlt":{"type":"string","description":"Usuário da Alteração. Não deve ser informado na Inclusão/Alteração."},"dDtFat":{"type":"string","description":"Data de Faturamento"},"cHrFat":{"type":"string","description":"Hora do Faturamento"},"dDtCanc":{"type":"string","description":"Data de Cancelamento"},"cHrCanc":{"type":"string","description":"Hora do Cancelamento"},"cOrigem":{"type":"string","description":"Origem da Ordem de Serviço"}},"description":"Informações do cadastro da Ordem de Serviço."},"despesasReembolsaveis":{"type":"object","properties":{"cCodCategReemb":{"type":"string","description":"Código da categoria para reembolso"},"despesaReembolsavel":{"type":"array","items":{"type":"object","properties":{"nCodReemb":{"type":"integer","description":"ID do Reembolso. (Código interno utilizado apenas na API, utilizado somente na Alteração e Exclusão). Esse código não aparece na tela do Omie. Utilize esse código para identificar a despesa via API."},"cAcaoReemb":{"type":"string","description":"Pode ser: \"A\" - Alterar a despesa. \"E\" - Excluir a despesa. \"I\" - Incluir a despesa na alteração."},"cDescReemb":{"type":"string","description":"Descrição da despesa."},"nValorReemb":{"type":"decimal","description":"Valor da despesa."},"dDataReemb":{"type":"string","description":"Data da despesa."}}},"description":"Despesa reembolsável"}},"description":"Despesas reembolsáveis."},"produtosUtilizados":{"type":"object","properties":{"cAcaoProdUtilizados":{"type":"string","description":"Pode ser: REM - Será gerado uma remessa dos produtos para o cliente. EST - Será gerado uma saída de estoque. Obrigatório na inclusão."},"cCodCategRem":{"type":"string","description":"Código da Categoria da Remessa ou Pedido de Venda. Obrigatório quando usar cAcaoFaturamento como 'REM' ou 'PED'"},"produtoUtilizado":{"type":"array","items":{"type":"object","properties":{"nIdItemPU":{"type":"integer","description":"(Código interno utilizado apenas na API). Não informar na inclusão. Esse código não aparece na tela do Omie."},"cAcaoItemPU":{"type":"string","description":"Pode ser: \"A\" - Alterar o item. \"E\" - Excluir o item. \"I\" - Incluir o item na alteração."},"nCodProdutoPU":{"type":"integer","description":"Código interno do produto. (utilizado apenas na API). Esse código não aparece na tela do Omie."},"nQtdePU":{"type":"decimal","description":"Quantidade."},"codigo_local_estoque":{"type":"integer","description":"Código do Local do Estoque."},"lote_validade":{"type":"array","items":{"type":"object","properties":{"nIdLote":{"type":"integer","description":"Id do Lote do produto. Obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações.."},"nQtdLote":{"type":"decimal","description":"Informe aqui a quantidade do Lote para o produto. É obrigatório quando o produto possui controle de lote e o método do consumo do lote está definido como 'Manual' nas configurações."}}},"description":"Informações referentes ao lote e validade do produto. A tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes \"manualmente\" por API."}}},"description":"rodutos utilizados no serviço."}},"description":"Produtos Utilizados na Ordem de Serviço."},"Tarefas":{"type":"array","items":{"type":"object","properties":{"nCodTarefa":{"type":"integer","description":"Código único da tarefa."},"cCodIntTarefa":{"type":"string"},"cDescricao":{"type":"string","description":"Descrição da tarefa."},"dData":{"type":"string"},"hHora":{"type":"string"},"nCodDoc":{"type":"integer","description":"Id do documento vinculado a tarefa. Esse campo varia conforme a origem da tarefa. Ele permite vincular a tarefa a um documento específico, seja ele relacionado a uma oportunidade, contas a pagar, contas a receber, entre outros. Exemplo: Se a origem da tarefa for \"pedido-compra\", esse campo reflete o código do pedido de compra. Se a origem da tarefa for \"contas-receber\", esse campo reflete o código da conta a receber."},"nCodUserAtb":{"type":"integer","description":"Código do usuário atribuído."},"cNomeUserAtb":{"type":"string"}}},"description":"Lista com as tarefas relacionadas a ordem de serviço. Retornado apenas no método de consulta e quando preenchida a tag \"cIncluirTarefas\" como \"S\"."},"Caracteristicas":{"type":"array","items":{"type":"object","properties":{"cConteudo":{"type":"string","description":"Conteúdo da Característica."},"cNome":{"type":"string","description":"Nome da característica."},"nIdCampo":{"type":"integer","description":"Id do campo característica."},"nIdCaracteristica":{"type":"integer","description":"ID da Característica."}}},"description":"Características da Ordem de Serviço."}}}}},"title":"ListarOS (retorno)"},"servicos_os_StatusOS":{"type":"object","title":"StatusOS","description":"Retorna o Status da Ordem de Serviço","required":["call","param"],"properties":{"call":{"type":"string","enum":["StatusOS"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cCodIntOS":{"type":"string","maxLength":60,"description":"Código de Integração da Ordem de Serviço"},"nCodOS":{"type":"integer","maxLength":15,"description":"ID da Ordem de Serviço\n(Código interno)"},"lPdfDemo":{"type":"boolean","description":"Exibir a Url do PDF do Demonstrativo da NFS-e.\n\nPode ser:\ntrue\nfalse\n\nO padrão é false."},"lPdfDest":{"type":"boolean","description":"Exibir a Url do PDF do Destinatário da NFS-e.\n\nPode ser:\ntrue\nfalse\n\nO padrão é false."},"lRps":{"type":"boolean","description":"Exibir a Url da RPS.\n\nPode ser:\ntrue\nfalse\n\nO padrão é false."},"lPdfRecibo":{"type":"boolean","description":"Exibir a Url do Recibo.\n\nPode ser:\ntrue\nfalse\n\nO padrão é false."},"lMsg":{"type":"boolean","description":"Retornar todas mensagens de comunicação com a prefeitura (S/N).\n\nQuando preenchido com \"N\" ou não preenchido, vamos devolver apenas as mensagens com erro.\nQuando preenchido com \"S\", vamos devolver todas as mensagens de comunicação com a prefeitura.\n\nO padrão é \"N\"."}}}}},"example":{"call":"StatusOS","param":[{"cCodIntOS":"","nCodOS":0}]}},"servicos_os_StatusOS_retorno":{"type":"object","properties":{"cCodIntOS":{"type":"string","description":"Código de Integração da Ordem de Serviço (para OS geradas via API, a partir de outros aplicativos)"},"nCodOS":{"type":"integer","description":"ID da Ordem de Serviço (código interno de controle)."},"cNumOS":{"type":"string","description":"Número da Ordem de Serviço (Conforme visualizada em tela pelo cliente)"},"cNumContrato":{"type":"string","description":"Número do Contrato"},"cNumRecibo":{"type":"string","description":"Número do Recibo gerado."},"cNumPedido":{"type":"string","description":"Número do pedido do cliente."},"cEtapa":{"type":"string","description":"Etapa da Ordem de Serviço"},"cCancelada":{"type":"string","description":"Ordem de Serviço cancelada?"},"cFaturada":{"type":"string","description":"Ordem de Serviço faturada com sucesso?"},"cAmbiente":{"type":"string","description":"Ambiente de emissão da NFS-e. Pode ser: H - Homologação P - Produção"},"dDtInc":{"type":"string","description":"Data de Inclusão da Ordem de Serviço"},"cHrInc":{"type":"string","description":"Hora de inclusão da Ordem de Serviço"},"dDtAlt":{"type":"string","description":"Data de Alteração da Ordem de Serviço"},"cHrAlt":{"type":"string","description":"Hora de Alteração da Ordem de Serviço"},"dDtFat":{"type":"string","description":"Data de Faturamento"},"cHrFat":{"type":"string","description":"Hora do Faturamento"},"dDtCanc":{"type":"string","description":"Data de Cancelamento"},"cHrCanc":{"type":"string","description":"Hora do Cancelamento"},"nValorTot":{"type":"decimal","description":"Valor da Ordem de Serviço"},"cUrlPdfRecibo":{"type":"string","description":"Link para obter o PDF do Recibo."},"ListaRpsNfse":{"type":"array","items":{"type":"object","properties":{"nLote":{"type":"integer","description":"Número do Lote de Envio da RPS"},"cStatusLote":{"type":"string","description":"Código do status do lote enviado para a prefeitura. Pode ser: 001 - Aguardando envio para a prefeitura. 002 - Enviado para a prefeitura, aguardando processamento. 003 - Processado com erro. 004 - Processado com sucesso. 005 - Cancelado com sucesso."},"cProtocolo":{"type":"string","description":"Número do protocolo do envio do lote."},"nRps":{"type":"string","description":"Número do Recibo Provisório de Serviços (RPS)."},"cStatusRps":{"type":"string","description":"Código do status da RPS. Pode ser: 001 - Aguardando envio para a prefeitura. 002 - Enviado para a prefeitura, aguardando processamento. 003 - Processado com erro. 004 - Processado com sucesso. 005 - Cancelado com sucesso."},"nNfse":{"type":"string","description":"Número da NFS-e gerada."},"cCodVerif":{"type":"string","description":"Código de Verificação da NFS-e gerada."},"cCNPJ":{"type":"string","description":"CNPJ do Prestador"},"cInscrMunicipal":{"type":"integer","description":"Inscrição Municipal do Prestador"},"mensagens":{"type":"array","items":{"type":"object","properties":{"cCodigo":{"type":"string","description":"Código da mensagem de Erro/Aviso"},"cDescricao":{"type":"string","description":"Descrição da mensagem de erro/aviso."},"cCorrecao":{"type":"string","description":"Correção da descrição de mensagem de erro/aviso."},"cSituacao":{"type":"string","description":"Situação da mensagem. Pode ser: ERRO ALERTA SUCESSO Esse campo só é retornado quando a tag \"lMsg\" enviada na request é true."},"cAnexo":{"type":"string","description":"Indica se a mensagem tem algum anexo (S/N). Esse campo só é retornado quando a tag \"lMsg\" enviada na request é true."},"cUsuario":{"type":"string","description":"Usuário vinculado a mensagem. Esse campo só é retornado quando a tag \"lMsg\" enviada na request é true."},"dData":{"type":"string","description":"Data da mensagem. Esse campo só é retornado quando a tag \"lMsg\" enviada na request é true."},"hHora":{"type":"string","description":"Hora da mensagem. Esse campo só é retornado quando a tag \"lMsg\" enviada na request é true."}}},"description":"Mensagens de comunicação com a Prefeitura"},"xml_distr":{"type":"string","description":"XML de distribuição da NF-e"},"danfe":{"type":"string","description":"Link para o DANFE da NF-e gerada."},"cUrlNfse":{"type":"string","description":"Link para obter a NFS-e na prefeitura."},"cUrlPdfDemo":{"type":"string","description":"Link para obter o PDF do Demonstrativo da NFS-e."},"cUrlPdfDest":{"type":"string","description":"Link para obter o PDF da nota do Destinatário."},"cUrlRps":{"type":"string","description":"Link para obter a RPS."}}},"description":"Lista de RPS geradas para a Ordem de Serviço"}},"title":"StatusOS (retorno)"},"servicos_os_TrocarEtapaOS":{"type":"object","title":"TrocarEtapaOS","description":"Troca a Etapa da Ordem de Serviço.","required":["call","param"],"properties":{"call":{"type":"string","enum":["TrocarEtapaOS"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nCodOS":{"type":"integer","maxLength":15,"description":"ID da Ordem de Serviço.\n\nEsse campo não é exibido na tela da Ordem de Serviço.\nÉ uma informação interna, utilizada apenas nas APIs."},"cCodIntOS":{"type":"string","maxLength":60,"description":"Código de integração da Ordem de Serviço.\n\nPreencha esse campo com o código da Ordem de Serviço no aplicativo que você está integração com o Omie.\nA função dele é servir como uma mapa de relacionamento entre as aplicações.\nAo realizar uma consulta/listagem de Ordem de Serviço você conseguirá ver a relação entre o id da Ordem de Serviço gerada no Omie e o código da Ordem de Serviço existente em sua aplicação."},"cNumOS":{"type":"string","maxLength":15,"description":"Número da Ordem de Serviço.\n\nEsse é o número da Ordem de Serviço no Omie, que é gerado automaticamente e exibido na tela."},"cEtapa":{"type":"string","maxLength":2,"description":"Etapa da Ordem de Serviço.\n\nEsse campo indica em que coluna a Ordem de Serviço irá figurar no processo de faturamento do Omie.\n\nUtilize a tag \"codigo\" do método \"ListarEtapasFaturamento\" da API\nhttp://app.omie.com.br/api/v1/produtos/etapafat/\npara obter essa informação.\n\nOs valores são fixos, mas as descrições (funções atribuídas a cada coluna pode mudar. A API irá indicar a descrição de cada coluna.\n\nOs valores disponíveis para esse campo podem ser:\n\n\"10\" - Primeira coluna\n\"20\" - Segunda coluna\n\"30\" - Terceira coluna\n\"40\" - Quarta coluna\n\"50\" - Faturar"}},"required":["cEtapa"]}}},"example":{"call":"TrocarEtapaOS","param":[{"cCodIntOS":"","nCodOS":0,"cNumOS":"","cEtapa":""}]}},"servicos_os_TrocarEtapaOS_retorno":{"type":"object","properties":{"nCodOS":{"type":"integer","description":"ID da Ordem de Serviço. Esse campo não é exibido na tela da Ordem de Serviço. É uma informação interna, utilizada apenas nas APIs."},"cCodIntOS":{"type":"string","description":"Código de integração da Ordem de Serviço. Preencha esse campo com o código da Ordem de Serviço no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de Ordem de Serviço você conseguirá ver a relação entre o id da Ordem de Serviço gerada no Omie e o código da Ordem de Serviço existente em sua aplicação."},"cNumOS":{"type":"string","description":"Número da Ordem de Serviço. Esse é o número da Ordem de Serviço no Omie, que é gerado automaticamente e exibido na tela."},"codigo_status":{"type":"string","description":"Código do Status do Pedido de Venda."},"descricao_status":{"type":"string","description":"Descrição do status"}},"title":"TrocarEtapaOS (retorno)"},"servicos_osdocs_ObterDemonst":{"type":"object","title":"ObterDemonst","description":"Retorna as informações de um Demonstrativo de nota.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterDemonst"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdNf":{"type":"integer","maxLength":15,"description":"ID do documento fiscal.\n\nEssa informação pode ser obtida pela API:\n/api/v1/mobile/faturamento/\nRetornado na tag \"nIdDoc\""}},"required":["nIdNf"]}}},"example":{"call":"ObterDemonst","param":[{"nIdNf":0}]}},"servicos_osdocs_ObterDemonst_retorno":{"type":"object","properties":{"cNumOs":{"type":"string","description":"Número da Ordem de Serviço."},"cPdfDemonst":{"type":"string","description":"Link para obter o PDF do Demonstrativo."},"cLinkPortal":{"type":"string","description":"Link para acessar os documentos no portal Omie."},"cCodStatus":{"type":"string"},"cDesStatus":{"type":"string"}},"title":"ObterDemonst (retorno)"},"servicos_osdocs_ObterNFSe":{"type":"object","title":"ObterNFSe","description":"Retorna as informações do faturamento de uma NFS-e","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterNFSe"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdNf":{"type":"integer","maxLength":15,"description":"ID do documento fiscal.\n\nEssa informação pode ser obtida pela API:\n/api/v1/mobile/faturamento/\nRetornado na tag \"nIdDoc\""}},"required":["nIdNf"]}}},"example":{"call":"ObterNFSe","param":[{"nIdNf":0}]}},"servicos_osdocs_ObterNFSe_retorno":{"type":"object","properties":{"cNumOs":{"type":"string","description":"Número da Ordem de Serviço."},"cNumNFSe":{"type":"string","description":"Número da NFS-e."},"cSerieNFSe":{"type":"string","description":"Série da NFS-e."},"cLinkPortal":{"type":"string","description":"Link para acessar os documentos no portal Omie."},"cCodVerif":{"type":"string","description":"Código de Verificação da NFS-e."},"cUrlNFSe":{"type":"string","description":"Link para obter a NFS-e na prefeitura."},"cPdfNFSe":{"type":"string","description":"Link para obter o PDF da NFS-e"},"cXmlNFSe":{"type":"string","description":"XML da NFS-e."},"cCodStatus":{"type":"string"},"cDesStatus":{"type":"string"}},"title":"ObterNFSe (retorno)"},"servicos_osdocs_ObterOS":{"type":"object","title":"ObterOS","description":"Retorna as informações de uma Ordem de Serviço.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterOS"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdOs":{"type":"integer","maxLength":15}},"required":["nIdOs"]}}},"example":{"call":"ObterOS","param":[{"nIdOs":0}]}},"servicos_osdocs_ObterOS_retorno":{"type":"object","properties":{"cNumOs":{"type":"string","description":"Número da Ordem de Serviço."},"cPdfOs":{"type":"string","description":"Link para obter o PDF da Ordem de Serviço."},"cLinkPortal":{"type":"string","description":"Link para acessar os documentos no portal Omie."},"cCodStatus":{"type":"string"},"cDesStatus":{"type":"string"}},"title":"ObterOS (retorno)"},"servicos_osdocs_ObterRPS":{"type":"object","title":"ObterRPS","description":"Retorna as informações do faturamento de um RPS.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterRPS"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdNf":{"type":"integer","maxLength":15,"description":"ID do documento fiscal.\n\nEssa informação pode ser obtida pela API:\n/api/v1/mobile/faturamento/\nRetornado na tag \"nIdDoc\""}},"required":["nIdNf"]}}},"example":{"call":"ObterRPS","param":[{"nIdNf":0}]}},"servicos_osdocs_ObterRPS_retorno":{"type":"object","properties":{"cNumOs":{"type":"string","description":"Número da Ordem de Serviço."},"cNumRPS":{"type":"string","description":"Número do RPS."},"cSerieRPS":{"type":"string","description":"Série do RPS."},"cPdfRPS":{"type":"string","description":"Link para obter o PDF do RPS."},"cLinkPortal":{"type":"string","description":"Link para acessar os documentos no portal Omie."},"cCodStatus":{"type":"string"},"cDesStatus":{"type":"string"}},"title":"ObterRPS (retorno)"},"servicos_osdocs_ObterRecibo":{"type":"object","title":"ObterRecibo","description":"Retorna as informações do recibo.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterRecibo"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdRec":{"type":"integer","maxLength":15,"description":"ID do recibo.\nInforme aqui o ID do recibo.\n\nEssa informação pode ser obtida pela API:\napi/v1/servicos/os/#osStatus"}},"required":["nIdRec"]}}},"example":{"call":"ObterRecibo","param":[{"nIdRec":0}]}},"servicos_osdocs_ObterRecibo_retorno":{"type":"object","properties":{"cNumOs":{"type":"string","description":"Número da Ordem de Serviço."},"cNumRecibo":{"type":"string","description":"Número do recibo"},"cPdfRecibo":{"type":"string","description":"Link para obter o PDF do recibo"},"cLinkPortal":{"type":"string","description":"Link para acessar os documentos no portal Omie."},"cCodStatus":{"type":"string"},"cDesStatus":{"type":"string"}},"title":"ObterRecibo (retorno)"},"servicos_osdocs_ObterViaUnica":{"type":"object","title":"ObterViaUnica","description":"Retorna as informações do faturamento de uma nota Via Única","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterViaUnica"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdNf":{"type":"integer","maxLength":15,"description":"ID do documento fiscal.\n\nEssa informação pode ser obtida pela API:\n/api/v1/mobile/faturamento/\nRetornado na tag \"nIdDoc\""}},"required":["nIdNf"]}}},"example":{"call":"ObterViaUnica","param":[{"nIdNf":0}]}},"servicos_osdocs_ObterViaUnica_retorno":{"type":"object","properties":{"cNumOs":{"type":"string","description":"Número da Ordem de Serviço."},"cNumViaUnica":{"type":"string","description":"Número da nota fiscal Via Única."},"cSerieViaUnica":{"type":"string","description":"Série da nota fiscal Via Única."},"cModelo":{"type":"string","description":"Modelo da nota fiscal Via Única."},"cPdfViaUnica":{"type":"string","description":"Link para obter o PDF da nota fiscal Via Única."},"cLinkPortal":{"type":"string","description":"Link para acessar os documentos no portal Omie."},"cCodStatus":{"type":"string"},"cDesStatus":{"type":"string"}},"title":"ObterViaUnica (retorno)"},"servicos_oslote_FaturarLoteOS":{"type":"object","title":"FaturarLoteOS","description":"Faturar Ordens de serviço em lote a partir da etapa informada.","required":["call","param"],"properties":{"call":{"type":"string","enum":["FaturarLoteOS"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cEtapa":{"type":"string","maxLength":2,"description":"Etapa da Operação de Venda.\n\nUtilize a tag \"codigo\" do método \"ListarEtapasFaturamento\" da API\n/api/v1/produtos/etapafat/\npara obter essa informação.\n\nOs valores são fixos, mas as descrições (funções atribuídas a cada coluna pode mudar. A API irá indicar a descrição de cada coluna.\n\nOs valores disponíveis para esse campo podem ser:\n\n\"10\" - Primeira coluna\n\"20\" - Segunda coluna\n\"30\" - Terceira coluna\n\"40\" - Quarta coluna\n\"50\" - Faturar"}}}}},"example":{"call":"FaturarLoteOS","param":[{"cEtapa":"50"}]}},"servicos_oslote_FaturarLoteOS_retorno":{"type":"object","properties":{"nQtdeFat":{"type":"integer","description":"Qtde de Ordens de Serviço faturadas."},"nIdLoteFat":{"type":"integer","description":"Id do Lote de Processamento"},"cCodStatus":{"type":"string"},"cDesStatus":{"type":"string"}},"title":"FaturarLoteOS (retorno)"},"servicos_oslote_ListarLoteNfse":{"type":"object","title":"ListarLoteNfse","description":"Listar Ordens de serviço faturadas a partir do status informado.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarLoteNfse"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15},"nRegistros":{"type":"integer","maxLength":15},"dDtFat":{"type":"string","maxLength":10,"description":"Data de Faturamento"},"cStatusLote":{"type":"string","maxLength":3,"description":"Código do status do lote enviado para a prefeitura.\n\nPode ser:\n\n001 - Aguardando envio para a prefeitura.\n002 - Enviado para a prefeitura, aguardando processamento.\n003 - Processado com erro.\n004 - Processado com sucesso.\n005 - Cancelado com sucesso."}}}}},"example":{"call":"ListarLoteNfse","param":[{"dDtFat":"30/09/2026","cStatusLote":"001"}]}},"servicos_oslote_ListarLoteNfse_retorno":{"type":"object","properties":{"nPagina":{"type":"integer"},"nTotPaginas":{"type":"integer"},"nRegistros":{"type":"integer"},"nTotRegistros":{"type":"integer"},"nfseLote":{"type":"array","items":{"type":"object","properties":{"nLote":{"type":"integer","description":"Lote da NFS-e gerada."},"cNumOs":{"type":"string","description":"Número da Ordem de Serviço (Conforme visualizada em tela pelo cliente)"},"cNumContrato":{"type":"string","description":"Número do Contrato"},"nCodOS":{"type":"integer","description":"ID da Ordem de Serviço (código interno de controle)."},"cNumRps":{"type":"string","description":"Número do Recibo Provisório de Serviços (RPS)."},"cNumNfse":{"type":"string","description":"Número da NFS-e gerada."},"cCodVerif":{"type":"string","description":"Código de Verificação da NFS-e gerada."},"nCodNF":{"type":"integer","description":"Código da Nota Fiscal gerada. (Gerado Internamente, não é exibido na tela)"},"dDtFat":{"type":"string","description":"Data de Faturamento"},"cStatusLote":{"type":"string","description":"Código do status do lote enviado para a prefeitura. Pode ser: 001 - Aguardando envio para a prefeitura. 002 - Enviado para a prefeitura, aguardando processamento. 003 - Processado com erro. 004 - Processado com sucesso. 005 - Cancelado com sucesso."}}},"description":"Notas encontradas para o Status e data de faturamento enviadas"}},"title":"ListarLoteNfse (retorno)"},"servicos_oslote_ListarLotesOS":{"type":"object","title":"ListarLotesOS","description":"Lista status das Ordens de serviço faturadas a partir da data de procesasmento do lote","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarLotesOS"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15},"nRegistros":{"type":"integer","maxLength":15},"nIdLoteFat":{"type":"integer","maxLength":15,"description":"Id do Lote de Processamento"},"cExibirDetalhes":{"type":"string","maxLength":1,"description":"Exibe detalhamento do processamento por lote (S/N).\n\nDefault \"N\""},"dDtIncDe":{"type":"string","maxLength":10,"description":"Data de Inclusão do processamento"},"dDtIncAte":{"type":"string","maxLength":10,"description":"Data de Inclusão até do processamento"}}}}},"example":{"call":"ListarLotesOS","param":[{"dDtIncDe":"30/09/2026","dDtIncAte":"30/09/2026"}]}},"servicos_oslote_ListarLotesOS_retorno":{"type":"object","properties":{"nPagina":{"type":"integer"},"nTotPaginas":{"type":"integer"},"nRegistros":{"type":"integer"},"nTotRegistros":{"type":"integer"},"lotes":{"type":"array","items":{"type":"object","properties":{"nIdLoteFat":{"type":"integer","description":"Id do Lote de Faturamento da Ordem de Serviço"},"nQtdeTotal":{"type":"integer","description":"Quantidade de Contrato de Serviço na Fila"},"nQtdeProcessadas":{"type":"integer","description":"Quantidade de Contrato de Serviços processados"},"cOrigem":{"type":"string","description":"Origem do faturamento. MAN-Manual SCH-Scheduler API - Integração"},"cStatus":{"type":"string","description":"Status do faturamento. RUNNING DONE ERROR"},"dUltimaAtual":{"type":"string"},"hUltimaAtual":{"type":"string"},"dInicioProc":{"type":"string"},"hInicioProc":{"type":"string"},"dConclusaoProc":{"type":"string"},"hConclusaoProc":{"type":"string"},"detalhes":{"type":"object","properties":{"nIdPedido":{"type":"integer","description":"Id do pedido processado"},"cStatus":{"type":"string","description":"Status do faturamento. RUNNING DONE ERROR"},"cMensagem":{"type":"string","description":"Detalhamento do Status do processamento."}},"description":"Ordens de serviços que foram processadas pelo lote filtrado"}}},"description":"Notas encontradas para data de faturamento enviadas"}},"title":"ListarLotesOS (retorno)"},"servicos_oslote_StatusLoteOS":{"type":"object","title":"StatusLoteOS","description":"Status do lote faturado a partir do ID.","required":["call","param"],"properties":{"call":{"type":"string","enum":["StatusLoteOS"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nIdLoteFat":{"type":"integer","maxLength":15,"description":"Id do Lote de Faturamento da Ordem de Serviço"}}}}},"example":{"call":"StatusLoteOS","param":[{"nIdLoteFat":45223245}]}},"servicos_oslote_StatusLoteOS_retorno":{"type":"object","properties":{"nIdLoteFat":{"type":"integer","description":"Id do Lote de Faturamento da Ordem de Serviço"},"nQtdeTotal":{"type":"integer","description":"Quantidade de Ordens de Serviço na Fila"},"nQtdeProcessadas":{"type":"integer","description":"Quantidade de Ordens de Serviço processadas"},"cOrigem":{"type":"string","description":"Origem do faturamento. MAN-Manual SCH-Scheduler API - Integração"},"cStatus":{"type":"string","description":"Status do faturamento. RUNNING DONE ERROR"},"dUltimaAtual":{"type":"string"},"hUltimaAtual":{"type":"string"},"dInicioProc":{"type":"string"},"hInicioProc":{"type":"string"},"dConclusaoProc":{"type":"string"},"hConclusaoProc":{"type":"string"}},"title":"StatusLoteOS (retorno)"},"servicos_osp_AssociarCodIntOS":{"type":"object","title":"AssociarCodIntOS","description":"Associa o código de integração a uma Ordem de Serviço.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AssociarCodIntOS"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cCodIntOS":{"type":"string","maxLength":60,"description":"Código de Integração da OS"},"nCodOS":{"type":"integer","maxLength":15,"description":"Código da Ordem de Serviço"}},"required":["cCodIntOS","nCodOS"]}}},"example":{"call":"AssociarCodIntOS","param":[{"cCodIntOS":"","nCodOS":0}]}},"servicos_osp_AssociarCodIntOS_retorno":{"type":"object","properties":{"cCodIntOS":{"type":"string","description":"Código de Integração da Ordem de Serviço"},"nCodOS":{"type":"integer","description":"Código da Ordem de Serviço"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDescStatus":{"type":"string","description":"Descrição do Status"}},"title":"AssociarCodIntOS (retorno)"},"servicos_osp_CancelarOS":{"type":"object","title":"CancelarOS","description":"Cancela um Ordem de Serviço faturada","required":["call","param"],"properties":{"call":{"type":"string","enum":["CancelarOS"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cCodIntOS":{"type":"string","maxLength":60,"description":"Código de Integração da OS"},"nCodOS":{"type":"integer","maxLength":15,"description":"Código da Ordem de Serviço"},"cCancelarNfse":{"type":"string","maxLength":1,"description":"Indica se havará o cancelamento da NFS-e na prefeitura (S/N).\n\nDefault \"S\"."}}}}},"example":{"call":"CancelarOS","param":[{"cCodIntOS":"","nCodOS":0}]}},"servicos_osp_CancelarOS_retorno":{"type":"object","properties":{"cCodIntOS":{"type":"string","description":"Código de Integração da Ordem de Serviço"},"nCodOS":{"type":"integer","description":"Código da Ordem de Serviço"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDescStatus":{"type":"string","description":"Descrição do Status"}},"title":"CancelarOS (retorno)"},"servicos_osp_DuplicarOS":{"type":"object","title":"DuplicarOS","description":"Duplica uma Ordem de Serviço.","required":["call","param"],"properties":{"call":{"type":"string","enum":["DuplicarOS"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cCodIntOS":{"type":"string","maxLength":60,"description":"Código de Integração da OS"},"nCodOS":{"type":"integer","maxLength":15,"description":"Código da Ordem de Serviço"}}}}},"example":{"call":"DuplicarOS","param":[{"cCodIntOS":"","nCodOS":0}]}},"servicos_osp_DuplicarOS_retorno":{"type":"object","properties":{"cCodIntOS":{"type":"string","description":"Código de Integração da Ordem de Serviço"},"nCodOS":{"type":"integer","description":"Código da Ordem de Serviço"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDescStatus":{"type":"string","description":"Descrição do Status"}},"title":"DuplicarOS (retorno)"},"servicos_osp_FaturarOS":{"type":"object","title":"FaturarOS","description":"Fatura uma Ordem de Serviço.","required":["call","param"],"properties":{"call":{"type":"string","enum":["FaturarOS"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cCodIntOS":{"type":"string","maxLength":60,"description":"Código de Integração da OS"},"nCodOS":{"type":"integer","maxLength":15,"description":"Código da Ordem de Serviço"}}}}},"example":{"call":"FaturarOS","param":[{"cCodIntOS":"","nCodOS":0}]}},"servicos_osp_FaturarOS_retorno":{"type":"object","properties":{"cCodIntOS":{"type":"string","description":"Código de Integração da Ordem de Serviço"},"nCodOS":{"type":"integer","description":"Código da Ordem de Serviço"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDescStatus":{"type":"string","description":"Descrição do Status"}},"title":"FaturarOS (retorno)"},"servicos_osp_ObterOS":{"type":"object","title":"ObterOS","description":"Lista as Ordens de Serviço que se encontram em uma etapa específica do processo de faturamento de OS.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterOS"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cEtapa":{"type":"string","maxLength":2,"description":"Código da Etapa.\n\nValores possíveis:"}},"required":["cEtapa"]}}},"example":{"call":"ObterOS","param":[{"cEtapa":"50"}]}},"servicos_osp_ObterOS_retorno":{"type":"object","properties":{"cEtapa":{"type":"string","description":"Código da Etapa. Valores possíveis: 10 - Lista todos os contratos. 20 - Lista somente os contratos ativos, que devem ser faturados até a data atual, que a data atual esteja dentro do período de vigência e ainda não foram faturados no mês. 30 - Lista os contratos faturados no mês atual. 40 - Lista todos os contratos ativos que precisam ser renovados nos próximos 90 dias."},"listaOS":{"type":"array","items":{"type":"object","properties":{"nIdPed":{"type":"integer","description":"Código do Pedido de Venda"},"cNumPedido":{"type":"string","description":"Número do Pedido de Venda"}}}}},"title":"ObterOS (retorno)"},"servicos_osp_ReenviarOS":{"type":"object","title":"ReenviarOS","description":"Reenvia uma Ordem de Serviço.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ReenviarOS"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cCodIntOS":{"type":"string","maxLength":60,"description":"Código de Integração da OS"},"nCodOS":{"type":"integer","maxLength":15,"description":"Código da Ordem de Serviço"}}}}},"example":{"call":"ReenviarOS","param":[{"cCodIntOS":"","nCodOS":0}]}},"servicos_osp_ReenviarOS_retorno":{"type":"object","properties":{"cCodIntOS":{"type":"string","description":"Código de Integração da Ordem de Serviço"},"nCodOS":{"type":"integer","description":"Código da Ordem de Serviço"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDescStatus":{"type":"string","description":"Descrição do Status"}},"title":"ReenviarOS (retorno)"},"servicos_osp_ValidarOS":{"type":"object","title":"ValidarOS","description":"Valida uma Ordem de Serviço para faturamento.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ValidarOS"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cCodIntOS":{"type":"string","maxLength":60,"description":"Código de Integração da OS"},"nCodOS":{"type":"integer","maxLength":15,"description":"Código da Ordem de Serviço"}}}}},"example":{"call":"ValidarOS","param":[{"cCodIntOS":"","nCodOS":0}]}},"servicos_osp_ValidarOS_retorno":{"type":"object","properties":{"cCodIntOS":{"type":"string","description":"Código de Integração da Ordem de Serviço"},"nCodOS":{"type":"integer","description":"Código da Ordem de Serviço"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDescStatus":{"type":"string","description":"Descrição do Status"}},"title":"ValidarOS (retorno)"},"servicos_resumo_ObterResumoServicos":{"type":"object","title":"ObterResumoServicos","description":"Obtem o resumos dos serviços.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ObterResumoServicos"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"dDataInicio":{"type":"string","maxLength":10,"description":"Data Inicial de Consulta."},"dDataFim":{"type":"string","maxLength":10,"description":"Data final de Consulta."},"lApenasResumo":{"type":"boolean","description":"Exibir apenas o resumo.\n\nQuando true será retornado as estruturas:\n\nOrdemServico->faturarHoje\nContratoServico->faturarHoje\n\nQuando false retornará todas as estruturas.\n\nDefault = true"}}}}},"example":{"call":"ObterResumoServicos","param":[{"dDataInicio":"30/09/2026","dDataFim":"30/09/2026","lApenasResumo":true}]}},"servicos_resumo_ObterResumoServicos_retorno":{"type":"object","properties":{"dDataInicio":{"type":"string","description":"Data Inicial de Consulta."},"dDataFim":{"type":"string","description":"Data final de Consulta."},"painel":{"type":"object","properties":{"faturamentoResumo":{"type":"object","properties":{"nFaturadas":{"type":"decimal","description":"Quantidade faturada."},"vFaturadas":{"type":"decimal","description":"Valor faturado."},"cIconeFat":{"type":"string"},"cCorFat":{"type":"string"},"nCanceladas":{"type":"decimal","description":"Quantidade cancelada."},"vCanceladas":{"type":"decimal","description":"Valor cancelado."},"cIconeCanc":{"type":"string"},"cCorCanc":{"type":"string"},"nPendentes":{"type":"decimal","description":"Quantidade pendente."},"vPendentes":{"type":"decimal","description":"Valor pendente."},"cIconePend":{"type":"string"},"cCorPend":{"type":"string"},"nRejeitadas":{"type":"decimal","description":"Quantidade rejeitada."},"vRejeitadas":{"type":"decimal","description":"Valor rejeitado."},"cIconeRej":{"type":"string"},"cCorRej":{"type":"string"},"nTotal":{"type":"decimal","description":"Quantidade total."},"vTotal":{"type":"decimal","description":"Valor total."},"cIcone":{"type":"string"},"cCor":{"type":"string"}},"description":"Exibe os totais de faturamentos (NFS-e + Recibos)."},"faturamentoNFSe":{"type":"object","properties":{"cVisualizar":{"type":"string","description":"Indica se o aplicativo possuí a configuração desse tipo de documento. Pode ser: S N"},"nFaturadas":{"type":"decimal","description":"Quantidade faturada."},"vFaturadas":{"type":"decimal","description":"Valor faturado."},"cIconeFat":{"type":"string"},"cCorFat":{"type":"string"},"nCanceladas":{"type":"decimal","description":"Quantidade cancelada."},"vCanceladas":{"type":"decimal","description":"Valor cancelado."},"cIconeCanc":{"type":"string"},"cCorCanc":{"type":"string"},"nPendentes":{"type":"decimal","description":"Quantidade pendente."},"vPendentes":{"type":"decimal","description":"Valor pendente."},"cIconePend":{"type":"string"},"cCorPend":{"type":"string"},"nRejeitadas":{"type":"decimal","description":"Quantidade rejeitada."},"vRejeitadas":{"type":"decimal","description":"Valor rejeitado."},"cIconeRej":{"type":"string"},"cCorRej":{"type":"string"},"nTotal":{"type":"decimal","description":"Quantidade total."},"vTotal":{"type":"decimal","description":"Valor total."},"cIcone":{"type":"string"},"cCor":{"type":"string"}},"description":"Exibe os totais de faturamentos de notas de serviço (NFS-e)."},"faturamentoRecibo":{"type":"object","properties":{"cVisualizar":{"type":"string","description":"Indica se o aplicativo possuí a configuração desse tipo de documento. Pode ser: S N"},"nFaturadas":{"type":"decimal","description":"Quantidade faturada."},"vFaturadas":{"type":"decimal","description":"Valor faturado."},"cIconeFat":{"type":"string"},"cCorFat":{"type":"string"},"nCanceladas":{"type":"decimal","description":"Quantidade cancelada."},"vCanceladas":{"type":"decimal","description":"Valor cancelado."},"cIconeCanc":{"type":"string"},"cCorCanc":{"type":"string"},"nTotal":{"type":"decimal","description":"Quantidade total."},"vTotal":{"type":"decimal","description":"Valor total."},"cIcone":{"type":"string"},"cCor":{"type":"string"}},"description":"Exibe os totais de faturamentos de Recibos."},"faturamentoViaUnica":{"type":"object","properties":{"cVisualizar":{"type":"string","description":"Indica se o aplicativo possuí a configuração desse tipo de documento. Pode ser: S N"},"nFaturadas":{"type":"decimal","description":"Quantidade faturada."},"vFaturadas":{"type":"decimal","description":"Valor faturado."},"cIconeFat":{"type":"string"},"cCorFat":{"type":"string"},"nCanceladas":{"type":"decimal","description":"Quantidade cancelada."},"vCanceladas":{"type":"decimal","description":"Valor cancelado."},"cIconeCanc":{"type":"string"},"cCorCanc":{"type":"string"},"nPendentes":{"type":"decimal","description":"Quantidade pendente."},"vPendentes":{"type":"decimal","description":"Valor pendente."},"cIconePend":{"type":"string"},"cCorPend":{"type":"string"},"nRejeitadas":{"type":"decimal","description":"Quantidade rejeitada."},"vRejeitadas":{"type":"decimal","description":"Valor rejeitado."},"cIconeRej":{"type":"string"},"cCorRej":{"type":"string"},"nTotal":{"type":"decimal","description":"Quantidade total."},"vTotal":{"type":"decimal","description":"Valor total."},"cIcone":{"type":"string"},"cCor":{"type":"string"}},"description":"Exibe os totais de faturamentos de notas Via Única."}},"description":"Exibe os totais de faturamento de serviços."},"ordemServico":{"type":"object","properties":{"cNome":{"type":"string","description":"Descrição da operação ( ordem de serviço / Proposta )."},"cNomePlural":{"type":"string","description":"Descrição da operação no plural ( ordem de serviço / Proposta )."},"emAberto":{"type":"object","properties":{"nTotal":{"type":"decimal","description":"Quantidade total."},"vTotal":{"type":"decimal","description":"Valor total."}},"description":"Estrutura contendo os valores em aberto."},"cIconePed":{"type":"string"},"cCorPed":{"type":"string"},"faturarHoje":{"type":"object","properties":{"nTotal":{"type":"decimal","description":"Quantidade total."},"vTotal":{"type":"decimal","description":"Valor total."}},"description":"Exibe os totais com o faturamento previsto para hoje."},"cIconeHoje":{"type":"string"},"cCorHoje":{"type":"string"},"cIcone":{"type":"string"},"cCor":{"type":"string"},"nFaturadas":{"type":"decimal","description":"Quantidade faturada."},"vFaturadas":{"type":"decimal","description":"Valor faturado."},"nCanceladas":{"type":"decimal","description":"Quantidade cancelada."},"vCanceladas":{"type":"decimal","description":"Valor cancelado."},"nRejeitadas":{"type":"decimal","description":"Quantidade rejeitada."},"vRejeitadas":{"type":"decimal","description":"Valor rejeitado."},"cVisualizar":{"type":"string","description":"Indica se o aplicativo possuí a configuração desse tipo de documento. Pode ser: S N"}},"description":"Exibe os totais de Ordens de Serviço não faturadas."},"contratoServico":{"type":"object","properties":{"nFaturadas":{"type":"decimal","description":"Quantidade faturada."},"vFaturadas":{"type":"decimal","description":"Valor faturado."},"cIconeFat":{"type":"string"},"cCorFat":{"type":"string"},"nCanceladas":{"type":"decimal","description":"Quantidade cancelada."},"vCanceladas":{"type":"decimal","description":"Valor cancelado."},"cIconeCanc":{"type":"string"},"cCorCanc":{"type":"string"},"nRejeitadas":{"type":"decimal","description":"Quantidade rejeitada."},"vRejeitadas":{"type":"decimal","description":"Valor rejeitado."},"cIconeRej":{"type":"string"},"cCorRej":{"type":"string"},"nPendentes":{"type":"decimal","description":"Quantidade pendente."},"vPendentes":{"type":"decimal","description":"Valor pendente."},"cIconePend":{"type":"string"},"cCorPend":{"type":"string"},"emAberto":{"type":"object","properties":{"nTotal":{"type":"decimal","description":"Quantidade total."},"vTotal":{"type":"decimal","description":"Valor total."}},"description":"Estrutura contendo os valores em aberto."},"cIconePed":{"type":"string"},"cCorPed":{"type":"string"},"faturarHoje":{"type":"object","properties":{"nTotal":{"type":"decimal","description":"Quantidade total."},"vTotal":{"type":"decimal","description":"Valor total."}},"description":"Exibe os totais com o faturamento previsto para hoje."},"cIconeHoje":{"type":"string"},"cCorHoje":{"type":"string"},"cIcone":{"type":"string"},"cCor":{"type":"string"},"cVisualizar":{"type":"string","description":"Indica se o aplicativo possuí a configuração desse tipo de documento. Pode ser: S N"}},"description":"Exibe os totais de Contratos de Serviço não faturados."},"propostaServico":{"type":"object","properties":{"cVisualizar":{"type":"string","description":"Indica se o aplicativo possuí a configuração desse tipo de documento. Pode ser: S N"},"cNome":{"type":"string","description":"Descrição da operação ( ordem de serviço / Proposta )."},"cNomePlural":{"type":"string","description":"Descrição da operação no plural ( ordem de serviço / Proposta )."},"emAberto":{"type":"object","properties":{"nTotal":{"type":"decimal","description":"Quantidade total."},"vTotal":{"type":"decimal","description":"Valor total."}},"description":"Estrutura contendo os valores em aberto."},"cIcone":{"type":"string"},"cCor":{"type":"string"}},"description":"Exibe os totais das Propostas de Ordens de Serviço."}},"title":"ObterResumoServicos (retorno)"},"servicos_servico_AlterarCadastroServico":{"type":"object","title":"AlterarCadastroServico","description":"Alteração de Serviço.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AlterarCadastroServico"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"intEditar":{"type":"object","properties":{"cCodIntServ":{"type":"string","maxLength":60,"description":"Código de Integração do Serviço.\n(Utilizado em serviços criados via API, não é visualizado na tela)"},"nCodServ":{"type":"integer","maxLength":15,"description":"Código do serviço.\n(Gerado internamente, não é visualizado na tela)"}}},"cabecalho":{"type":"object","properties":{"cDescricao":{"type":"string","maxLength":100,"description":"Descrição Resumida do serviço prestado."},"cCodigo":{"type":"string","maxLength":20,"description":"Código do Serviço."},"cIdTrib":{"type":"string","maxLength":2,"description":"ID da Tributação dos Serviços."},"cCodServMun":{"type":"string","maxLength":20,"description":"Código do Serviço Municipal."},"cCodLC116":{"type":"string","maxLength":10,"description":"Código do Serviço LC 116."},"nIdNBS":{"type":"string","maxLength":9,"description":"Id do NBS."},"nPrecoUnit":{"type":"number","maxLength":18,"description":"Preço Unitário do Serviço."},"cCodCateg":{"type":"string","maxLength":20,"description":"Código da Categoria."},"cTipoDesc":{"type":"string","maxLength":1,"description":"Tipo do desconto.\n\nPode ser:\nP - Percentual\nV - Valor\n\nUtilizado apenas nos métodos de Consulta/Listagem."},"nValorDesc":{"type":"number","maxLength":18,"description":"Valor do desconto.\n\nUtilizado apenas nos métodos de Consulta/Listagem."},"nAliqDesc":{"type":"number","maxLength":18,"description":"Percentual do desconto.\n\nUtilizado apenas nos métodos de Consulta/Listagem."}}},"descricao":{"type":"object","properties":{"cDescrCompleta":{"type":"string","description":"Descrição completa do serviço prestado."}}},"impostos":{"type":"object","properties":{"nAliqISS":{"type":"number","maxLength":10,"description":"Alíquota de ISS."},"cRetISS":{"type":"string","maxLength":1,"description":"ISS Retido (S/N)."},"nAliqPIS":{"type":"number","maxLength":10,"description":"Alíquota do PIS."},"cRetPIS":{"type":"string","maxLength":1,"description":"PIS Retido (S/N)."},"nAliqCOFINS":{"type":"number","maxLength":10,"description":"Alíquota de COFINS."},"cRetCOFINS":{"type":"string","maxLength":1,"description":"COFINS Retido (S/N)."},"nAliqCSLL":{"type":"number","maxLength":10,"description":"Alíquota de CSLL."},"cRetCSLL":{"type":"string","maxLength":1,"description":"CSLL Retido (S/N)."},"nAliqIR":{"type":"number","maxLength":10,"description":"Alíquota do IR."},"cRetIR":{"type":"string","maxLength":1,"description":"IR Retido (S/N)."},"nAliqINSS":{"type":"number","maxLength":10,"description":"Alíquota de INSS."},"cRetINSS":{"type":"string","maxLength":1,"description":"INSS Retido (S/N)."},"nRedBaseINSS":{"type":"number","maxLength":10,"description":"Alíquota de Redução da Base de Cálculo de INSS."},"nRedBasePIS":{"type":"number","maxLength":10,"description":"Alíquota de Redução da Base de Cálculo de PIS"},"nRedBaseCOFINS":{"type":"number","maxLength":10,"description":"Alíquota de Redução da Base de Cálculo de COFINS"},"lDeduzISS":{"type":"boolean","description":"Deduz o ISS da Base de Cálculo de PIS e COFINS."},"cCstPIS":{"type":"string","maxLength":2,"description":"Código da Situação Tributária (CST) do PIS."},"nAliqApuPIS":{"type":"number","maxLength":10,"description":"Alíquota de apuração do PIS."},"cCstCOFINS":{"type":"string","maxLength":2,"description":"Código da Situação Tributária (CST) do COFINS."},"nAliqApuCOFINS":{"type":"number","maxLength":10,"description":"Alíquota de apuração do COFINS."},"nAliqCbs":{"type":"number","maxLength":10,"description":"Alíquota da CBS"},"cCstIbsCbs":{"type":"string","maxLength":3,"description":"Código da Situação Tributária IBS/CBS."},"nAliqIbsUf":{"type":"number","maxLength":10,"description":"Alíquota do IBS Estadual."},"nAliqIbsMun":{"type":"number","maxLength":10,"description":"Alíquota do Alíquota do IBS Municipal."},"nPercReducaoIbsUf":{"type":"number","maxLength":18,"description":"Percentual redução IBS municipal."},"nPercReducaoIbsMun":{"type":"number","maxLength":18,"description":"Percentual redução IBS estadual."},"nPercReducaoCbs":{"type":"number","maxLength":18,"description":"Percentual redução CBS."},"cClassTrib":{"type":"string","maxLength":6,"description":"Código de Classificação Tributária."},"cIndOper":{"type":"string","maxLength":6,"description":"Código Indicador de Operação."}}},"produtosUtilizados":{"type":"object","properties":{"cAtualizarProdutos":{"type":"string","maxLength":1,"description":"Atualiza automaticamente. (S/N).\n\nAtualiza as alterações dos produtos utilizados nas Ordens de Serviço e nos Contratos."},"produtoUtilizado":{"type":"array","items":{"type":"object","properties":{"nIdItemPU":{"type":"integer","maxLength":15,"description":"(Código interno utilizado apenas na API).\nNão informar na inclusão.\n\nEsse código não aparece na tela do Omie."},"cAcaoItemPU":{"type":"string","maxLength":1,"description":"Pode ser:\n\n\"A\" - Alterar o item.\n\"E\" - Excluir o item.\n\"I\" - Incluir o item na alteração."},"nCodProdutoPU":{"type":"integer","maxLength":15,"description":"Código interno do produto.\n(utilizado apenas na API).\nEsse código não aparece na tela do Omie."},"nQtdePU":{"type":"number","maxLength":18,"description":"Quantidade."},"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do Local do Estoque."}}},"description":"rodutos utilizados no serviço."}},"description":"Produtos Utilizados no serviço."},"viaUnica":{"type":"object","properties":{"cUtilizaViaUnica":{"type":"string","maxLength":1,"description":"Indica se o serviço utiliza Nota Fiscal Via Única (Modelos 21 e 22).\n\nPode ser:\nS - Sim\nN - Não"},"cModeloNF":{"type":"string","maxLength":2,"description":"Indica qual modelo de NF será emitida para o serviço.\n\nObrigatório quando a tag cUtilizaViaUnica for igual a \"S\".\n\nPode ser:\n21 - Nota Fiscal de Serviço de Comunicação\n22 - Nota Fiscal de Serviço de Telecomunicação"},"cCFOP":{"type":"string","maxLength":10,"description":"Código CFOP para NF Via Única (Modelos 21 e 22).\n\nObrigatório quando a tag cUtilizaViaUnica for igual a \"S\".\n\nUtilize a tag \"nCodigo\" do método \"ListarCFOP\" da API  /api/v1/produtos/cfop/ para obter essa informação."},"cClassifServico":{"type":"string","maxLength":4,"description":"Código da Classificação para NF Via Única (Modelos 21 e 22).\n\nObrigatório quando a tag cUtilizaViaUnica for igual a \"S\".\n\nUtilize a tag \"cCodigo\" do método \"ListarClassificacaoServico\" da API\n/api/v1/servicos/classificacaoservico/ para obter essa informação."},"cTipoReceita":{"type":"string","maxLength":1,"description":"Indicador do Tipo de Receita para NF Via Única (Modelos 21 e 22).\n\nObrigatório quando a tag cUtilizaViaUnica for igual a \"S\".\n\nPode ser:\n0 - Receita própria - serviços prestados\n1 - Receita própria - cobrança de débitos\n2 - Receita própria - venda de mercadorias\n3 - Receita própria - venda de serviço pré-pago\n4 - Outras receitas próprias\n5 - Receitas de terceiros (co-faturamento)\n9 - Outras receitas de terceiros"},"cTipoUtilizacao":{"type":"string","maxLength":1,"description":"Código do tipo de utilização para NF Via Única (Modelos 21 e 22).\n\nObrigatório quando a tag cUtilizaViaUnica for igual a \"S\".\n\nUtilize a tag \"cCodigo\" do método \"ListarTipoUtilizacao\" da API\n/api/v1/servicos/tipoutilizacao/ para obter essa informação."}},"description":"NF Via Única (Modelo 21 e 22)"}}}}},"example":{"call":"AlterarCadastroServico","param":[{"intEditar":{"cCodIntServ":"","nCodServ":0},"descricao":{"cDescrCompleta":"descricao"},"cabecalho":{"cDescricao":"Descricao","cCodigo":"","cIdTrib":"","cCodServMun":"","cCodLC116":"","nIdNBS":"","nPrecoUnit":10.99,"cCodCateg":""},"impostos":{"nAliqISS":0,"cRetISS":"N","nAliqPIS":0,"cRetPIS":"N","nAliqCOFINS":0,"cRetCOFINS":"N","nAliqCSLL":0,"cRetCSLL":"N","nAliqIR":0,"cRetIR":"N","nAliqINSS":0,"cRetINSS":"N","nRedBaseINSS":0,"nRedBaseCOFINS":0,"nRedBasePIS":0,"lDeduzISS":false}}]}},"servicos_servico_AlterarCadastroServico_retorno":{"type":"object","properties":{"cCodIntServ":{"type":"string","description":"Código de Integração do Serviço. (Utilizado em serviços criados via API, não é visualizado na tela)"},"nCodServ":{"type":"integer","description":"Código do serviço. (Gerado internamente, não é visualizado na tela)"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDescStatus":{"type":"string","description":"Descrição do Status"}},"title":"AlterarCadastroServico (retorno)"},"servicos_servico_AssociarCodIntServico":{"type":"object","title":"AssociarCodIntServico","description":"Associa um Código de Integração a um serviço.","required":["call","param"],"properties":{"call":{"type":"string","enum":["AssociarCodIntServico"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cCodIntServ":{"type":"string","maxLength":60,"description":"Código de Integração do Serviço.\n(Utilizado em serviços criados via API, não é visualizado na tela)"},"nCodServ":{"type":"integer","maxLength":15,"description":"Código do serviço.\n(Gerado internamente, não é visualizado na tela)"}},"required":["cCodIntServ","nCodServ"]}}},"example":{"call":"AssociarCodIntServico","param":[{"nCodServ":0,"cCodIntServ":""}]}},"servicos_servico_AssociarCodIntServico_retorno":{"type":"object","properties":{"cCodIntServ":{"type":"string","description":"Código de Integração do Serviço. (Utilizado em serviços criados via API, não é visualizado na tela)"},"nCodServ":{"type":"integer","description":"Código do serviço. (Gerado internamente, não é visualizado na tela)"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDescStatus":{"type":"string","description":"Descrição do Status"}},"title":"AssociarCodIntServico (retorno)"},"servicos_servico_ConsultarCadastroServico":{"type":"object","title":"ConsultarCadastroServico","description":"Consulta do cadastro de serviço.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ConsultarCadastroServico"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cCodIntServ":{"type":"string","maxLength":60,"description":"Código de Integração do Serviço.\n(Utilizado em serviços criados via API, não é visualizado na tela)"},"nCodServ":{"type":"integer","maxLength":15,"description":"Código do serviço.\n(Gerado internamente, não é visualizado na tela)"}}}}},"example":{"call":"ConsultarCadastroServico","param":[{"cCodIntServ":"","nCodServ":0}]}},"servicos_servico_ConsultarCadastroServico_retorno":{"type":"object","properties":{"intListar":{"type":"object","properties":{"cCodIntServ":{"type":"string","description":"Código de Integração do Serviço. (Utilizado em serviços criados via API, não é visualizado na tela)"},"nCodServ":{"type":"integer","description":"Código do serviço. (Gerado internamente, não é visualizado na tela)"}}},"cabecalho":{"type":"object","properties":{"cDescricao":{"type":"string","description":"Descrição Resumida do serviço prestado."},"cCodigo":{"type":"string","description":"Código do Serviço."},"cIdTrib":{"type":"string","description":"ID da Tributação dos Serviços."},"cCodServMun":{"type":"string","description":"Código do Serviço Municipal."},"cCodLC116":{"type":"string","description":"Código do Serviço LC 116."},"nIdNBS":{"type":"string","description":"Id do NBS."},"nPrecoUnit":{"type":"decimal","description":"Preço Unitário do Serviço."},"cCodCateg":{"type":"string","description":"Código da Categoria."},"cTipoDesc":{"type":"string","description":"Tipo do desconto. Pode ser: P - Percentual V - Valor Utilizado apenas nos métodos de Consulta/Listagem."},"nValorDesc":{"type":"decimal","description":"Valor do desconto. Utilizado apenas nos métodos de Consulta/Listagem."},"nAliqDesc":{"type":"decimal","description":"Percentual do desconto. Utilizado apenas nos métodos de Consulta/Listagem."}}},"descricao":{"type":"object","properties":{"cDescrCompleta":{"type":"string","description":"Descrição completa do serviço prestado."}}},"impostos":{"type":"object","properties":{"nAliqISS":{"type":"decimal","description":"Alíquota de ISS."},"cRetISS":{"type":"string","description":"ISS Retido (S/N)."},"nAliqPIS":{"type":"decimal","description":"Alíquota do PIS."},"cRetPIS":{"type":"string","description":"PIS Retido (S/N)."},"nAliqCOFINS":{"type":"decimal","description":"Alíquota de COFINS."},"cRetCOFINS":{"type":"string","description":"COFINS Retido (S/N)."},"nAliqCSLL":{"type":"decimal","description":"Alíquota de CSLL."},"cRetCSLL":{"type":"string","description":"CSLL Retido (S/N)."},"nAliqIR":{"type":"decimal","description":"Alíquota do IR."},"cRetIR":{"type":"string","description":"IR Retido (S/N)."},"nAliqINSS":{"type":"decimal","description":"Alíquota de INSS."},"cRetINSS":{"type":"string","description":"INSS Retido (S/N)."},"nRedBaseINSS":{"type":"decimal","description":"Alíquota de Redução da Base de Cálculo de INSS."},"nRedBasePIS":{"type":"decimal","description":"Alíquota de Redução da Base de Cálculo de PIS"},"nRedBaseCOFINS":{"type":"decimal","description":"Alíquota de Redução da Base de Cálculo de COFINS"},"lDeduzISS":{"type":"boolean","description":"Deduz o ISS da Base de Cálculo de PIS e COFINS."},"cCstPIS":{"type":"string","description":"Código da Situação Tributária (CST) do PIS."},"nAliqApuPIS":{"type":"decimal","description":"Alíquota de apuração do PIS."},"cCstCOFINS":{"type":"string","description":"Código da Situação Tributária (CST) do COFINS."},"nAliqApuCOFINS":{"type":"decimal","description":"Alíquota de apuração do COFINS."},"nAliqCbs":{"type":"decimal","description":"Alíquota da CBS"},"cCstIbsCbs":{"type":"string","description":"Código da Situação Tributária IBS/CBS."},"nAliqIbsUf":{"type":"decimal","description":"Alíquota do IBS Estadual."},"nAliqIbsMun":{"type":"decimal","description":"Alíquota do Alíquota do IBS Municipal."},"nPercReducaoIbsUf":{"type":"decimal","description":"Percentual redução IBS municipal."},"nPercReducaoIbsMun":{"type":"decimal","description":"Percentual redução IBS estadual."},"nPercReducaoCbs":{"type":"decimal","description":"Percentual redução CBS."},"cClassTrib":{"type":"string","description":"Código de Classificação Tributária."},"cIndOper":{"type":"string","description":"Código Indicador de Operação."}}},"info":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão."},"hInc":{"type":"string","description":"Hora da Inclusão."},"uInc":{"type":"string","description":"Usuário da Inclusão."},"dAlt":{"type":"string","description":"Data da Alteração."},"hAlt":{"type":"string","description":"Hora da Alteração."},"uAlt":{"type":"string","description":"Usuário da Alteração."},"cImpAPI":{"type":"string","description":"Importado pela API (S/N)."},"inativo":{"type":"string","description":"Indica se o serviço está inativo (S/N)."}}},"produtosUtilizados":{"type":"object","properties":{"cAtualizarProdutos":{"type":"string","description":"Atualiza automaticamente. (S/N). Atualiza as alterações dos produtos utilizados nas Ordens de Serviço e nos Contratos."},"produtoUtilizado":{"type":"array","items":{"type":"object","properties":{"nIdItemPU":{"type":"integer","description":"(Código interno utilizado apenas na API). Não informar na inclusão. Esse código não aparece na tela do Omie."},"cAcaoItemPU":{"type":"string","description":"Pode ser: \"A\" - Alterar o item. \"E\" - Excluir o item. \"I\" - Incluir o item na alteração."},"nCodProdutoPU":{"type":"integer","description":"Código interno do produto. (utilizado apenas na API). Esse código não aparece na tela do Omie."},"nQtdePU":{"type":"decimal","description":"Quantidade."},"codigo_local_estoque":{"type":"integer","description":"Código do Local do Estoque."}}},"description":"rodutos utilizados no serviço."}},"description":"Produtos Utilizados no serviço."},"viaUnica":{"type":"object","properties":{"cUtilizaViaUnica":{"type":"string","description":"Indica se o serviço utiliza Nota Fiscal Via Única (Modelos 21 e 22). Pode ser: S - Sim N - Não"},"cModeloNF":{"type":"string","description":"Indica qual modelo de NF será emitida para o serviço. Obrigatório quando a tag cUtilizaViaUnica for igual a \"S\". Pode ser: 21 - Nota Fiscal de Serviço de Comunicação 22 - Nota Fiscal de Serviço de Telecomunicação"},"cCFOP":{"type":"string","description":"Código CFOP para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cUtilizaViaUnica for igual a \"S\". Utilize a tag \"nCodigo\" do método \"ListarCFOP\" da API /api/v1/produtos/cfop/ para obter essa informação."},"cClassifServico":{"type":"string","description":"Código da Classificação para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cUtilizaViaUnica for igual a \"S\". Utilize a tag \"cCodigo\" do método \"ListarClassificacaoServico\" da API /api/v1/servicos/classificacaoservico/ para obter essa informação."},"cTipoReceita":{"type":"string","description":"Indicador do Tipo de Receita para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cUtilizaViaUnica for igual a \"S\". Pode ser: 0 - Receita própria - serviços prestados 1 - Receita própria - cobrança de débitos 2 - Receita própria - venda de mercadorias 3 - Receita própria - venda de serviço pré-pago 4 - Outras receitas próprias 5 - Receitas de terceiros (co-faturamento) 9 - Outras receitas de terceiros"},"cTipoUtilizacao":{"type":"string","description":"Código do tipo de utilização para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cUtilizaViaUnica for igual a \"S\". Utilize a tag \"cCodigo\" do método \"ListarTipoUtilizacao\" da API /api/v1/servicos/tipoutilizacao/ para obter essa informação."}},"description":"NF Via Única (Modelo 21 e 22)"}},"title":"ConsultarCadastroServico (retorno)"},"servicos_servico_ExcluirCadastroServico":{"type":"object","title":"ExcluirCadastroServico","description":"Exclusão do cadastro de serviço.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ExcluirCadastroServico"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"cCodIntServ":{"type":"string","maxLength":60,"description":"Código de Integração do Serviço.\n(Utilizado em serviços criados via API, não é visualizado na tela)"},"nCodServ":{"type":"integer","maxLength":15,"description":"Código do serviço.\n(Gerado internamente, não é visualizado na tela)"}}}}},"example":{"call":"ExcluirCadastroServico","param":[{"cCodIntServ":"","nCodServ":0}]}},"servicos_servico_ExcluirCadastroServico_retorno":{"type":"object","properties":{"cCodIntServ":{"type":"string","description":"Código de Integração do Serviço. (Utilizado em serviços criados via API, não é visualizado na tela)"},"nCodServ":{"type":"integer","description":"Código do serviço. (Gerado internamente, não é visualizado na tela)"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDescStatus":{"type":"string","description":"Descrição do Status"}},"title":"ExcluirCadastroServico (retorno)"},"servicos_servico_IncluirCadastroServico":{"type":"object","title":"IncluirCadastroServico","description":"Inclusão de serviço.","required":["call","param"],"properties":{"call":{"type":"string","enum":["IncluirCadastroServico"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"intIncluir":{"type":"object","properties":{"cCodIntServ":{"type":"string","maxLength":60,"description":"Código de Integração do Serviço.\n(Utilizado em serviços criados via API, não é visualizado na tela)"}},"required":["cCodIntServ"]},"cabecalho":{"type":"object","properties":{"cDescricao":{"type":"string","maxLength":100,"description":"Descrição Resumida do serviço prestado."},"cCodigo":{"type":"string","maxLength":20,"description":"Código do Serviço."},"cIdTrib":{"type":"string","maxLength":2,"description":"ID da Tributação dos Serviços."},"cCodServMun":{"type":"string","maxLength":20,"description":"Código do Serviço Municipal."},"cCodLC116":{"type":"string","maxLength":10,"description":"Código do Serviço LC 116."},"nIdNBS":{"type":"string","maxLength":9,"description":"Id do NBS."},"nPrecoUnit":{"type":"number","maxLength":18,"description":"Preço Unitário do Serviço."},"cCodCateg":{"type":"string","maxLength":20,"description":"Código da Categoria."},"cTipoDesc":{"type":"string","maxLength":1,"description":"Tipo do desconto.\n\nPode ser:\nP - Percentual\nV - Valor\n\nUtilizado apenas nos métodos de Consulta/Listagem."},"nValorDesc":{"type":"number","maxLength":18,"description":"Valor do desconto.\n\nUtilizado apenas nos métodos de Consulta/Listagem."},"nAliqDesc":{"type":"number","maxLength":18,"description":"Percentual do desconto.\n\nUtilizado apenas nos métodos de Consulta/Listagem."}}},"descricao":{"type":"object","properties":{"cDescrCompleta":{"type":"string","description":"Descrição completa do serviço prestado."}}},"impostos":{"type":"object","properties":{"nAliqISS":{"type":"number","maxLength":10,"description":"Alíquota de ISS."},"cRetISS":{"type":"string","maxLength":1,"description":"ISS Retido (S/N)."},"nAliqPIS":{"type":"number","maxLength":10,"description":"Alíquota do PIS."},"cRetPIS":{"type":"string","maxLength":1,"description":"PIS Retido (S/N)."},"nAliqCOFINS":{"type":"number","maxLength":10,"description":"Alíquota de COFINS."},"cRetCOFINS":{"type":"string","maxLength":1,"description":"COFINS Retido (S/N)."},"nAliqCSLL":{"type":"number","maxLength":10,"description":"Alíquota de CSLL."},"cRetCSLL":{"type":"string","maxLength":1,"description":"CSLL Retido (S/N)."},"nAliqIR":{"type":"number","maxLength":10,"description":"Alíquota do IR."},"cRetIR":{"type":"string","maxLength":1,"description":"IR Retido (S/N)."},"nAliqINSS":{"type":"number","maxLength":10,"description":"Alíquota de INSS."},"cRetINSS":{"type":"string","maxLength":1,"description":"INSS Retido (S/N)."},"nRedBaseINSS":{"type":"number","maxLength":10,"description":"Alíquota de Redução da Base de Cálculo de INSS."},"nRedBasePIS":{"type":"number","maxLength":10,"description":"Alíquota de Redução da Base de Cálculo de PIS"},"nRedBaseCOFINS":{"type":"number","maxLength":10,"description":"Alíquota de Redução da Base de Cálculo de COFINS"},"lDeduzISS":{"type":"boolean","description":"Deduz o ISS da Base de Cálculo de PIS e COFINS."},"cCstPIS":{"type":"string","maxLength":2,"description":"Código da Situação Tributária (CST) do PIS."},"nAliqApuPIS":{"type":"number","maxLength":10,"description":"Alíquota de apuração do PIS."},"cCstCOFINS":{"type":"string","maxLength":2,"description":"Código da Situação Tributária (CST) do COFINS."},"nAliqApuCOFINS":{"type":"number","maxLength":10,"description":"Alíquota de apuração do COFINS."},"nAliqCbs":{"type":"number","maxLength":10,"description":"Alíquota da CBS"},"cCstIbsCbs":{"type":"string","maxLength":3,"description":"Código da Situação Tributária IBS/CBS."},"nAliqIbsUf":{"type":"number","maxLength":10,"description":"Alíquota do IBS Estadual."},"nAliqIbsMun":{"type":"number","maxLength":10,"description":"Alíquota do Alíquota do IBS Municipal."},"nPercReducaoIbsUf":{"type":"number","maxLength":18,"description":"Percentual redução IBS municipal."},"nPercReducaoIbsMun":{"type":"number","maxLength":18,"description":"Percentual redução IBS estadual."},"nPercReducaoCbs":{"type":"number","maxLength":18,"description":"Percentual redução CBS."},"cClassTrib":{"type":"string","maxLength":6,"description":"Código de Classificação Tributária."},"cIndOper":{"type":"string","maxLength":6,"description":"Código Indicador de Operação."}}},"produtosUtilizados":{"type":"object","properties":{"cAtualizarProdutos":{"type":"string","maxLength":1,"description":"Atualiza automaticamente. (S/N).\n\nAtualiza as alterações dos produtos utilizados nas Ordens de Serviço e nos Contratos."},"produtoUtilizado":{"type":"array","items":{"type":"object","properties":{"nIdItemPU":{"type":"integer","maxLength":15,"description":"(Código interno utilizado apenas na API).\nNão informar na inclusão.\n\nEsse código não aparece na tela do Omie."},"cAcaoItemPU":{"type":"string","maxLength":1,"description":"Pode ser:\n\n\"A\" - Alterar o item.\n\"E\" - Excluir o item.\n\"I\" - Incluir o item na alteração."},"nCodProdutoPU":{"type":"integer","maxLength":15,"description":"Código interno do produto.\n(utilizado apenas na API).\nEsse código não aparece na tela do Omie."},"nQtdePU":{"type":"number","maxLength":18,"description":"Quantidade."},"codigo_local_estoque":{"type":"integer","maxLength":15,"description":"Código do Local do Estoque."}}},"description":"rodutos utilizados no serviço."}},"description":"Produtos Utilizados no serviço."},"viaUnica":{"type":"object","properties":{"cUtilizaViaUnica":{"type":"string","maxLength":1,"description":"Indica se o serviço utiliza Nota Fiscal Via Única (Modelos 21 e 22).\n\nPode ser:\nS - Sim\nN - Não"},"cModeloNF":{"type":"string","maxLength":2,"description":"Indica qual modelo de NF será emitida para o serviço.\n\nObrigatório quando a tag cUtilizaViaUnica for igual a \"S\".\n\nPode ser:\n21 - Nota Fiscal de Serviço de Comunicação\n22 - Nota Fiscal de Serviço de Telecomunicação"},"cCFOP":{"type":"string","maxLength":10,"description":"Código CFOP para NF Via Única (Modelos 21 e 22).\n\nObrigatório quando a tag cUtilizaViaUnica for igual a \"S\".\n\nUtilize a tag \"nCodigo\" do método \"ListarCFOP\" da API  /api/v1/produtos/cfop/ para obter essa informação."},"cClassifServico":{"type":"string","maxLength":4,"description":"Código da Classificação para NF Via Única (Modelos 21 e 22).\n\nObrigatório quando a tag cUtilizaViaUnica for igual a \"S\".\n\nUtilize a tag \"cCodigo\" do método \"ListarClassificacaoServico\" da API\n/api/v1/servicos/classificacaoservico/ para obter essa informação."},"cTipoReceita":{"type":"string","maxLength":1,"description":"Indicador do Tipo de Receita para NF Via Única (Modelos 21 e 22).\n\nObrigatório quando a tag cUtilizaViaUnica for igual a \"S\".\n\nPode ser:\n0 - Receita própria - serviços prestados\n1 - Receita própria - cobrança de débitos\n2 - Receita própria - venda de mercadorias\n3 - Receita própria - venda de serviço pré-pago\n4 - Outras receitas próprias\n5 - Receitas de terceiros (co-faturamento)\n9 - Outras receitas de terceiros"},"cTipoUtilizacao":{"type":"string","maxLength":1,"description":"Código do tipo de utilização para NF Via Única (Modelos 21 e 22).\n\nObrigatório quando a tag cUtilizaViaUnica for igual a \"S\".\n\nUtilize a tag \"cCodigo\" do método \"ListarTipoUtilizacao\" da API\n/api/v1/servicos/tipoutilizacao/ para obter essa informação."}},"description":"NF Via Única (Modelo 21 e 22)"}}}}},"example":{"call":"IncluirCadastroServico","param":[{"intIncluir":{"cCodIntServ":"1234"},"descricao":{"cDescrCompleta":"descricao"},"cabecalho":{"cDescricao":"Descricao","cCodigo":"1234","cIdTrib":"","cCodServMun":"","cCodLC116":"","nIdNBS":"","nPrecoUnit":10.99,"cCodCateg":""},"impostos":{"nAliqISS":0,"cRetISS":"N","nAliqPIS":0,"cRetPIS":"N","nAliqCOFINS":0,"cRetCOFINS":"N","nAliqCSLL":0,"cRetCSLL":"N","nAliqIR":0,"cRetIR":"N","nAliqINSS":0,"cRetINSS":"N","nRedBaseINSS":0,"nRedBaseCOFINS":0,"nRedBasePIS":0,"lDeduzISS":false}}]}},"servicos_servico_IncluirCadastroServico_retorno":{"type":"object","properties":{"cCodIntServ":{"type":"string","description":"Código de Integração do Serviço. (Utilizado em serviços criados via API, não é visualizado na tela)"},"nCodServ":{"type":"integer","description":"Código do serviço. (Gerado internamente, não é visualizado na tela)"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDescStatus":{"type":"string","description":"Descrição do Status"}},"title":"IncluirCadastroServico (retorno)"},"servicos_servico_ListarCadastroServico":{"type":"object","title":"ListarCadastroServico","description":"Lista os serviços cadastrados.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarCadastroServico"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"nPagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"nRegPorPagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"cOrdenarPor":{"type":"string","maxLength":100,"description":"Ordem de exibição dos dados. Padrão: Código."},"cOrdemDecrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."},"dInclusaoInicial":{"type":"string","maxLength":10,"description":"Data da Inclusão Inicial."},"dInclusaoFinal":{"type":"string","maxLength":10,"description":"Data da Inclusão final"},"dAlteracaoInicial":{"type":"string","maxLength":10,"description":"Data da Alteração Inicial."},"dAlteracaoFinal":{"type":"string","maxLength":10,"description":"Data da Alteração final."},"hInclusaoInicial":{"type":"string","maxLength":8,"description":"Hora da Inclusão Inicial."},"hInclusaoFinal":{"type":"string","maxLength":8,"description":"Hora da Inclusão Final."},"hAlteracaoInicial":{"type":"string","maxLength":8,"description":"Hora da Alteração Inicial."},"hAlteracaoFinal":{"type":"string","maxLength":8,"description":"Hora da Alteração Final."},"cDescricao":{"type":"string","maxLength":100,"description":"Descrição Resumida do serviço prestado."},"cCodigo":{"type":"string","maxLength":20,"description":"Código do Serviço."},"inativo":{"type":"string","maxLength":1,"description":"Indica se o serviço está inativo [S/N]"},"cExibirProdutos":{"type":"string","maxLength":1,"description":"Exibir os produtos utilizados (S/N).\n\n\nPreencher com \"S\" ou \"N\"."}}}}},"example":{"call":"ListarCadastroServico","param":[{"nPagina":1,"nRegPorPagina":20}]}},"servicos_servico_ListarCadastroServico_retorno":{"type":"object","properties":{"nPagina":{"type":"integer","description":"Número da página retornada"},"nTotPaginas":{"type":"integer","description":"Número total de páginas"},"nRegistros":{"type":"integer","description":"Número de registros retornados na página."},"nTotRegistros":{"type":"integer","description":"total de registros encontrados"},"cadastros":{"type":"array","items":{"type":"object","properties":{"intListar":{"type":"object","properties":{"cCodIntServ":{"type":"string","description":"Código de Integração do Serviço. (Utilizado em serviços criados via API, não é visualizado na tela)"},"nCodServ":{"type":"integer","description":"Código do serviço. (Gerado internamente, não é visualizado na tela)"}}},"cabecalho":{"type":"object","properties":{"cDescricao":{"type":"string","description":"Descrição Resumida do serviço prestado."},"cCodigo":{"type":"string","description":"Código do Serviço."},"cIdTrib":{"type":"string","description":"ID da Tributação dos Serviços."},"cCodServMun":{"type":"string","description":"Código do Serviço Municipal."},"cCodLC116":{"type":"string","description":"Código do Serviço LC 116."},"nIdNBS":{"type":"string","description":"Id do NBS."},"nPrecoUnit":{"type":"decimal","description":"Preço Unitário do Serviço."},"cCodCateg":{"type":"string","description":"Código da Categoria."},"cTipoDesc":{"type":"string","description":"Tipo do desconto. Pode ser: P - Percentual V - Valor Utilizado apenas nos métodos de Consulta/Listagem."},"nValorDesc":{"type":"decimal","description":"Valor do desconto. Utilizado apenas nos métodos de Consulta/Listagem."},"nAliqDesc":{"type":"decimal","description":"Percentual do desconto. Utilizado apenas nos métodos de Consulta/Listagem."}}},"descricao":{"type":"object","properties":{"cDescrCompleta":{"type":"string","description":"Descrição completa do serviço prestado."}}},"impostos":{"type":"object","properties":{"nAliqISS":{"type":"decimal","description":"Alíquota de ISS."},"cRetISS":{"type":"string","description":"ISS Retido (S/N)."},"nAliqPIS":{"type":"decimal","description":"Alíquota do PIS."},"cRetPIS":{"type":"string","description":"PIS Retido (S/N)."},"nAliqCOFINS":{"type":"decimal","description":"Alíquota de COFINS."},"cRetCOFINS":{"type":"string","description":"COFINS Retido (S/N)."},"nAliqCSLL":{"type":"decimal","description":"Alíquota de CSLL."},"cRetCSLL":{"type":"string","description":"CSLL Retido (S/N)."},"nAliqIR":{"type":"decimal","description":"Alíquota do IR."},"cRetIR":{"type":"string","description":"IR Retido (S/N)."},"nAliqINSS":{"type":"decimal","description":"Alíquota de INSS."},"cRetINSS":{"type":"string","description":"INSS Retido (S/N)."},"nRedBaseINSS":{"type":"decimal","description":"Alíquota de Redução da Base de Cálculo de INSS."},"nRedBasePIS":{"type":"decimal","description":"Alíquota de Redução da Base de Cálculo de PIS"},"nRedBaseCOFINS":{"type":"decimal","description":"Alíquota de Redução da Base de Cálculo de COFINS"},"lDeduzISS":{"type":"boolean","description":"Deduz o ISS da Base de Cálculo de PIS e COFINS."},"cCstPIS":{"type":"string","description":"Código da Situação Tributária (CST) do PIS."},"nAliqApuPIS":{"type":"decimal","description":"Alíquota de apuração do PIS."},"cCstCOFINS":{"type":"string","description":"Código da Situação Tributária (CST) do COFINS."},"nAliqApuCOFINS":{"type":"decimal","description":"Alíquota de apuração do COFINS."},"nAliqCbs":{"type":"decimal","description":"Alíquota da CBS"},"cCstIbsCbs":{"type":"string","description":"Código da Situação Tributária IBS/CBS."},"nAliqIbsUf":{"type":"decimal","description":"Alíquota do IBS Estadual."},"nAliqIbsMun":{"type":"decimal","description":"Alíquota do Alíquota do IBS Municipal."},"nPercReducaoIbsUf":{"type":"decimal","description":"Percentual redução IBS municipal."},"nPercReducaoIbsMun":{"type":"decimal","description":"Percentual redução IBS estadual."},"nPercReducaoCbs":{"type":"decimal","description":"Percentual redução CBS."},"cClassTrib":{"type":"string","description":"Código de Classificação Tributária."},"cIndOper":{"type":"string","description":"Código Indicador de Operação."}}},"info":{"type":"object","properties":{"dInc":{"type":"string","description":"Data da Inclusão."},"hInc":{"type":"string","description":"Hora da Inclusão."},"uInc":{"type":"string","description":"Usuário da Inclusão."},"dAlt":{"type":"string","description":"Data da Alteração."},"hAlt":{"type":"string","description":"Hora da Alteração."},"uAlt":{"type":"string","description":"Usuário da Alteração."},"cImpAPI":{"type":"string","description":"Importado pela API (S/N)."},"inativo":{"type":"string","description":"Indica se o serviço está inativo (S/N)."}}},"produtosUtilizados":{"type":"object","properties":{"cAtualizarProdutos":{"type":"string","description":"Atualiza automaticamente. (S/N). Atualiza as alterações dos produtos utilizados nas Ordens de Serviço e nos Contratos."},"produtoUtilizado":{"type":"array","items":{"type":"object","properties":{"nIdItemPU":{"type":"integer","description":"(Código interno utilizado apenas na API). Não informar na inclusão. Esse código não aparece na tela do Omie."},"cAcaoItemPU":{"type":"string","description":"Pode ser: \"A\" - Alterar o item. \"E\" - Excluir o item. \"I\" - Incluir o item na alteração."},"nCodProdutoPU":{"type":"integer","description":"Código interno do produto. (utilizado apenas na API). Esse código não aparece na tela do Omie."},"nQtdePU":{"type":"decimal","description":"Quantidade."},"codigo_local_estoque":{"type":"integer","description":"Código do Local do Estoque."}}},"description":"rodutos utilizados no serviço."}},"description":"Produtos Utilizados no serviço."},"viaUnica":{"type":"object","properties":{"cUtilizaViaUnica":{"type":"string","description":"Indica se o serviço utiliza Nota Fiscal Via Única (Modelos 21 e 22). Pode ser: S - Sim N - Não"},"cModeloNF":{"type":"string","description":"Indica qual modelo de NF será emitida para o serviço. Obrigatório quando a tag cUtilizaViaUnica for igual a \"S\". Pode ser: 21 - Nota Fiscal de Serviço de Comunicação 22 - Nota Fiscal de Serviço de Telecomunicação"},"cCFOP":{"type":"string","description":"Código CFOP para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cUtilizaViaUnica for igual a \"S\". Utilize a tag \"nCodigo\" do método \"ListarCFOP\" da API /api/v1/produtos/cfop/ para obter essa informação."},"cClassifServico":{"type":"string","description":"Código da Classificação para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cUtilizaViaUnica for igual a \"S\". Utilize a tag \"cCodigo\" do método \"ListarClassificacaoServico\" da API /api/v1/servicos/classificacaoservico/ para obter essa informação."},"cTipoReceita":{"type":"string","description":"Indicador do Tipo de Receita para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cUtilizaViaUnica for igual a \"S\". Pode ser: 0 - Receita própria - serviços prestados 1 - Receita própria - cobrança de débitos 2 - Receita própria - venda de mercadorias 3 - Receita própria - venda de serviço pré-pago 4 - Outras receitas próprias 5 - Receitas de terceiros (co-faturamento) 9 - Outras receitas de terceiros"},"cTipoUtilizacao":{"type":"string","description":"Código do tipo de utilização para NF Via Única (Modelos 21 e 22). Obrigatório quando a tag cUtilizaViaUnica for igual a \"S\". Utilize a tag \"cCodigo\" do método \"ListarTipoUtilizacao\" da API /api/v1/servicos/tipoutilizacao/ para obter essa informação."}},"description":"NF Via Única (Modelo 21 e 22)"}}},"description":"Lista os cadastros encontrados."}},"title":"ListarCadastroServico (retorno)"},"servicos_servico_UpsertCadastroServico":{"type":"object","title":"UpsertCadastroServico","description":"Upsert de serviço.","required":["call","param"],"properties":{"call":{"type":"string","enum":["UpsertCadastroServico"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"intEditar":{"type":"object","properties":{"cCodIntServ":{"type":"string","maxLength":60,"description":"Código de Integração do Serviço.\n(Utilizado em serviços criados via API, não é visualizado na tela)"},"nCodServ":{"type":"integer","maxLength":15,"description":"Código do serviço.\n(Gerado internamente, não é visualizado na tela)"}}},"cabecalho":{"type":"object","properties":{"cDescricao":{"type":"string","maxLength":100,"description":"Descrição Resumida do serviço prestado."},"cCodigo":{"type":"string","maxLength":20,"description":"Código do Serviço."},"cIdTrib":{"type":"string","maxLength":2,"description":"ID da Tributação dos Serviços."},"cCodServMun":{"type":"string","maxLength":20,"description":"Código do Serviço Municipal."},"cCodLC116":{"type":"string","maxLength":10,"description":"Código do Serviço LC 116."},"nIdNBS":{"type":"string","maxLength":9,"description":"Id do NBS."},"nPrecoUnit":{"type":"number","maxLength":18,"description":"Preço Unitário do Serviço."},"cCodCateg":{"type":"string","maxLength":20,"description":"Código da Categoria."},"cTipoDesc":{"type":"string","maxLength":1,"description":"Tipo do desconto.\n\nPode ser:\nP - Percentual\nV - Valor\n\nUtilizado apenas nos métodos de Consulta/Listagem."},"nValorDesc":{"type":"number","maxLength":18,"description":"Valor do desconto.\n\nUtilizado apenas nos métodos de Consulta/Listagem."},"nAliqDesc":{"type":"number","maxLength":18,"description":"Percentual do desconto.\n\nUtilizado apenas nos métodos de Consulta/Listagem."}}},"descricao":{"type":"object","properties":{"cDescrCompleta":{"type":"string","description":"Descrição completa do serviço prestado."}}},"impostos":{"type":"object","properties":{"nAliqISS":{"type":"number","maxLength":10,"description":"Alíquota de ISS."},"cRetISS":{"type":"string","maxLength":1,"description":"ISS Retido (S/N)."},"nAliqPIS":{"type":"number","maxLength":10,"description":"Alíquota do PIS."},"cRetPIS":{"type":"string","maxLength":1,"description":"PIS Retido (S/N)."},"nAliqCOFINS":{"type":"number","maxLength":10,"description":"Alíquota de COFINS."},"cRetCOFINS":{"type":"string","maxLength":1,"description":"COFINS Retido (S/N)."},"nAliqCSLL":{"type":"number","maxLength":10,"description":"Alíquota de CSLL."},"cRetCSLL":{"type":"string","maxLength":1,"description":"CSLL Retido (S/N)."},"nAliqIR":{"type":"number","maxLength":10,"description":"Alíquota do IR."},"cRetIR":{"type":"string","maxLength":1,"description":"IR Retido (S/N)."},"nAliqINSS":{"type":"number","maxLength":10,"description":"Alíquota de INSS."},"cRetINSS":{"type":"string","maxLength":1,"description":"INSS Retido (S/N)."},"nRedBaseINSS":{"type":"number","maxLength":10,"description":"Alíquota de Redução da Base de Cálculo de INSS."},"nRedBasePIS":{"type":"number","maxLength":10,"description":"Alíquota de Redução da Base de Cálculo de PIS"},"nRedBaseCOFINS":{"type":"number","maxLength":10,"description":"Alíquota de Redução da Base de Cálculo de COFINS"},"lDeduzISS":{"type":"boolean","description":"Deduz o ISS da Base de Cálculo de PIS e COFINS."},"cCstPIS":{"type":"string","maxLength":2,"description":"Código da Situação Tributária (CST) do PIS."},"nAliqApuPIS":{"type":"number","maxLength":10,"description":"Alíquota de apuração do PIS."},"cCstCOFINS":{"type":"string","maxLength":2,"description":"Código da Situação Tributária (CST) do COFINS."},"nAliqApuCOFINS":{"type":"number","maxLength":10,"description":"Alíquota de apuração do COFINS."},"nAliqCbs":{"type":"number","maxLength":10,"description":"Alíquota da CBS"},"cCstIbsCbs":{"type":"string","maxLength":3,"description":"Código da Situação Tributária IBS/CBS."},"nAliqIbsUf":{"type":"number","maxLength":10,"description":"Alíquota do IBS Estadual."},"nAliqIbsMun":{"type":"number","maxLength":10,"description":"Alíquota do Alíquota do IBS Municipal."},"nPercReducaoIbsUf":{"type":"number","maxLength":18,"description":"Percentual redução IBS municipal."},"nPercReducaoIbsMun":{"type":"number","maxLength":18,"description":"Percentual redução IBS estadual."},"nPercReducaoCbs":{"type":"number","maxLength":18,"description":"Percentual redução CBS."},"cClassTrib":{"type":"string","maxLength":6,"description":"Código de Classificação Tributária."},"cIndOper":{"type":"string","maxLength":6,"description":"Código Indicador de Operação."}}},"viaUnica":{"type":"object","properties":{"cUtilizaViaUnica":{"type":"string","maxLength":1,"description":"Indica se o serviço utiliza Nota Fiscal Via Única (Modelos 21 e 22).\n\nPode ser:\nS - Sim\nN - Não"},"cModeloNF":{"type":"string","maxLength":2,"description":"Indica qual modelo de NF será emitida para o serviço.\n\nObrigatório quando a tag cUtilizaViaUnica for igual a \"S\".\n\nPode ser:\n21 - Nota Fiscal de Serviço de Comunicação\n22 - Nota Fiscal de Serviço de Telecomunicação"},"cCFOP":{"type":"string","maxLength":10,"description":"Código CFOP para NF Via Única (Modelos 21 e 22).\n\nObrigatório quando a tag cUtilizaViaUnica for igual a \"S\".\n\nUtilize a tag \"nCodigo\" do método \"ListarCFOP\" da API  /api/v1/produtos/cfop/ para obter essa informação."},"cClassifServico":{"type":"string","maxLength":4,"description":"Código da Classificação para NF Via Única (Modelos 21 e 22).\n\nObrigatório quando a tag cUtilizaViaUnica for igual a \"S\".\n\nUtilize a tag \"cCodigo\" do método \"ListarClassificacaoServico\" da API\n/api/v1/servicos/classificacaoservico/ para obter essa informação."},"cTipoReceita":{"type":"string","maxLength":1,"description":"Indicador do Tipo de Receita para NF Via Única (Modelos 21 e 22).\n\nObrigatório quando a tag cUtilizaViaUnica for igual a \"S\".\n\nPode ser:\n0 - Receita própria - serviços prestados\n1 - Receita própria - cobrança de débitos\n2 - Receita própria - venda de mercadorias\n3 - Receita própria - venda de serviço pré-pago\n4 - Outras receitas próprias\n5 - Receitas de terceiros (co-faturamento)\n9 - Outras receitas de terceiros"},"cTipoUtilizacao":{"type":"string","maxLength":1,"description":"Código do tipo de utilização para NF Via Única (Modelos 21 e 22).\n\nObrigatório quando a tag cUtilizaViaUnica for igual a \"S\".\n\nUtilize a tag \"cCodigo\" do método \"ListarTipoUtilizacao\" da API\n/api/v1/servicos/tipoutilizacao/ para obter essa informação."}},"description":"NF Via Única (Modelo 21 e 22)"}}}}},"example":{"call":"UpsertCadastroServico","param":[{"intEditar":{"cCodIntServ":"","nCodServ":0},"descricao":{"cDescrCompleta":"descricao"},"cabecalho":{"cDescricao":"Descricao","cCodigo":"","cIdTrib":"","cCodServMun":"","cCodLC116":"","nIdNBS":"","nPrecoUnit":10.99,"cCodCateg":""},"impostos":{"nAliqISS":0,"cRetISS":"N","nAliqPIS":0,"cRetPIS":"N","nAliqCOFINS":0,"cRetCOFINS":"N","nAliqCSLL":0,"cRetCSLL":"N","nAliqIR":0,"cRetIR":"N","nAliqINSS":0,"cRetINSS":"N","nRedBaseINSS":0,"nRedBaseCOFINS":0,"nRedBasePIS":0,"lDeduzISS":false}}]}},"servicos_servico_UpsertCadastroServico_retorno":{"type":"object","properties":{"cCodIntServ":{"type":"string","description":"Código de Integração do Serviço. (Utilizado em serviços criados via API, não é visualizado na tela)"},"nCodServ":{"type":"integer","description":"Código do serviço. (Gerado internamente, não é visualizado na tela)"},"cCodStatus":{"type":"string","description":"Código do Status"},"cDescStatus":{"type":"string","description":"Descrição do Status"}},"title":"UpsertCadastroServico (retorno)"},"servicos_tipotrib_ListarTiposTrib":{"type":"object","title":"ListarTiposTrib","description":"Listar os tipos de tributação do serviço.","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarTiposTrib"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"ordenar_por":{"type":"string","maxLength":100,"description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."},"apenas_importado_api":{"type":"string","maxLength":1,"description":"DEPRECATED"}}}}},"example":{"call":"ListarTiposTrib","param":[{"pagina":1,"registros_por_pagina":20}]}},"servicos_tipotrib_ListarTiposTrib_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada"},"total_de_paginas":{"type":"integer","description":"Número total de páginas"},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"total de registros encontrados"},"cadastros":{"type":"array","items":{"type":"object","properties":{"cIdTrib":{"type":"string","description":"Id do Tipo de Tributação no Município. (Gerado internamente, não é visualizado na tela)"},"cTipo":{"type":"string","description":"Código do Tipo de Tributação no Município."},"cDescricao":{"type":"string","description":"Descrição do Tipo de Tributação no Município."}}},"description":"Lista os cadastros encontrados."}},"title":"ListarTiposTrib (retorno)"},"servicos_tipoutilizacao_ListarTipoUtilizacao":{"type":"object","title":"ListarTipoUtilizacao","description":"Lista os tipos de utilização do serviço","required":["call","param"],"properties":{"call":{"type":"string","enum":["ListarTipoUtilizacao"],"description":"nome da operação"},"param":{"type":"array","minItems":1,"maxItems":1,"description":"lista com exatamente um objeto de parâmetros","items":{"type":"object","properties":{"pagina":{"type":"integer","maxLength":15,"description":"Número da página para resgatar os dados."},"registros_por_pagina":{"type":"integer","maxLength":15,"description":"Número de registros a serem exibidos por página.\nMáximo 50."},"ordenar_por":{"type":"string","maxLength":100,"description":"Ordem de exibição dos dados. Padrão: Código."},"ordem_decrescente":{"type":"string","maxLength":1,"description":"Se a lista será apresentada em ordem decrescente."}}}}},"example":{"call":"ListarTipoUtilizacao","param":[{"pagina":1,"registros_por_pagina":20}]}},"servicos_tipoutilizacao_ListarTipoUtilizacao_retorno":{"type":"object","properties":{"pagina":{"type":"integer","description":"Número da página retornada"},"total_de_paginas":{"type":"integer","description":"Número total de páginas"},"registros":{"type":"integer","description":"Número de registros retornados na página."},"total_de_registros":{"type":"integer","description":"total de registros encontrados"},"cadastros":{"type":"array","items":{"type":"object","properties":{"cCodigo":{"type":"string","description":"Código do tipo de utilização do serviço"},"cDescricao":{"type":"string","description":"Descrição do tipo de utilização do serviço"}}},"description":"Lista os tipos de utilização do serviço."}},"title":"ListarTipoUtilizacao (retorno)"}}}}