Antes que você possa começar de fato os testes com a nossa API, é importante que conheça alguns processos básicos:
💡 #DicaDoBem: Atualmente, conseguimos testar as nossas API’s diretamente pelo site do Developer, porém, existem alguns programas que também podem realizar esse processo, como é o caso do Postman, Insomnia e o ThunderClient (uma extensão do VS Code) |
Para o nosso teste, vamos utilizar diretamente o Developer. Assim como, vamos utilizar o APP KEY e o APP SECRET padrões, mas se preferir, pode alterar para as suas credenciais 😉
Para cadastrar a nossa Ordem de Serviço, vamos utilizar o seguinte método: IncluirOS
Para a inclusão da OS, serão necessários alguns outros dados, como cliente, serviço, categoria, conta corrente, e saber a etapa de faturamento. Por isso, separamos alguns métodos para te ajudar a encontrar essas informações:
Para a inclusão da OS, podemos utilizar três exemplos de requisição:
Incluindo uma OS com um serviço não cadastrado
Esse exemplo de requisição, é quando você ainda não tem o serviço cadastrado no sistema Omie, e deseja incluir diretamente pela OS
Observe que, é necessário informar todos os dados referente ao serviço, como os códigos (específicos de cada município), e os impostos:
{
"call": "IncluirOS",
"app_key": "XXXXXXXXXXXXX",
"app_secret": "XXXXXXXXXXXXXXX ",
"param": [
{
"Cabecalho": {
"cCodIntOS": "16736292",
"cCodParc": "999",
"cEtapa": "10",
"dDtPrevisao": "13/01/2023",
"nCodCli": 7311798906,
"nQtdeParc": 1
},
"Departamentos": [],
"Email": {
"cEnvBoleto": "N",
"cEnvLink": "N",
"cEnviarPara": "api@omie.com.br"
},
"InformacoesAdicionais": {
"cCidPrestServ": "SAO PAULO (SP)",
"cCodCateg": "1.01.02",
"cDadosAdicNF": "OS incluida via API",
"nCodCC": 7311798895
},
"ServicosPrestados": [
{
"cCodServLC116": "7.07",
"cCodServMun": "01015",
"cDadosAdicItem": "Serviços prestados (API)",
"cDescServ": "Serviço prestado 001 (API)",
"cRetemISS": "N",
"cTribServ": "01",
"impostos": {
"cRetemIRRF": "S",
"cRetemPIS": "S",
"nAliqCOFINS": 0,
"nAliqCSLL": 0,
"nAliqIRRF": 15,
"nAliqISS": 3,
"nAliqPIS": 4.5
},
"nQtde": 3,
"nValUnit": 1000
}
]
}
]
}Incluindo uma OS com um serviço já cadastrado
Esse exemplo de requisição é para quando você já possui o serviço cadastrado no sistema Omie
Observe que, na requisição não são enviados tantos dados, apenas a tag "nCodServico" e a "nQtde", necessários para criar a OS. Todos os outros, já foram cadastrados previamente:
{
"call": "IncluirOS",
"app_key": "XXXXXXXXX",
"app_secret": "XXXXXXXXXXXXXXX",
"param": [
{
"Cabecalho": {
"cCodIntOS": "16739122",
"cCodParc": "999",
"cEtapa": "10",
"dDtPrevisao": "13/01/2023",
"nCodCli": 7311798906,
"nQtdeParc": 1
},
"Departamentos": [],
"Email": {
"cEnvBoleto": "N",
"cEnvLink": "N",
"cEnviarPara": "api@omie.com.br"
},
"InformacoesAdicionais": {
"cCidPrestServ": "SAO PAULO (SP)",
"cCodCateg": "1.01.02",
"cDadosAdicNF": "OS incluida via API",
"nCodCC": 7311798895
},
"ServicosPrestados": [
{
"nCodServico": 7316776678,
"nQtde": 1
}
]
}
]
}Incluindo uma OS com um serviço não cadastrado, e com um serviço já cadastrado
Esse exemplo de requisição é para quando deseja enviar um serviço que já foi cadastrado anteriormente no sistema Omie, e mais um serviço que ainda não teve cadastro prévio
Observe que, na requisição são enviadas as informações completas referente ao serviço que não possui cadastro ainda, e apenas as tags "nCodServico" e a "nQtde" no serviço que já possui cadastro:
{
"call": "IncluirOS",
"app_key": "XXXXXXXXXX",
"app_secret": "XXXXXXXXXXXXXX",
"param": [
{
"Cabecalho": {
"cCodIntOS": "16735292",
"cCodParc": "999",
"cEtapa": "10",
"dDtPrevisao": "13/01/2023",
"nCodCli": 7311798906,
"nQtdeParc": 1
},
"Departamentos": [],
"Email": {
"cEnvBoleto": "N",
"cEnvLink": "N",
"cEnviarPara": "api@omie.com.br"
},
"InformacoesAdicionais": {
"cCidPrestServ": "SAO PAULO (SP)",
"cCodCateg": "1.01.02",
"cDadosAdicNF": "OS incluida via API",
"nCodCC": 7311798895
},
"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": 2,
"nValUnit": 1000
},
{
"nCodServico": 7316776678,
"nQtde": 1
}
]
}
]
}
📌 Separamos alguns artigos interessantes para você:
