Processo de Importação — Guia de Integração via API

Antes do primeiro processo, os cadastros abaixo precisam existir e estar configurados no ERP. É deles que o servidor tira os tipos de movimento, as previsões financeiras, a ordem de serviço de acompanhamento e o código interno:

Cadastro	Por que importa
Modelo de Processo de Importação (CEIPROCESMODELO)	Tem o centro de custo (ST_COD), o local de estoque (LE_COD), o tipo de movimento de nacionalização (TM_CODNAC, de um tipo com TM_TIPOIMPORTA maior que zero) e o de saída (TM_CODSAI), as transportadoras, a tributação (MDL_OPER*) e a formação do preço (MDL_PRECO*). Para o caminho B, também o responsável (VD_COD) e a condição de pagamento (PZ_COD), que vão para o orçamento gerado. Com tipo de serviço de acompanhamento (TPS_COD), a inclusão do processo abre a ordem de serviço de acompanhamento vinculada a ele. As etapas de follow-up consultadas no Passo 13 são geradas na retaguarda do ERP, pela opção Gerar Follow-Up da tela de Follow-up, a partir das etapas do modelo; com linhas de desdobramento de duplicatas, cria o desdobramento do processo.
Receitas e despesas previstas do modelo (CEIPROCESMODELO6)	São a origem das previsões financeiras ou das provisões do processo. Com CG_FT_USAPREVIAFIN = 1, cada despesa com pessoa (CF_COD) precisa de uma condição de pagamento (PZ_COD) com parcela em dias: sem ela, a inclusão do processo é recusada com a mensagem de prazo obrigatório (Validações e erros). A despesa de Contrato de Câmbio (tipo de despesa 100) é dividida em uma previsão por parcela da condição de pagamento do câmbio do processo (PZ_CODCAMBIO).
Status do processo (CEISTATUSPROCESSO)	Pelo menos um status de cada tipo (STA_TIPO): 1 Ativo, 2 Encerrado e 3 Cancelado. O código do status (STA_COD) é o que vai em PIM_STATUS; o tipo é o que decide o comportamento (Passo 8).
Tipos financeiros do processo (CEIPROCESTPDOC)	Classificam cada valor do processo no rateio dos títulos e nas previsões. O tipo do câmbio precisa estar marcado como Contrato de Câmbio (TDP_TIPODESPIMP = 100): é por ele que as consultas de câmbio reconhecem os títulos (Passo 11).
Cliente do processo (CLIFOR1)	Com CG_PIM_SUGESTAOCODIGO = 2, o cliente precisa da sigla de processo (CF_PREFIXOPROCESSO). No caminho B sem cliente informado, vale a pessoa padrão da filial (FILIAL.CF_COD). Ver Cadastro de Pessoas.
Configuração da instância	CG_FT_USAPREVIAFIN e CG_PIM_SUGESTAOCODIGO — ver a seção 6 e a configuração da instância na página central.

Esses cadastros são mantidos pela operação dentro do próprio ERP. Pela API, você os lê com GET em CEIPROCESMODELO, CEIPROCESMODELO6, CEISTATUSPROCESSO, CEIPROCESTPDOC e TMOV. Para conhecer os campos exatos, consulte o dicionário oficial da sua instância.

Quando o processo nasce de um orçamento que você montou e calculou, ele é gerado pela rotina CEI_PRC_GERAPROCESSORCAMENTO, executada com "method": "PATCH". As condições, o que a geração faz, o exemplo e os erros estão na página do Orçamento de Importação:

• Passo 11 — Gerar o processo;
• Passo 12 — Conferir o processo gerado.

Depois de gerado, o processo segue pelos Passos 5 a 14 desta página.

A rotina CEI_RES_GERAR_IMPORTACAO_OC recebe uma lista de Ordens de Compra de importação, monta com elas um Orçamento de Importação, calcula o orçamento e gera o processo, numa única chamada. Ela é uma PROCEDURE RESULT, executada com "method": "GET". Apesar do GET, a rotina grava: cria o orçamento e o processo. Por isso, envie a requisição com o verbo HTTP PATCH, como toda gravação.

Antes de chamar

• As Ordens de Compra são da filial informada, de fornecedor (PED1.CF_TIPO = 'F'), com tipo de movimento de nacionalização (tipo com TM_TIPOIMPORTA maior que zero), e ainda não estão vinculadas a nenhum orçamento de importação. Os tipos de movimento de importação se leem por GET em TMOV, com TM_TIPOIMPORTA maior que zero. A Ordem de Compra já usada aparece em CEIORC6 (where em FL_COD, CF_TIPO = 'F' e PE_COD).
• Envie na mesma lista Ordens de Compra da mesma moeda. A moeda e a cotação do orçamento vêm da primeira Ordem de Compra da lista, que precisa ter as duas preenchidas (PED1.ID_COD e PED1.PE_IDVALOR). Sem elas, a rotina devolve SUCESSO = 0 com Cotação não foi informada no Orçamento de Importação N.
• Confira a NCM dos itens. Só entram no orçamento os itens cuja NCM (PED2.PD_CODNCM) está cadastrada em PRODNCM. Se nenhum item entrar, a geração é recusada por falta de itens.
• Vale tudo o que a geração a partir do orçamento exige (Orçamento, Passo 11): código interno único entre os processos. Com CG_FT_USAPREVIAFIN = 1, cada despesa do modelo com pessoa precisa de data de previsão, e a rotina não recebe as datas previstas de embarque, chegada e entrega. Nessas despesas, a data-base do tipo de documento precisa ser Cadastro do Processo. Se o modelo usar outra data-base, siga pelo caminho A, em que você envia as datas no cabeçalho do orçamento.

Para escolher as Ordens de Compra, leia PED1 (cabeçalho) e PED2 (itens) com GET. As regras de gravação desses objetos estão na página de Ordem de Compra.

