AP Invoice API

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 4 min. de leitura
  • Este guia do desenvolvedor descreve como definir campos de fatura personalizados que não são fornecidos por padrão com o. Fatura do AP API para Processamento de faturas para contas a pagar. Também são fornecidas instruções para definir a autenticação ao usar cXML como carga útil.

    Você pode definir campos de fatura personalizados para o corpo da solicitação. Use o fluxo a seguir para adicionar campos personalizados, mapeá-los para tabelas de destino e formatá-los para disponibilidade na carga:
    1. Adicione campos personalizados para importação de fatura
    2. Mapeie campos personalizados entre tabelas de origem e de destino
    3. Mapeie campos personalizados para um formato de origem de carga útil

    Defina credenciais para cargas de cXML na tabela Credencial do sistema de origem [sn_sp_intg_source_system_credential]. Para obter instruções, consulte Definir credenciais para autenticação na carga do cXML.

    Adicione campos personalizados para importação de fatura

    Use o procedimento a seguir para adicionar campos personalizados para faturas, linhas de fatura e linhas de imposto de fatura a serem usados com o. Fatura do AP API.

    Antes de Iniciar

    • Função necessária: administrador
    • Escopo da aplicação:

    Procedimento

    1. Navegar até Tudo > Definição do Sistema > Tabelas.
    2. Selecione uma das seguintes tabelas de importação de faturas:
      • Importação de fatura [sn_spend_intg_imp_invoice]
      • Importação de linha de fatura [sn_spend_intg_imp_invoice_line]
      • Importação de linha de imposto da fatura [sn_spend_intg_imp_invoice_tax_line]
    3. Em Colunas da tabela , selecione Novo .
    4. Selecione um tipo associado ao valor do campo (por exemplo, Inteiro ) do Tipo menu.
      Nota:
      Para obter uma lista de tipos válidos, consulte Field types reference.
    5. Insira um nome significativo em Rótulo da coluna campo.
      O texto que inclui o rótulo é preenchido automaticamente no Nome da coluna campo.
    6. Selecione Salvar ou Enviar .
    7. Adicione uma coluna com o mesmo nome e tipo à tabela Fatura [sn_shop_invoice].
      Nota:
      Para obter mais informações sobre colunas e campos, consulte Exploring field administration.
    8. Mapeie os campos entre as tabelas de origem e de destino .

    Mapeie campos personalizados entre tabelas de origem e de destino

    Use o procedimento a seguir para mapear campos personalizados entre as tabelas de origem e de destino para a API AP Invoice.

    Antes de Iniciar

    • Função necessária: administrador
    • Escopo da aplicação:

    Crie colunas da tabela para mapear o novo campo da tabela de origem para a tabela de destino. Siga as etapas em Adicione campos personalizados para importação de fatura.

    Procedimento

    1. Navegar até Tudo > Conjuntos para importação do sistema > Mapas de transformação.
    2. Abra o Mapa de transformação da tabela Importação de fatura.
    3. Clique em Novo em Mapas de campo guia.
    4. Selecione o nome do campo personalizado em Campo de origem menu.
    5. Selecione o nome do campo personalizado em Campo de destino menu.
    6. Selecione Salvar ou Enviar .
    7. Mapeie campos personalizados para um formato de origem de carga útil.

    Mapeie campos personalizados para um formato de origem de carga útil

    Use o procedimento a seguir para mapear campos personalizados para uma entrada de carga em JSON, cXML ou XML para a API AP Invoice.

    Antes de Iniciar

    Procedimento

    1. Navegar até Tudo > Integrações de compras > Fornecedores > Mapeamentos de campos da integração da fatura.
    2. Selecione Novo.
    3. Adicione o nome do sistema de origem ao Sistema de origem campo.
      • Se este mapeamento de campo se aplicar a todos os sistemas de origem, insira Padrão .
      • Se o mapeamento for específico para um sistema de origem específico, esse valor deverá corresponder ao valor do parâmetro de cabeçalho Source-System recebido na API.
        Nota:
        Todos os mapeamentos de campo restantes devem ser configurados especificamente para este sistema de origem.
    4. Selecione o formato do sistema de origem para o qual o mapeamento está sendo criado a partir de Formato de origem Lista de seleção (cXML ou JSON).
    5. Forneça um nome (propriedade JSON) ou caminho (atributo ou elemento cXML/xml) para a entrada de carga no Campo de origem campo.
      Você pode exibir a tabela Mapeamento de campo de integração de fatura [sn_sp_intg_invoice_intg_field_mapping] para obter exemplos de configurações de caminho de cXML e XML.
    6. Adicione o nome de um atributo se o campo for definido como um atributo de elemento para cargas úteis do cXML, caso contrário, deixe o campo em branco.
    7. Selecione o nome da tabela de destino que contém seu campo personalizado no Tabela relacionada lista.
    8. Selecione o nome do campo personalizado em Campo de destino lista.
    9. Selecione Salvar ou Enviar .
      O campo mapeado é adicionado à tabela Mapeamento de campo de integração de fatura [sn_sp_intg_invoice_intg_field_mapping].

    Definir credenciais para autenticação na carga do cXML

    . sn_spend_intg/ap_invoice/cxml O endpoint é autenticado na carga usando credenciais armazenadas na tabela Credencial do sistema de origem [sn_sp_intg_source_system_credential].

    Antes de Iniciar

    Função necessária: administrador

    Identifique o sistema de origem de carga listado na tabela Mapeamentos de campo de integração de fatura [sn_sp_intg_invoice_intg_field_mapping].

    Consulte também Fatura do AP - PUBLICAR sn_sn_spend_intg/ap_invoice/cxml.

    Procedimento

    1. Navegar até Tudo > Integrações de compras > Credenciais do sistema de origem.
    2. Selecione Novo.
    3. Adicione o nome do sistema de origem listado na tabela Mapeamentos de campo de integração de fatura [sn_sp_intg_invoice_intg_field_mapping] em Sistema de origem campo.
      O nome do sistema de origem deve corresponder ao parâmetro de cabeçalho Source-System.
    4. Adicione o nome de usuário a ser obtido em Nome de usuário campo.
      Use este valor em /CXML/Header/To/Credential/Identity elemento.
    5. Adicione uma combinação forte de letras, números e caracteres especiais ao Senha campo.
      Use este valor em /CXML/Header/Sender/Credential/SharedSecret elemento.
    6. Selecione Enviar.