OpenAPITodas as operações em OpenAPI (Postman, Insomnia).
Serviços · ContratoFaturamento

Processos do fatutamento de Contratos

POSThttps://app.omie.com.br/api/v1/servicos/contratofat/WSDL
2consultas
5alterações
Claude · MCPpelos assistentes de IA
JSON · XMLformato

AtivarContrato

altera dadosClaudeMCP

Ativa um contrato

Obrigatórios 1

CampoTipoDescrição
nCodCtrnúmero inteiroCódigo do Contrato de Serviço.
Retorno 3O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustextoCódigo do Status
cDescStatustextoDescrição do Status
nCodCtrnúmero inteiroCódigo do Contrato de Serviço.
POST /api/v1/servicos/contratofat/
curl -s https://app.omie.com.br/api/v1/servicos/contratofat/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "AtivarContrato", "param": [{"nCodCtr": 0}]}'

CancelarContrato

altera dadosClaudeMCP

Cancela contrato

Obrigatórios 1

CampoTipoDescrição
nCodCtrnúmero inteiroCódigo do Contrato de Serviço.
Retorno 3O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustextoCódigo do Status
cDescStatustextoDescrição do Status
nCodCtrnúmero inteiroCódigo do Contrato de Serviço.
POST /api/v1/servicos/contratofat/
curl -s https://app.omie.com.br/api/v1/servicos/contratofat/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "CancelarContrato", "param": [{"nCodCtr": 0}]}'

FaturarContrato

altera dadosClaudeMCP

Fatura um contrato.

Obrigatórios 1

CampoTipoDescrição
nCodCtrnúmero inteiroCódigo do Contrato de Serviço.
Retorno 4O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustextoCódigo do Status
cDescStatustextoDescrição do Status
nCodCtrnúmero inteiroCódigo do Contrato de Serviço.
nCodOSnúmero inteiroCódigo da Ordem de Serviço gerada.
POST /api/v1/servicos/contratofat/
curl -s https://app.omie.com.br/api/v1/servicos/contratofat/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "FaturarContrato", "param": [{"nCodCtr": 0}]}'

ObterContratos

consultaClaudeMCP

Obtém os contratos de uma etapa de faturamento.

Obrigatórios 1

CampoTipoDescrição
cEtapatexto · até 2Có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.
Retorno 2O que volta numa chamada bem-sucedida
CampoTipoDescrição
cEtapatextoCó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.
listaContratoslista de objetosLista de contratos encontrados na etapa solicitada.
listaContratos[].cNumCtrtextoNúmero do Contrato de Serviços (Informado pelo usuário / visualizado na tela)
listaContratos[].nCodCtrnúmero inteiroCódigo do Contrato de Serviço.
POST /api/v1/servicos/contratofat/
curl -s https://app.omie.com.br/api/v1/servicos/contratofat/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ObterContratos", "param": [{"cEtapa": "50"}]}'

ReativarContrato

altera dadosClaudeMCP

Reativar contrato

Obrigatórios 1

CampoTipoDescrição
nCodCtrnúmero inteiroCódigo do Contrato de Serviço.
Retorno 3O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustextoCódigo do Status
cDescStatustextoDescrição do Status
nCodCtrnúmero inteiroCódigo do Contrato de Serviço.
POST /api/v1/servicos/contratofat/
curl -s https://app.omie.com.br/api/v1/servicos/contratofat/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ReativarContrato", "param": [{"nCodCtr": 0}]}'

SuspenderContrato

altera dadosClaudeMCP

Suspende contrato

Obrigatórios 1

CampoTipoDescrição
nCodCtrnúmero inteiroCódigo do Contrato de Serviço.
Retorno 3O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustextoCódigo do Status
cDescStatustextoDescrição do Status
nCodCtrnúmero inteiroCódigo do Contrato de Serviço.
POST /api/v1/servicos/contratofat/
curl -s https://app.omie.com.br/api/v1/servicos/contratofat/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "SuspenderContrato", "param": [{"nCodCtr": 0}]}'

ValidarContrato

consultaClaudeMCP

Valida os dados de um contrato para faturamento.

Obrigatórios 1

CampoTipoDescrição
nCodCtrnúmero inteiroCódigo do Contrato de Serviço.
Retorno 3O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodStatustextoCódigo do Status
cDescStatustextoDescrição do Status
nCodCtrnúmero inteiroCódigo do Contrato de Serviço.
POST /api/v1/servicos/contratofat/
curl -s https://app.omie.com.br/api/v1/servicos/contratofat/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ValidarContrato", "param": [{"nCodCtr": 0}]}'