Exemplo — GET PED1 (Ordens de Compra de uma filial)

{
    "method": "GET"
    ,"objectType": "TABLE"
    ,"objectName": "PED1"
    ,"fields": [ "PE_COD", "CF_COD", "TM_COD", "ID_COD", "PE_IDVALOR", "PE_DAT" ]
    ,"where": [
        { "type": "field", "name": "FL_COD", "value": 1 }
        // F = Ordem de Compra
        ,{ "type": "field", "name": "CF_TIPO", "value": "F" }
        ,{ "type": "expression", "value": "PE_DAT >= '2026-09-01 00:00:00'" }
    ]
    ,"orderBy": [ "PE_COD DESC" ]
    ,"limit": 50
}

Valores ilustrativos. Os códigos desta página são exemplos. Use os cadastros da sua instância. A lista completa e autoritativa de campos de cada objeto está no dicionário oficial.

Envie

Parâmetro	Obrigatório	Descrição
PFL_COD	Sim	Filial das Ordens de Compra e do processo.
PLISTA_PE_COD	Sim	Números das Ordens de Compra, em texto, separados por vírgula: "1119,1118".
PMDL_COD	Sim	Modelo de processo, usado no orçamento e no processo.
PPIM_DES	Não	Descrição do processo. Vazio, o processo recebe a descrição Processo gerado do Orçamento N.
POCI_CODINTERNO	Não	Código interno do orçamento, que segue para o processo. Vazio, vale o número da primeira Ordem de Compra da lista. Precisa ser único entre os processos; com CG_PIM_SUGESTAOCODIGO maior que 0, o código interno do processo é o que a configuração gera.
PINCOTERM	Não	INCOTERM do orçamento. Padrão FOB.
PAGRUPAR	Não	1 (padrão) soma num só item do orçamento os itens de mesmo fornecedor, produto, NCM, preço, desconto e percentual de I.I.; 0 cria um item do orçamento para cada item de Ordem de Compra.
PCF_CODCLIPRO	Não	Cliente do orçamento e do processo, uma pessoa de tipo cliente (CF_TIPO C ou A). Vazio, vale a pessoa padrão da filial (FILIAL.CF_COD).

O que a rotina faz, em ordem

1. Valida a lista, as Ordens de Compra, o modelo e o cliente.
2. Cria o cabeçalho do orçamento (CEIORC1) a partir do modelo: tipo de movimento, responsável, condição de pagamento e formação do preço; moeda e cotação da primeira Ordem de Compra.
3. Cria as adições (CEIORC3), já com o fornecedor da Ordem de Compra, os itens (CEIORC2) e o vínculo de cada item com o item de Ordem de Compra de origem (CEIORC6).
4. Calcula o orçamento.
5. Gera o processo, com os mesmos efeitos do caminho A: o processo nasce com o status de tipo Ativo de menor código cadastrado, com os dados do orçamento e do modelo, e com as previsões ou provisões conforme a configuração.
6. Aplica a descrição de PPIM_DES, quando informada.

Exemplo — GET CEI_RES_GERAR_IMPORTACAO_OC

{
    "method": "GET"
    ,"objectType": "PROCEDURE RESULT"
    ,"objectName": "CEI_RES_GERAR_IMPORTACAO_OC"
    ,"params": [
        { "name": "PFL_COD",       "value": "1" }
        // Ordens de Compra da mesma moeda, separadas por vírgula
        ,{ "name": "PLISTA_PE_COD", "value": "1119,1118" }
        ,{ "name": "PMDL_COD",      "value": "5" }
        ,{ "name": "PPIM_DES",      "value": "Embarque 2026-01" }
        ,{ "name": "PAGRUPAR",      "value": "1" }
    ]
}

A resposta é sempre uma linha, e por isso chega como objeto, com quatro campos:

{
    "SUCESSO": 1
    ,"MENSAGEM": "OK"
    ,"OCI_COD": 1031
    ,"PIM_COD": 215
}

Campo	Conteúdo
SUCESSO	1 sucesso; 0 falha.
MENSAGEM	OK no sucesso; na falha, o texto do erro.
OCI_COD	O orçamento gerado. Nulo na falha.
PIM_COD	O processo gerado. Nulo na falha.

Sem orçamento, inclua o processo por uma requisição com "method": "POST" sobre CEIPROCESCAD. Antes, leia o modelo de processo (GET em CEIPROCESMODELO, por MDL_COD): boa parte dos campos vem dele.

Envie

Campo	Observação
PIM_COD = 0	Obrigatório e sempre presente. O servidor gera o número do processo e o devolve na resposta.
MDL_COD	Obrigatório. Modelo de processo.
PIM_DES	Obrigatório. Descrição do processo.
PIM_CLIPRO	Obrigatório. Cliente do processo.
PIM_CLIORD	Obrigatório. Cliente previsto da nota fiscal de saída; em geral, o mesmo cliente do processo.
PZ_CODCAMBIO	Condição de pagamento do câmbio, quando houver câmbio previsto. Envie já na inclusão: as parcelas previstas do câmbio saem dela.
PIM_DATPREVEMB, PIM_DATAPRECCHE, PIM_DATAPREVENTREGA	Opcionais, com T. Previsões de embarque (ETD), de chegada (ETA) e de entrega.
PIM_MARGLUCRO	Opcional. Quando o cliente tem margem cadastrada no modelo, o servidor grava essa margem e substitui o valor enviado. Sem ela, vale o valor enviado; omitido ou zero, a margem do modelo.

A tela preenche, a API não — envie você

