Histórico da Página

...

Produto:

Solucoes_totvs_cross

SolucaoCross	TOTVS Backoffice

Linha de Produto:

Linhas_totvs

Linha	Linha Logix

Segmento:

Segmentos_totvs

Segmento	Backoffice

Módulo:

Modulos_cross_segmentos

ModulosCrossSegmentos	TOTVS Backoffice (Linha Logix) - Recebimento

Função:

Request - API de Ordem de Compra

País:

Brasil

Ticket:

23767700

Requisito/Story/Issue (informe o requisito relacionado) :

DBACKRECENT-7693

02. SITUAÇÃO/REQUISITO

Inexiste documentação para Documento de API de Criação Ordem de Compra para nova versão não atualizado.

03. SOLUÇÃO

Criar documentação Documentação para API de Criação de Ordem de Compra criada.

04. DEMAIS INFORMAÇÕES

Método:

...

(200) - Registro Incluído com Sucesso

Parâmetros	Tipo	Descrição	Tabela/Coluna
_expandables	string[]
_expandables.ListOfItemGrids	-
_expandables.ListOfItemGrids	-
TypeNumber	string	Tipo Ordem Compra
CompanyId	string	Código Empresa	ordem_sup.cod_empresa
UserCode	string	Código Usuário
RequestInternalId	string	ID	ordem_sup.cod_empresa\|ordem_sup.num_oc\|
Number	decimal	Número Ordem de Compra	ordem_sup.num_oc
Type	string	Situação Ordem Compra	ordem_sup.ies_situa_oc
RequesterUserCode	decimal	Cod. Programador	ordem_sup.cod_progr
BuyerUserCode	decimal	Cod. Comprador	ordem_sup.cod_comprador
RegisterDateTime	date	Data Emissão	ordem_sup.dat_emis
DeliveryDateTime	date	Data Entrega Prevista	ordem_sup.dat_entrega_prev
PaymentConditionCode	decimal	Condição Pagameto	ordem_sup.cnd_pgto
ListOfRequestItem._expandables	-		-
ListOfRequestItem._expandables.ListOfItemGrids	-		-
ListOfRequestItem._expandables.ListOfMaterialOrder	-		-
ListOfRequestItem.	-		-
ListOfRequestItem.InternalId	string	ID	ordem_sup.cod_empresa\|ordem_sup.num_oc\|
ListOfRequestItem.Text	string	Texto Observação	ordem_sup_txt.tex_observ_oc
ListOfRequestItem.Application	string	Texto Aplicação	ordem_sup_txt.tex_observ_oc
ListOfRequestItem.ExpenseControlGroup	decimal	Grupo Controle de Despesa	ordem_sup.gru_ctr_desp
ListOfRequestItem.InputTarget	string	Ind. Esp. Objeto Entrada	grupo_ctr_desp.ies_obj_entrada
ListOfRequestItem.ItemCode	string	Código Item	ordem_sup.cod_item
ListOfRequestItem.StockControl	string	Indicador Controle Estoque	ordem_sup.ies_item_estoq
ListOfRequestItem.UnitPrice	decimal	Preço Unit. Ordem Compra	ordem_sup.pre_unit_oc
ListOfRequestItem.Quantity	decimal	Qtd Solicitação	ordem_sup.qtd_solic
ListOfRequestItem.QuantityReached	decimal	Qts Recebida	ordem_sup.qtd_recebida
ListOfRequestItem.ReceiverSectionCode	string	Cod. Seção Recebedora	ordem_sup.cod_secao_receb
ListOfRequestItem.Observation	string	Obs. Ordem Compra	ordem_sup_txt.tex_observ_oc
ListOfRequestItem.UnitOfMeasureCode	string	Cod. Unidade Medida	ordem_sup.cod_unid_med
ListOfRequestItem.ListOfDeliverySchedule	-		-
ListOfRequestItem.ListOfDeliverySchedule.DeliveryID	decimal	Num. Programa Entrega	prog_ordem_sup.num_prog_entrega
ListOfRequestItem.ListOfDeliverySchedule.EstimatedDeliveryDate	date	Data Entrega Prevista	prog_ordem_sup.dat_entrega_prev
ListOfRequestItem.ListOfDeliverySchedule.QuantityRequested	decimal	Qtd Solicitada	prog_ordem_sup.qtd_solic
ListOfRequestItem.ListOfDeliverySchedule.AmountReceived	decimal	Qtd Recebida	prog_ordem_sup.qtd_recebida
ListOfRequestItem.ListOfDeliverySchedule.Observation	string	Texto Observação	prog_ordem_sup.tex_observacao
ListOfRequestItem.ListOfApportionRequestItem	-	-	-
ListOfRequestItem.ListOfApportionRequestItem.InternalId	string	ID	dest_ordem_sup.cod_empresa\|dest_ordem_sup.num_oc\|dest_ordem_sup.num_conta_deb_desp\|dest_ordem_sup.cod_secao_receb\|
ListOfRequestItem.ListOfApportionRequestItem.ReceiverSectionCode	string	Cod. Seção Recebedora	dest_ordem_sup.cod_secao_receb
ListOfRequestItem.ListOfApportionRequestItem.CostCenterCode	string	Cod. Centro Custo	dest_ordem_sup.num_conta_deb_desp[1,4]
ListOfRequestItem.ListOfApportionRequestItem.AccountantAcountCode	string	Num. Conta Débito Despesa	dest_ordem_sup.num_conta_deb_desp
ListOfRequestItem.ListOfApportionRequestItem.BusinessAreaCode	decimal	Cod. Área Negócio	dest_ordem_sup.cod_area_negocio
ListOfRequestItem.ListOfApportionRequestItem.BusinessLineCode	decimal	Cod. Linha Negócio	dest_ordem_sup.cod_lin_negocio
ListOfRequestItem.ListOfApportionRequestItem.MarketSegmentCode	decimal	Cod. Segmento Mercado	dest_ordem_sup4.cod_seg_merc
ListOfRequestItem.ListOfApportionRequestItem.ClassUseCode	decimal	Cod. Classe Uso	dest_ordem_sup4.cod_cla_uso
ListOfRequestItem.ListOfApportionRequestItem.Quantity	decimal	Qtd Participação Compra	dest_ordem_sup.qtd_particip_comp
ListOfRequestItem.ListOfApportionRequestItem.Percent	decimal	Percent. Participação Compra	dest_ordem_sup.pct_particip_comp
ListOfRequestItem.ListOfApportionRequestItem.DocumentNumber	string	Num. Documento	dest_ordem_sup.num_docum

