Guia do desenvolvedor da API de fatura do AP

Este guia do desenvolvedor descreve como definir campos de fatura personalizados que não são fornecidos por padrão com a API de fatura do AP 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.

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. Adicionar campos personalizados para importação de fatura
2. Mapear campos personalizados entre tabelas de origem e de destino
3. Mapear campos personalizados para um formato de origem de carga

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

Consulte também:

• Accounts Payable Invoice Processing
• API de fatura do AP

Adicionar 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 da fatura a serem usadas com a API de fatura do AP.

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 fatura:
   • 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. Na guia Colunas da tabela, selecione Novo.
4. Selecione um tipo associado ao valor do campo (por exemplo, Inteiro) no menu Tipo.
   Nota:

   Para obter uma lista de tipos válidos, consulte Field types reference.
5. Insira um nome significativo no campo Rótulo da coluna.
   O texto que inclui o rótulo é preenchido automaticamente no campo Nome da coluna.
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.

Mapear campos personalizados entre tabelas de origem e de destino

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

Antes de Iniciar

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

Crie colunas de tabela para mapear o novo campo da tabela de origem para a tabela de destino. Use as etapas em Adicionar 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 de importação de fatura.
3. Clique em Novo na guia Mapas de campo.
4. Selecione o nome do campo personalizado no menu Campo de origem.
5. Selecione o nome do campo personalizado no menu Campo de destino.
6. Selecione Salvar ou Enviar.
7. Mapear campos personalizados para um formato de origem de carga.

Mapear campos personalizados para um formato de origem de carga

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

Antes de Iniciar

• Função necessária: administrador
• Escopo da aplicação:
• Adicionar campos personalizados para importação de fatura
• Mapear campos personalizados entre tabelas de origem e de destino

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 campo Sistema de origem.
   • 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, este 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 na lista de seleção Formato de origem (cXML ou JSON).
5. Forneça um nome (propriedade JSON) ou caminho (atributo ou elemento cXML/XML) para a entrada de carga no campo Campo de origem.
   Você pode exibir a tabela Mapeamento do campo de integração de fatura [sn_spend_intg_invoice_intg_field_mapping] para obter exemplos de configurações de caminho cXML e XML.
6. Adicione o nome de um atributo se o campo for definido como um atributo de elemento para cargas cXML, caso contrário, deixe o campo em branco.
7. Selecione o nome da tabela de destino que contém seu campo personalizado na lista Tabela relacionada.
8. Selecione o nome do campo personalizado na lista Campo de destino.
9. Selecione Salvar ou Enviar.
   O campo mapeado é adicionado à tabela de mapeamento de campo de integração de fatura [sn_spend_intg_invoice_intg_field_mapping].

Como definir credenciais para autenticação na carga cXML

O endpoint sn_spend_intg/ap_invoice/cxml é autenticado na carga útil usando credenciais armazenadas na tabela Credencial do sistema de origem [sn_spend_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_spend_intg_invoice_intg_field_mapping].

Consulte também Fatura do AP – POST 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 do campo de integração de fatura [sn_spend_intg_invoice_intg_field_mapping] no campo Sistema de origem.
   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 no campo Nome de usuário.
   Use este valor no elemento /cXML/Header/To/Credential [@domain='NetworkID']/Identity.
5. Adicione uma combinação forte de letras, números e caracteres especiais ao campo Senha.
   Use este valor no elemento /cXML/Header/Sender/Credential [@domain='NetworkID']/SharedSecret.
6. Selecione Enviar.