Campo	O que a tela grava
FL_COD	Obrigatório. A empresa em que o usuário está logado.
PIM_DATCAD	Obrigatório. A data do dia, com T.
PIM_STATUS	Um status de tipo Ativo (STA_TIPO = 1) de CEISTATUSPROCESSO. Sem ele, o processo fica fora das rotinas que consideram só processos ativos, como o follow-up (Passo 13).
ST_COD, LE_COD	Obrigatórios. Centro de custo e local de estoque do modelo.
TM_COD_ENT, TM_COD_SAI	Tipos de movimento de entrada e de saída: o TM_CODNAC e o TM_CODSAI do modelo.
TR_COD_ENT, TR_COD_SAI	Transportadoras de entrada e de saída: o TR_CODNAC e o TR_CODSAI do modelo.
VD_COD	Responsável: o VD_COD do modelo.
PIM_OPERPISCOFINS, PIM_OPERICMS, PIM_OPERII, PIM_OPERANTIDUMPING, PIM_OPERCUSTOSADICIONAIS, PIM_OPERAFRMM	A tributação do processo. Copie cada MDL_OPER* do modelo para o PIM_OPER* de mesmo sufixo.
PIM_PRECOCIF, PIM_PRECOII, PIM_PRECOIPI, PIM_PRECOPISCOFINS, PIM_PRECOANTIDUMPING, PIM_PRECOICMSNACIO, PIM_PRECOAFRMM, PIM_PRECODESPESAENTRADA, PIM_PRECODESPESASAIDA, PIM_PRECOCUSTOCTBNAC	As dez indicações de formação de preço (0 não, 1 sim). Copie cada MDL_PRECO* do modelo para o PIM_PRECO* de mesmo sufixo.
TM_CODENTCOMPL, TM_CODSAICOMPL	Tipos de movimento das notas complementares de entrada e de saída: o TM_CODENTCOMPL e o TM_CODSAICOMPL do modelo, cada um no campo de mesmo nome. Se o modelo não tiver, não envie o campo.
TDP_CODSALDOREC, TDP_CODSALDOPAG, PZ_CODSALDO, PT_CODSALDO, EXT_COD	Os dados de acerto de saldo e o modelo de extrato, copiados dos campos de mesmo nome do modelo, quando ele os tiver.
PIM_CODINTERNO	Só com CG_PIM_SUGESTAOCODIGO = 0: o código de controle da empresa, único entre os processos. Envie-o: o extrato por conta bancária filtra o processo por ele (Passo 12). Nos demais modos, o servidor gera o código.

Não envie

Campo	Por quê
PIM_TIPOIMPORTA, PIM_PISCOFINSICMS	O servidor grava na inclusão, a partir do tipo de movimento de TM_COD_ENT. O valor enviado é substituído.
PIM_OPERACRESCIMOCUSTO, TM_CODSAIREMESSA	O servidor grava na inclusão, a partir do modelo. O valor enviado é substituído.
PIM_DTATU	Data da última atualização, gravada pelo servidor.
PIM_RECALCULARCUSTO	Campo de controle do servidor. Com valor diferente de 0, a inclusão não cria as previsões financeiras.
PIM_CODINTERNO	Com CG_PIM_SUGESTAOCODIGO maior que 0: o servidor gera o código e substitui o enviado.

Exemplo — GET CEIPROCESMODELO

{
    "method": "GET"
    ,"objectType": "TABLE"
    ,"objectName": "CEIPROCESMODELO"
    // sem fields: todas as colunas do modelo
    ,"where": [
        { "type": "field", "name": "MDL_COD", "value": 3 }
    ]
}

Exemplo — POST CEIPROCESCAD

{
    "method": "POST"
    ,"objectType": "TABLE"
    ,"objectName": "CEIPROCESCAD"
    ,"dataFields": [
        // numerado pelo servidor: sempre presente, com 0
        { "name": "PIM_COD",                  "value": 0 }
        ,{ "name": "FL_COD",                   "value": 1 }
        ,{ "name": "MDL_COD",                  "value": 3 }
        ,{ "name": "PIM_DES",                  "value": "Importação de rolamentos, lote 12" }
        ,{ "name": "PIM_CLIPRO",               "value": 2150 }
        ,{ "name": "PIM_CLIORD",               "value": 2150 }
        ,{ "name": "PIM_DATCAD",               "value": "2026-09-28T00:00:00" }
        // um status de tipo Ativo (STA_TIPO = 1)
        ,{ "name": "PIM_STATUS",               "value": 1 }
        // copiados do modelo
        ,{ "name": "ST_COD",                   "value": 20 }
        ,{ "name": "LE_COD",                   "value": 3 }
        ,{ "name": "TM_COD_ENT",               "value": "E060" }
        ,{ "name": "TM_COD_SAI",               "value": "S201" }
        ,{ "name": "TR_COD_ENT",               "value": 1 }
        ,{ "name": "TR_COD_SAI",               "value": 1 }
        ,{ "name": "VD_COD",                   "value": 12 }
        ,{ "name": "PIM_OPERPISCOFINS",        "value": 3 }
        ,{ "name": "PIM_OPERICMS",             "value": 3 }
        ,{ "name": "PIM_OPERII",               "value": 1 }
        ,{ "name": "PIM_OPERANTIDUMPING",      "value": 0 }
        ,{ "name": "PIM_OPERCUSTOSADICIONAIS", "value": 2 }
        ,{ "name": "PIM_OPERAFRMM",            "value": 1 }
        ,{ "name": "PIM_PRECOCIF",             "value": 1 }
        ,{ "name": "PIM_PRECOII",              "value": 1 }
        ,{ "name": "PIM_PRECOIPI",             "value": 0 }
        ,{ "name": "PIM_PRECOPISCOFINS",       "value": 1 }
        ,{ "name": "PIM_PRECOANTIDUMPING",     "value": 0 }
        ,{ "name": "PIM_PRECOICMSNACIO",       "value": 1 }
        ,{ "name": "PIM_PRECOAFRMM",           "value": 1 }
        ,{ "name": "PIM_PRECODESPESAENTRADA",  "value": 1 }
        ,{ "name": "PIM_PRECODESPESASAIDA",    "value": 0 }
        ,{ "name": "PIM_PRECOCUSTOCTBNAC",     "value": 0 }
        // condição de pagamento do câmbio: as parcelas previstas saem dela
        ,{ "name": "PZ_CODCAMBIO",             "value": 12 }
        ,{ "name": "PIM_DATAPRECCHE",          "value": "2026-11-10T00:00:00" }
    ]
}