Exemplo:

{
    ""_expandables"": [
        ""ListOfItemGrids"",
        ""ListOfMaterialOrder""
    ],
    ""TypeNumber"": ""D"",
    ""CompanyId"": ""01"",
    ""UserCode"": ""admlog"",
    ""RequestInternalId"": ""01|3005350|"",
    ""Number"": ""3005350"",
    ""Type"": ""A"",
    ""RequesterUserCode"": ""999"",
    ""BuyerUserCode"": "" 999"",
    ""RegisterDateTime"": ""2025-07-21"",
    ""DeliveryDateTime"": ""2025-07-22"",
    ""PaymentConditionCode"": """",
    ""ListOfRequestItem"": [
        {
            ""_expandables"": [
                ""ListOfItemGrids"",
                ""ListOfMaterialOrder""
            ],
            ""InternalId"": ""01|3005350|"",
            ""Text"": ""teste texto complementar 111111111111111111"",
            ""Application"": ""texto aplicacao"",
            ""ExpenseControlGroup"": ""1"",
            ""InputTarget"": ""8"",
            ""ItemCode"": ""CANETA"",
            ""StockControl"": ""N"",
            ""UnitPrice"": "",000000"",
            ""Quantity"": ""10,000"",
            ""QuantityReached"": "",000"",
            ""ReceiverSectionCode"": ""100000"",
            ""Observation"": ""texto observaçao"",
            ""UnitOfMeasureCode"": ""UN"",
            ""ListOfDeliverySchedule"": [
                {
                    ""DeliveryID"": ""   1"",
                    ""EstimatedDeliveryDate"": ""2025-07-23"",
                    ""QuantityRequested"": ""3,000"",
                    ""AmountReceived"": "",000"",
                    ""Observation"": """"
                },
                {
                    ""DeliveryID"": ""   2"",
                    ""EstimatedDeliveryDate"": ""2025-08-25"",
                    ""QuantityRequested"": ""7,000"",
                    ""AmountReceived"": "",000"",
                    ""Observation"": """"
                }
            ],
            ""ListOfApportionRequestItem"": [
                {
                    ""InternalId"": ""01|3005350|99990353|100000|"",
                    ""ReceiverSectionCode"": ""100000"",
                    ""CostCenterCode"": ""9999"",
                    ""AccountantAcountCode"": ""99990353"",
                    ""BusinessAreaCode"": ""  0"",
                    ""BusinessLineCode"": ""  0"",
                    ""MarketSegmentCode"": """",
                    ""ClassUseCode"": """",
                    ""Quantity"": ""            5"",
                    ""Percent"": ""         50"",
                    ""DocumentNumber"": ""0""
                },
                {
                    ""InternalId"": ""01|3005350|99990353|100000|"",
                    ""ReceiverSectionCode"": ""100000"",
                    ""CostCenterCode"": ""9999"",
                    ""AccountantAcountCode"": ""99990353"",
                    ""BusinessAreaCode"": ""  0"",
                    ""BusinessLineCode"": ""  0"",
                    ""MarketSegmentCode"": """",
                    ""ClassUseCode"": """",
                    ""Quantity"": ""            5"",
                    ""Percent"": ""         50"",
                    ""DocumentNumber"": ""0""
                }
            ]
        }
    ]
}

...

( 400 ) - Erro Ao processar Inclusão Ordem de Compra

Parâmetros	Tipo	Descrição
code	string	Código do Erro
message	string	Mensagem de Erro
detailMessade	string	Detalhe Mensagem de Erro

Exemplo:

{
    ""code"": ""400"",
    ""message"": ""Erro durante a inclusão da ordem de compra."",
    ""detailMessage"": ""Data de entrega não é data útil.""
}

...

Páginas filhas

Versões comparadas

Versão antiga 2

Nova versão Atual

Chave

02. SITUAÇÃO/REQUISITO

03. SOLUÇÃO

04. DEMAIS INFORMAÇÕES

Método: