Skip to main content
PUT
Alterar Ordem de Serviço
PUT substitui o registro inteiro — envie todos os campos, não apenas os alterados.

Authorizations

Authorization
string
header
required

Envie o token retornado por /v2/autenticar no header Authorization, no formato Bearer {token}.

Body

application/json

Ordem de Serviço. Campos obrigatórios: codigoDaFilial, codigoDaNotaFiscal, dataDaOrdem (válida) e codigoDaFormaDePagamento (deve existir). codigoDoServico, contaCorrente, carteira, centroDeCusto, projeto e classificaçãoAuxiliar são opcionais mas, se informados, devem referenciar cadastros válidos.

codigoDaNotaFiscal
integer<int16>
required

Código do tipo/modelo de nota fiscal a ser gerado no processamento. Deve ser válido para a filial.

codigoDaFilial
integer<int16>
required

Código da filial. Deve ser uma filial válida da empresa.

dataDaOrdem
string<date-time>
required

Data da Ordem de Serviço.

codigoDaFormaDePagamento
integer<int16>
required

Código da forma/condição de pagamento. Deve existir e estar cadastrada na empresa.

numeroDaOrdem
number

Número da Ordem de Serviço. Obrigatório para PUT (alteração); ignorado/gerado pelo servidor na inclusão.

numeroDoDocumento
string | null

Número de documento externo vinculado à ordem.

dataDeProcessamento
string<date-time> | null

Data em que a ordem foi processada.

dataDeCancelamento
string<date-time> | null

Data de cancelamento da ordem.

codigoDoCliente
integer<int32> | null

Código do cliente.

nomeDoCliente
string | null

Nome/razão social do cliente.

naturezaJuridica
string | null

Natureza jurídica do cliente (Física/Jurídica).

cnpjcpf
string | null

CNPJ ou CPF do cliente.

inscricaoEstadual
string | null

Inscrição Estadual do cliente.

inscricaoMunicipal
string | null

Inscrição Municipal do cliente.

cep
string | null

CEP do cliente.

logradouro
string | null

Logradouro do endereço do cliente.

numero
string | null

Número do endereço do cliente.

complemento
string | null

Complemento do endereço do cliente.

bairro
string | null

Bairro do endereço do cliente.

cidade
string | null

Cidade do endereço do cliente.

uf
string | null

UF do endereço do cliente.

codigoDoMunicipio
string | null

Código IBGE do município do cliente.

paisExterior
boolean

Indica se o cliente está localizado no exterior.

codigoDoPais
integer<int32> | null

Código do país do cliente, quando no exterior.

idExterior
string | null

Identificação do cliente no exterior (equivalente ao CNPJ/CPF).

contato
string | null

Nome do contato do cliente.

telefone
string | null

Telefone de contato do cliente.

email
string | null

E-mail de contato do cliente.

observacao
string | null

Observação geral da ordem de serviço.

codigoDoServico
integer<int32>

Código do serviço (CodigosDeServico), quando informado deve ser um serviço válido.

codigoDoVendedor
integer<int32> | null

Código do vendedor responsável.

valorDoServico
number

Valor total do serviço.

descricaoDosServicos
string | null

Descrição consolidada dos serviços da ordem.

tipoDePagamento
integer<int16> | null

Tipo de pagamento aplicado à ordem.

codigoDaCondicaoDePagamento
integer<int32> | null

Código da condição de pagamento aplicada à ordem.

codigoDoItemDeLancamento
string | null

Código do item de lançamento de receita (Contas a Receber), quando informado deve ser um item válido.

historicoCR
string | null

Histórico do lançamento de Contas a Receber.

codigoDaContaCorrente
integer<int16> | null

Código da conta corrente para recebimento, quando informado deve ser válida.

codigoDaCarteira
integer<int16> | null

Código da carteira de cobrança, quando informado deve ser válida para a conta corrente.

codigoDoCentroDeCusto
string | null

Código do centro de custo, quando informado deve ser válido.

codigoDoProjeto
integer<int32> | null

Código do projeto, quando informado deve ser válido.

codigoDaClassificacaoAuxiliar
integer<int32> | null

Código da classificação auxiliar financeira, quando informado deve ser válida.

observacaoCR
string | null

Observação do lançamento de Contas a Receber.

faturamentoNotaFiscalUnica
boolean

Indica se deve ser gerada uma única nota fiscal para toda a ordem (quando falso, é gerada uma nota por parcela).

servicos
object[]

Itens de serviço da ordem de serviço.

parcelas
object[]

Parcelas de recebimento da ordem de serviço. Se não informadas, são geradas automaticamente conforme a condição de pagamento.

Response

Sucesso.

success
boolean
Example:

true

data
object

Representação de retorno (GET) de uma Ordem de Serviço, incluindo campos calculados de status e, para clientes com integração específica (Lean Institute), o Id. da nota fiscal gerada.