A resposta traz Registro inserido com sucesso e, em data, o PIM_COD gerado. Guarde-o: é a chave de todos os passos seguintes.

Leia o processo e o que nasceu com ele com "method": "GET":

Objeto	Filtro	O que conferir
CEIPROCESCAD	PIM_COD	O código interno (PIM_CODINTERNO), o status (PIM_STATUS) e os campos preenchidos pelo servidor, como o tipo de importação (PIM_TIPOIMPORTA).
CEIORC1	PIM_COD	O orçamento de origem, nos caminhos A e B, ou o vinculado no Passo 6.
CEIPROCESPREVISAO	PIM_COD	As provisões do processo, na instância com CG_FT_USAPREVIAFIN = 0.
DOCSPREVISAO	PIM_COD	As previsões financeiras do processo, na instância com CG_FT_USAPREVIAFIN = 1: vencimento (PRV_DVC), valor (PRV_VAL) e tipo financeiro (TDP_COD).

Exemplo — GET CEIPROCESCAD (um processo)

{
    "method": "GET"
    ,"objectType": "TABLE"
    ,"objectName": "CEIPROCESCAD"
    ,"fields": [ "PIM_COD", "PIM_CODINTERNO", "PIM_DES", "PIM_STATUS", "PIM_TIPOIMPORTA", "MDL_COD" ]
    ,"where": [
        { "type": "field", "name": "PIM_COD", "value": 215 }
    ]
}

Para listar processos, use o mesmo GET em CEIPROCESCAD com where no status, no cliente (PIM_CLIPRO) ou na filial (FL_COD), com limit (linhas por página) e offset (número da página, a partir de 1):

{
    "method": "GET"
    ,"objectType": "TABLE"
    ,"objectName": "CEIPROCESCAD"
    ,"fields": [ "PIM_COD", "PIM_CODINTERNO", "PIM_DES", "PIM_DATCAD" ]
    ,"where": [
        { "type": "field", "name": "PIM_CLIPRO", "value": 2150 }
        ,{ "type": "field", "name": "PIM_STATUS", "value": 1 }
    ]
    ,"orderBy": [ "PIM_COD DESC" ]
    ,"limit": 20
    // offset é a página: 1 traz as linhas 1 a 20
    ,"offset": 1
}

Quando o processo já existe e o orçamento foi montado depois, a tela do ERP os liga pela opção de captar o orçamento. Pela API, faça o mesmo com dois PUT, nesta ordem. O processo precisa estar com status de tipo Ativo, e o orçamento, sem processo (CEIORC1.PIM_COD vazio).

1. PUT em CEIORC1: PIM_COD do processo, com where em OCI_COD e "key": true.
2. PUT em CEIPROCESCAD: os dados de embarque e as datas previstas, copiados do orçamento, com where em PIM_COD e "key": true.

No processo (CEIPROCESCAD)	Copie do orçamento (CEIORC1)
PIM_LOCALENTREGACLIENTE	OCI_LOCALENTREGACLIENTE
PIM_DATAPREVENTREGA	OCI_DATAPREVENTREGA
PIM_DATAPRECCHE	OCI_PREVISAOCHEGADA
PIM_LOCEMB, PIM_NAVIOEMB	OCI_LOCEMB, OCI_NAVIOEMB
PIM_LOCDESTINO, PIM_NAVIODESTINO	OCI_LOCDESTINO, OCI_NAVIODESTINO
PIM_CODINTERNO	OCI_CODINTERNO, só se o processo estiver sem código interno.

Exemplo — PUT CEIORC1 (vínculo)

{
    "method": "PUT"
    ,"objectType": "TABLE"
    ,"objectName": "CEIORC1"
    ,"dataFields": [
        { "name": "PIM_COD", "value": 215 }
    ]
    ,"where": [
        { "type": "field", "name": "OCI_COD", "key": true, "value": 1024 }
    ]
}

Exemplo — PUT CEIPROCESCAD (dados copiados do orçamento)

{
    "method": "PUT"
    ,"objectType": "TABLE"
    ,"objectName": "CEIPROCESCAD"
    ,"dataFields": [
        { "name": "PIM_LOCALENTREGACLIENTE", "value": "Armazém Itajaí" }
        ,{ "name": "PIM_DATAPREVENTREGA",     "value": "2026-11-20T00:00:00" }
        ,{ "name": "PIM_DATAPRECCHE",         "value": "2026-11-10T00:00:00" }
        ,{ "name": "PIM_LOCEMB",              "value": "Shanghai" }
        ,{ "name": "PIM_LOCDESTINO",          "value": "Itajaí" }
    ]
    ,"where": [
        { "type": "field", "name": "PIM_COD", "key": true, "value": 215 }
    ]
}

Altere com "method": "PUT" sobre CEIPROCESCAD, com where em PIM_COD e "key": true. PIM_COD é a chave inteira do processo e não entra em dataFields.

Datas previstas

Campo	Significado
PIM_DATPREVEMB	Data prevista de embarque (ETD).
PIM_DATAPRECCHE	Data prevista de chegada (ETA).
PIM_DATAPREVENTREGA	Data prevista de entrega ao cliente.

Regras, na ordem correta

• Processo encerrado ou cancelado: altere o status antes, num PUT próprio (Passo 8). Depois, faça a alteração.
• Com CG_PIM_SUGESTAOCODIGO maior que 0, não envie PIM_CODINTERNO: a alteração do código interno é recusada. Com 0, o novo código precisa ser único entre os processos.
• Defina o processo entrepostado (PIM_ENTREPOSTADO) antes de registrar a DI. Com DI vinculada, a mudança é recusada.
• Defina a tributação (PIM_OPER*) antes da nacionalização da mercadoria. Depois de toda a mercadoria da DI nacionalizada, a mudança é recusada.

Exemplo — PUT CEIPROCESCAD (datas previstas)

{
    "method": "PUT"
    ,"objectType": "TABLE"
    ,"objectName": "CEIPROCESCAD"
    ,"dataFields": [
        { "name": "PIM_DATPREVEMB",      "value": "2026-10-20T00:00:00" }
        ,{ "name": "PIM_DATAPRECCHE",     "value": "2026-11-18T00:00:00" }
        ,{ "name": "PIM_DATAPREVENTREGA", "value": "2026-11-25T00:00:00" }
    ]
    ,"where": [
        { "type": "field", "name": "PIM_COD", "key": true, "value": 215 }
    ]
}

O status do processo é o código de CEISTATUSPROCESSO gravado em PIM_STATUS. O que decide o comportamento é o tipo do status (STA_TIPO). Leia os status da instância com GET e altere com PUT só com PIM_STATUS:

Para	Envie em PIM_STATUS	Observação
Encerrar	um status de tipo 2 (Encerrado)	O processo e os registros ligados a ele deixam de aceitar alteração.
Cancelar	um status de tipo 3 (Cancelado)	Idem. Se o processo estiver encerrado, a troca exige a mesma permissão de Reabrir.
Reabrir	um status de tipo 1 (Ativo)	Exige, no usuário vinculado ao token, a permissão de alterar o status de processo encerrado (seção 6).

Exemplo — GET CEISTATUSPROCESSO

{
    "method": "GET"
    ,"objectType": "TABLE"
    ,"objectName": "CEISTATUSPROCESSO"
    ,"fields": [ "STA_COD", "STA_DES", "STA_TIPO" ]
    ,"orderBy": [ "STA_TIPO", "STA_COD" ]
}

Exemplo — PUT CEIPROCESCAD (encerrar)

{
    "method": "PUT"
    ,"objectType": "TABLE"
    ,"objectName": "CEIPROCESCAD"
    ,"dataFields": [
        // só o status, num PUT próprio
        { "name": "PIM_STATUS", "value": 8 }
    ]
    ,"where": [
        { "type": "field", "name": "PIM_COD", "key": true, "value": 215 }
    ]
}

O lançamento de contas a pagar e a receber de um processo — o título com o rateio para o processo — é feito pelo APW_PRC_FINDOCADD e está descrito na página de Contas a Pagar/Receber: Passo 9 (vínculo com o processo, a chave CEIPROCESRATEIO e os campos de cada item) e Passo 11 (lançamento). Três pontos são deste fluxo:

• O processo precisa estar com status de tipo Ativo. Encerrado ou cancelado, o rateio é recusado (Passo 8).
• A conferência é pelo rateio. O cabeçalho do documento (DOCS) não guarda o processo: os documentos do processo se leem por GET em CEIPROCESRATEIO com where em PIM_COD (Passo 11).
• Com CG_FT_USAPREVIAFIN = 1, lance pela API só os títulos que não têm previsão. Os títulos das despesas que têm previsão financeira são efetivados na retaguarda do ERP, pela opção Efetivar Previsão da tela do processo, que transforma a previsão no documento com o rateio para o processo. Assim a mesma despesa não conta duas vezes nas consultas financeiras.

Exemplo — GET CEIPROCESRATEIO (documentos do processo)

{
    "method": "GET"
    ,"objectType": "TABLE"
    ,"objectName": "CEIPROCESRATEIO"
    ,"fields": [ "FL_COD", "CF_TIPO", "FT_COD", "TDP_COD", "PIM_VALMNACIO", "PIM_VALMDOLAR", "PIM_CUSTO", "PIM_REEMBOLSO" ]
    ,"where": [
        { "type": "field", "name": "PIM_COD", "value": 215 }
    ]
}

O estoque do processo é o da mercadoria da sua Declaração de Importação (DI ou DUIMP). Primeiro, leia em CEIDICAD, pelo processo, o código de cada DI (DIM_COD); com mais de uma, o retorno é um array, e cada DI se consulta nas views pelo seu DIM_COD. O formato do retorno está em Como a API funciona.

Objeto	Colunas principais	Quando usar
CEI_VIEW_SALDOMERCADORIA (VIEW)	DIM_COD, MER_ID, PD_COD, PD_LOTE, PD_DES, PD_UNI3, QTD_ENTRADA, QTD_SAIDA, QTD_SALDO	Saldo físico de cada item da DI, por lote: entradas menos saídas dos movimentos de estoque vinculados ao item. Depois do encerramento do estoque da DI, QTD_SALDO é zero.
CEI_VIEW_SALDOMERCADORIANACIONALIZACAO (VIEW)	DIM_COD, MER_ID, ADI_NUM, PD_COD, PD_LOTE, MER_QUANTIDADEMERCADORIA, QTD_ATENDIDA, QTD_SALDO, CF_COD, CF_RSOCIAL	Quanto de cada item da DI ainda falta nacionalizar: a quantidade da DI menos a já atendida por nota fiscal de nacionalização. CF_COD é o fornecedor da adição.
CEI_VIEW_MOVIMENTOMERCADORIA (VIEW)	DIM_COD, MER_ID, FL_COD, CF_TIPO, FT_COD, PD_COD, PD_LOTE, ME_QTDEST, ME_ENT, LE_COD, TM_COD	Os movimentos de estoque vinculados a cada item da DI, um por item de nota fiscal: CF_TIPO = 'F' é entrada, 'C' é saída. Use para detalhar o saldo.

Exemplo — GET CEIDICAD (a DI do processo)

{
    "method": "GET"
    ,"objectType": "TABLE"
    ,"objectName": "CEIDICAD"
    ,"fields": [ "DIM_COD", "DIM_DATAFIMESTOQUE" ]
    ,"where": [
        { "type": "field", "name": "PIM_COD", "value": 215 }
    ]
}

Exemplo — GET CEI_VIEW_SALDOMERCADORIA

{
    "method": "GET"
    ,"objectType": "VIEW"
    ,"objectName": "CEI_VIEW_SALDOMERCADORIA"
    ,"fields": [ "MER_ID", "PD_COD", "PD_LOTE", "PD_DES", "QTD_ENTRADA", "QTD_SAIDA", "QTD_SALDO" ]
    ,"where": [
        // DIM_COD lido em CEIDICAD
        { "type": "field", "name": "DIM_COD", "value": 314 }
    ]
    ,"orderBy": [ "MER_ID" ]
}

Exemplo — GET CEI_VIEW_SALDOMERCADORIANACIONALIZACAO

{
    "method": "GET"
    ,"objectType": "VIEW"
    ,"objectName": "CEI_VIEW_SALDOMERCADORIANACIONALIZACAO"
    ,"fields": [ "MER_ID", "ADI_NUM", "PD_COD", "MER_QUANTIDADEMERCADORIA", "QTD_ATENDIDA", "QTD_SALDO" ]
    ,"where": [
        { "type": "field", "name": "DIM_COD", "value": 314 }
    ]
    ,"orderBy": [ "MER_ID" ]
}

CEI_VIEW_MOVIMENTOMERCADORIA recebe o mesmo corpo, trocando objectName e as colunas de fields pelas da tabela acima.

O financeiro do processo pode ser lido de três formas: pela rotina que a tela do processo usa, pelas tabelas de rateio e de títulos, ou pelas consultas de câmbio.

A consulta da tela: CEI_RES_FINANCEIROPROCESSO

É a consulta da aba Financeiro da tela do processo: os documentos rateados para o processo e, com CG_FT_USAPREVIAFIN = 1, as previsões ainda não efetivadas, em ordem de emissão, com crédito, débito, acumulados e saldo.

Parâmetro	Obrigatório	Descrição
P_PIM_COD	Sim	O processo.
P_TIPORESULT	Sim	0 todos os lançamentos; 1 só os marcados com débito ou crédito em conta corrente do processo.

Colunas principais: PIM_ORDEM (a ordem do lançamento no resultado), FIN_TIPO (1 previsão financeira, 2 documento), FL_COD, CF_TIPO (C receita, F despesa), FT_COD, FT_EMI, CF_COD, CF_RSOCIAL, PIM_VALMNACIO_CR, PIM_VALMNACIO_DB, PIM_VALMNACIO_CR_AC, PIM_VALMNACIO_DB_AC, PIM_SALDO, PIM_CUSTO, PIM_REEMBOLSO, TDP_DES e PAGO (PG quando o documento está totalmente pago). A chave do documento (FL_COD, CF_TIPO, FT_COD) vale nas linhas com FIN_TIPO = 2; nas de previsão, ainda não há documento. O saldo acumulado segue PIM_ORDEM: o saldo final do processo é o PIM_SALDO da linha de maior PIM_ORDEM.

{
    "method": "GET"
    ,"objectType": "PROCEDURE RESULT"
    ,"objectName": "CEI_RES_FINANCEIROPROCESSO"
    ,"params": [
        { "name": "P_PIM_COD",     "value": "215" }
        ,{ "name": "P_TIPORESULT", "value": "0" }
    ]
    ,"orderBy": [ "PIM_ORDEM" ]
}

As tabelas: rateio, documentos e títulos

• CEIPROCESRATEIO, com where em PIM_COD: um registro por documento e tipo financeiro, com a chave do documento (FL_COD, CF_TIPO, FT_COD), o valor atribuído ao processo em moeda nacional (PIM_VALMNACIO) e em moeda estrangeira (PIM_VALMDOLAR), a incidência no custo (PIM_CUSTO) e a conta corrente (PIM_REEMBOLSO). Exemplo no Passo 9.
• Com a chave do documento: DOCS (o documento), TITULO (as parcelas, com vencimento em TT_DVC, valor em TT_VAL e total baixado em TT_TOTVPG) e TITULO2 (as baixas).
• Documento rateado entre processos: a parte do processo é a proporção de PIM_VALMNACIO sobre a soma do rateio do documento. Aplique essa proporção às parcelas e às baixas.
• Previsões: CEIPROCESPREVISAO (com CG_FT_USAPREVIAFIN = 0) ou DOCSPREVISAO (com 1), filtrando por PIM_COD (Passo 5).

O câmbio: CEI_RES_DOCUMENTOCAMBIO, CEI_RES_BAIXACAMBIO e CEI_RES_VARIACAOCAMBIAL

As três trazem os títulos de contrato de câmbio rateados para processos que já têm DI: sem DI registrada, o processo não aparece. Nas duas primeiras, o título entra também só quando o rateio usa o tipo financeiro de câmbio (TDP_TIPODESPIMP = 100, Passo 1).

Rotina	Parâmetros	O que devolve
CEI_RES_DOCUMENTOCAMBIO	P_DT_INI e P_DT_FIM (período de vencimento, obrigatórios); P_FL_COD, P_PIM_COD, P_PIM_CLIPRO e P_CF_COD_FORNECEDOR (opcionais)	Cada parcela de câmbio, com o fator do processo no documento (FATOR_PROCESSO), o valor em moeda nacional e estrangeira (VALOR_TITULO, VALOR_TITULO_DOLAR), o pago (VALOR_TITULO_PAGO, VALOR_TITULO_PAGO_DOLAR), a situação (TIPO_CAMBIO: em aberto ou fechado), a cotação do dia (COTACAO_DO_DIA) e o saldo a pagar (VALOR_TITULO_A_PAGAR, VALOR_TITULO_A_PAGAR_DOLAR). Traz também PIM_CODINTERNO, DIM_NUMERODI, FT_NUM e TT_DVC.
CEI_RES_BAIXACAMBIO	Os mesmos; o período é o da baixa	As mesmas colunas, uma linha por baixa, mais a data (TT_DPG), o valor pago na baixa (VALOR_PAGO, VALOR_PAGO_DOLAR) e a cotação da baixa (TT_COTACAO_BAIXA).
CEI_RES_VARIACAOCAMBIAL	P_FL_COD, P_DT_INI e P_DT_FIM (obrigatórios); P_PIM_COD, P_PIM_CLIPRO e P_CF_COD_FORNECEDOR_DI (opcionais)	A variação cambial de cada pagamento de câmbio contra a cotação da DI: COTACAO_DI, COTACAO_TITULO2, PIM_TT_VALMNAC, PIM_TT_VALMNAC_COTACAO_DI, DATA_VARIACAO_CAMBIAL (a maior entre o registro da DI e o pagamento; é ela que o período filtra), VARIACAO_CAMBIAL_ATIVA e VARIACAO_CAMBIAL_PASSIVA.

{
    "method": "GET"
    ,"objectType": "PROCEDURE RESULT"
    ,"objectName": "CEI_RES_DOCUMENTOCAMBIO"
    ,"params": [
        // período de vencimento: espaço entre data e hora
        { "name": "P_DT_INI",  "value": "2026-01-01 00:00:00" }
        ,{ "name": "P_DT_FIM",  "value": "2026-12-31 23:59:59" }
        ,{ "name": "P_PIM_COD", "value": "215" }
    ]
}

CEI_RES_BAIXACAMBIO recebe o mesmo corpo, trocando objectName; ali, P_DT_INI e P_DT_FIM são o período da baixa. CEI_RES_VARIACAOCAMBIAL tem outra lista de parâmetros, com P_FL_COD obrigatório:

{
    "method": "GET"
    ,"objectType": "PROCEDURE RESULT"
    ,"objectName": "CEI_RES_VARIACAOCAMBIAL"
    ,"params": [
        { "name": "P_FL_COD",  "value": "1" }
        // período da data da variação cambial
        ,{ "name": "P_DT_INI",  "value": "2026-01-01 00:00:00" }
        ,{ "name": "P_DT_FIM",  "value": "2026-12-31 23:59:59" }
        ,{ "name": "P_PIM_COD", "value": "215" }
    ]
}

O fluxo de caixa do processo junta o realizado, que são as baixas já feitas, e o a vencer, que são as parcelas em aberto e as previsões. A rotina CEI_PRC_RES_RESULTADOFIN devolve as duas partes numa só lista, com o saldo acumulado do processo em cada linha. É a mesma consulta da aba Fluxo de Caixa da tela do processo.

Fluxo de caixa do processo: CEI_PRC_RES_RESULTADOFIN

Parâmetro	Descrição
P_PIM_COD	O processo. Com 0, todos os processos do cliente informado em P_PIM_CLIPRO.
P_PIM_CLIPRO	O cliente do processo. Com 0, sem filtro de cliente. Informe o processo ou o cliente: sem nenhum dos dois, o resultado vem vazio.
P_TIPORESULT	0 devolve o extrato, com todas as linhas. 1 devolve só a linha de fechamento de saldo (VLR_FLAG = 1); use-o com P_PIM_COD.

Cada linha é uma parcela de documento rateado para o processo, uma baixa dessa parcela ou uma previsão financeira. Os valores são a parte do processo no documento, na proporção do rateio (Passo 11). As linhas vêm em ordem de processo, grupo, data da baixa e vencimento, numeradas em PIM_ORDEM.

Coluna	Conteúdo
FIN_TIPO	2 parcela de documento; 1 previsão financeira. Na previsão, FT_COD é o número da previsão.
PIM_GRUPO	1 baixado; 2 vencido; 3 a vencer. As previsões são sempre do grupo 3.
PIM_COD, PIM_CODINTERNO, PIM_CLIPRO	O processo e o cliente dele.
FL_COD, CF_TIPO, FT_COD, TD_COD, TDP_COD, TDP_DES, CF_COD, CF_RSOCIAL	O documento, o tipo de despesa do processo e a pessoa do documento. CF_TIPO: C receita, F despesa.
TT_DVC, TT_DPG, BC_COD, FP_COD	Vencimento, data da baixa e a conta e a forma de pagamento da baixa.
VLR_CREDITO, VLR_DEBITO	O valor da linha. Nas baixas, o valor pago; nas parcelas em aberto e nas previsões, o valor em aberto.
VLR_CREDITOACM, VLR_DEBITOACM, VLR_SALDO	Crédito e débito acumulados e o saldo acumulado do processo até a linha (crédito menos débito).
VLR_CAIXA	1 quando a linha compôs o saldo. Entram no saldo as parcelas vencidas e a vencer, as previsões e, entre as baixas, as lançadas como disponível no fluxo e as de transferência de caixa. As demais baixas aparecem com VLR_CAIXA = 0 e não somam.
VLR_FLAG	1 na linha de fechamento de saldo: a última baixa antes dos lançamentos em aberto do processo ou, sem baixa seguida de lançamento em aberto, a última linha.

{
    "method": "GET"
    ,"objectType": "PROCEDURE RESULT"
    ,"objectName": "CEI_PRC_RES_RESULTADOFIN"
    ,"params": [
        { "name": "P_PIM_COD",    "value": "215" }
        ,{ "name": "P_PIM_CLIPRO", "value": "0" }
        // 0 = extrato completo; 1 = só a linha de fechamento de saldo
        ,{ "name": "P_TIPORESULT", "value": "0" }
    ]
    ,"orderBy": [ "PIM_ORDEM" ]
}

• Saldo do processo: é o VLR_SALDO da última linha, a de maior PIM_ORDEM. O saldo realizado é o da última linha do grupo 1.
• Previsões: entram as de DOCSPREVISAO do processo ainda não efetivadas em documento e com vencimento a partir de hoje. Existem quando a instância usa o controle de previsões financeiras (CG_FT_USAPREVIAFIN = 1; ver a central do módulo).
• Mais de uma linha chega como array, e o processo sem documentos nem previsões em aberto volta vazio (HTTP 404 com rowCount:0).

Por conta bancária: CEI_RES_EXTRATOBANCARIO_PROCESSO

É o extrato de uma conta (caixa ou banco) no período, com o processo de cada lançamento rateado. Os três parâmetros são obrigatórios: P_BC_COD (o código da conta, cadastrado na retaguarda), P_DT_INI e P_DT_FIM (período das baixas). A rotina não recebe o processo como parâmetro e não devolve PIM_COD: filtre o processo pelo resultado, com where em PIM_CODINTERNO. Por isso o processo precisa ter código interno. Com CG_PIM_SUGESTAOCODIGO = 0, envie-o na inclusão.

Colunas principais: VENCIMENTO, TT_DPG (data da baixa), VALOR_TOTPAGO_CRED, VALOR_TOTPAGO_DEB, DBCR, TIPOLANCA, PIM_CODINTERNO, CF_RSOCIAL_PROCESSO, TDP_DES e VFATOR.

• Documento rateado entre processos aparece uma vez para cada linha de rateio, com os valores já multiplicados pelo fator do processo (VFATOR).
• VALOR_SALDO é o saldo da conta, não o do processo. Nas linhas filtradas, as entradas do processo são a soma de VALOR_TOTPAGO_CRED, as saídas são a soma de VALOR_TOTPAGO_DEB, e o resultado do período é a diferença entre as duas. Só os lançamentos liberados (TIPOLANCA terminado em (LB)) movimentam o saldo da conta.

{
    "method": "GET"
    ,"objectType": "PROCEDURE RESULT"
    ,"objectName": "CEI_RES_EXTRATOBANCARIO_PROCESSO"
    ,"params": [
        { "name": "P_BC_COD",  "value": "1001" }
        ,{ "name": "P_DT_INI", "value": "2026-09-01 00:00:00" }
        ,{ "name": "P_DT_FIM", "value": "2026-09-30 23:59:59" }
    ]
    // o processo se filtra pelo resultado
    ,"where": [
        { "type": "field", "name": "PIM_CODINTERNO", "value": "IMP.0015/26" }
    ]
}

Use o extrato por conta quando a pergunta for “o que entrou e saiu desta conta, e de qual processo”; para o fluxo de um processo, use a CEI_PRC_RES_RESULTADOFIN.

O follow-up são as etapas de acompanhamento do processo, com as datas previstas e realizadas. A rotina CEI_RES_FOLLOWUP devolve as etapas já cadastradas no processo, com as datas calculadas e a situação de cada uma. As etapas são mantidas na retaguarda do ERP.

Parâmetro	Descrição
P_PIM_COD ou P_VD_COD	O processo ou o responsável pelas etapas. Informe um dos dois.
P_ETP_COD	Opcional. Filtra uma etapa.
P_ETP_PREV_DATACAL1, P_ETP_PREV_DATACAL2	Opcionais. Período da data de previsão calculada, com espaço entre data e hora.
P_PIM_CLIPRO	Opcional. Filtra pelo cliente do processo.
P_TIPO	Mantenha o padrão, 0.
pPCG_COD	Não envie: é de uso da Área do Cliente.

Colunas principais: PIM_COD, PIM_CODINTERNO, ETP_COD, ETP_ORD, ETP_DES, VD_NOM, ETP_PREV_DATACAL, ETP_REAL_DATACAL e ETP_STATUS (0 aberta, 1 prevista, 2 atrasada, 9 realizada).

{
    "method": "GET"
    ,"objectType": "PROCEDURE RESULT"
    ,"objectName": "CEI_RES_FOLLOWUP"
    ,"params": [
        { "name": "P_PIM_COD", "value": "215" }
    ]
    ,"orderBy": [ "ETP_ORD" ]
}

A exclusão pela API alcança o processo que não tem desdobramento de duplicatas, previsões financeiras, DI, títulos rateados, etapas de follow-up nem anexos. Quando o modelo cria esses registros na inclusão, ou quando o processo já avançou, a exclusão é feita na retaguarda do ERP.

Exclua com "method": "DELETE" sobre CEIPROCESCAD, com a chave completa: PIM_COD com "key": true.

{
    "method": "DELETE"
    ,"objectType": "TABLE"
    ,"objectName": "CEIPROCESCAD"
    ,"where": [
        { "type": "field", "name": "PIM_COD", "key": true, "value": 215 }
    ]
}

• O que sai junto: as provisões do processo (CEIPROCESPREVISAO) e o vínculo com a ordem de serviço de acompanhamento.
• O orçamento vinculado fica livre: CEIORC1.PIM_COD volta a nulo, e o orçamento pode gerar ou ser vinculado a outro processo.