API de fatura do AP

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 38 min. de leitura
  • Permite que sistemas externos, como aqueles usados por fornecedores, enviem faturas com segurança diretamente para um sistema de contas a pagar de forma estruturada e automatizada.

    Esta API requer a aplicação da loja Processamento de faturas para contas a pagar (com.sn_ap_apm), que é fornecida no namespace sn_spend_intg. Para obter informações, consulte Accounts Payable Invoice Processing.

    Consulte Guia do desenvolvedor da API de fatura do AP para obter ajuda com as seguintes tarefas:
    • Defina um campo personalizado para faturas, linhas de fatura e linhas de imposto da fatura.
    • Mapeie o campo personalizado entre tabelas de origem e de destino.
    • Mapeie o campo personalizado para uma entrada de carga em um formato específico, como JSON, cXML ou XML.
    • Definir credenciais para autenticação ao usar cXML como carga.
    Nota:
    O tamanho máximo da carga padrão é de 100 registros. Este valor é configurável na propriedade do sistema sn_spend_intg.ap.invoice.create.api.record_limit.

    Fatura do AP – POST sn_spend_intg/ap_invoice/cxml

    Processa uma fatura automatizada no formato XML de comércio (cXML).

    Use a tabela Mapeamentos de campo de integração de fatura [sn_spend_intg_invoice_intg_field_mapping] para determinar como os campos são mapeados para marcadores cXML.

    Para obter recursos adicionais do cXML, consulte o Guia de referência do cXML em https://xml.cxml.org.

    As credenciais desta API estão incluídas na carga útil. Você pode configurar as credenciais 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.

    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

    Formato da URL

    URL com controle de versão: /api/sn_spend_intg/v1/ap_invoice/cxml

    URL padrão: /api/sn_spend_intg/ap_invoice/cxml

    Parâmetros de solicitação compatíveis

    Tabela 1. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: cadeia de caracteres

    Tabela 2. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 3. Elementos do corpo da solicitação (cXML)
    Caminho Descrição
    /cXML/Cabeçalho/De /Credencial[@domain='VendorID']/Identidade Identificador do revendedor ou fornecedor com o qual o cliente pode fazer pedidos.

    Campo de destino: u_supplier

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    /cXML/Request/InvoiceDetailRequest /InvoiceDetailRequestHeader[@invoiceDate] Data em que o cliente foi faturado.

    Campo de destino: u_invoice_date

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Formato: AAAA-MM-DD

    /cXML/Solicitação/InvoiceDetailRequest /InvoiceDetailRequestHeader[@invoiceID] Número da fatura gerado a partir de uma aplicação de terceiros.

    Campo de destino: u_external_invoice_number

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    /cXML/Request/InvoiceDetailRequest /InvoiceDetailRequestHeader[@invoiceOrigin] Sistema de origem externa em que a fatura é recebida. Por exemplo, fornecedor.

    Campo de destino: u_inbound_source

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    /cXML/Solicitação/InvoiceDetailRequest /InvoiceDetailRequestHeader/InvoicePartner /Contact[@role='billTo']/PostalAddress/City A cidade para a qual a fatura será enviada.

    Campo de destino: u_bill_to_city

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    /cXML/Request/InvoiceDetailRequest /InvoiceDetailRequestHeader/InvoicePartner /Contact[@role='billTo']/PostalAddress/Country O país para o qual a fatura é enviada no formato ISO 3166. Por exemplo, US.

    Campo de destino: u_bill_to_country

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    /cXML/Request/InvoiceDetailRequest /InvoiceDetailRequestHeader/InvoicePartner /Contact[@role='billTo']/PostalAddress/State O estado ou a província para o qual a fatura é enviada.

    Campo de destino: u_bill_to_state_or_province

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    /cXML/Request/InvoiceDetailRequest /InvoiceDetailRequestHeader/InvoicePartner /Contact[@role='billTo']/PostalAddress/Street O endereço para o qual a fatura é enviada.

    Campo de destino: u_bill_to_street

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    /cXML/Solicitação/InvoiceDetailRequest /InvoiceDetailRequestHeader/InvoicePartner /Contact[@role='billTo']/PostalAddress/PostalCode O CEP ou código postal para o qual a fatura é enviada.

    Campo de destino: u_bill_to_zip_or_postal_code

    Contato[@role="remitTo"]/PostalAddress /Rua O endereço para o qual o pagamento é feito.

    Campo de destino: u_remit_address

    Contato[@role="remitTo"]/PostalAddress /Cidade A cidade para a qual o pagamento será feito.

    Campo de destino: u_remit_to_city

    Contato[@role="remitTo"]/PostalAddress /State O estado ou a província para o qual o pagamento é feito.

    Campo de destino: u_remit_to_state_or_province

    Contato[@role="remitTo"]/PostalAddress /PostalCode O CEP ou código postal para o qual o pagamento é feito.

    Campo de destino: u_remit_to_zip_or_postal_code

    Contato[@role="remitTo"]/PostalAddress /Country O país para o qual o pagamento é feito no formato ISO 3166. Por exemplo, US.

    Campo de destino: u_remit_to_country

    /cXML/Request/InvoiceDetailRequest/InvoiceDetailRequestHeader /InvoiceDetailShipping/Contact[@role="shipFrom"]/PostalAddress /Street Rua de onde os itens da ordem de compra são enviados.

    Campo de destino: u_ship_from_street

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    /cXML/Request/InvoiceDetailRequest/InvoiceDetailRequestHeader /InvoiceDetailShipping/Contact[@role="shipFrom"]/PostalAddress /City Cidade de onde os itens da ordem de compra são enviados.

    Campo de destino: u_ship_from_city

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    /cXML/Request/InvoiceDetailRequest/InvoiceDetailRequestHeader /InvoiceDetailShipping/Contact[@role="shipFrom"]/PostalAddress /State Estado do qual os itens da ordem de compra são enviados.

    Campo de destino: u_ship_from_state_or_province

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    /cXML/Request/InvoiceDetailRequest/InvoiceDetailRequestHeader /InvoiceDetailShipping/Contact[@role="shipFrom"]/PostalAddress /PostalCode CEP do qual os itens da ordem de compra são enviados.

    Campo de destino: u_ship_from_zip_or_postal_code

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    /cXML/Request/InvoiceDetailRequest/InvoiceDetailRequestHeader /InvoiceDetailShipping/Contact[@role="shipFrom"]/PostalAddress /Country País do qual os itens da ordem de compra são enviados.

    Campo de destino: u_ship_from_country

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    /cXML/Solicitação/InvoiceDetailRequest/InvoiceDetailRequestHeader /InvoicePartner/Contact[@role="billTo"] [@addressID] Nome da entidade jurídica do fornecedor. Localizado na tabela Entidade jurídica [sn_fin_legal_entity].

    Campo de destino: u_legal_entity

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Contato[@role="shipTo"]/Nome Nome do contato para o qual os itens da ordem de compra devem ser enviados.

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    Contato[@role="shipTo"]/PostalAddress /Rua Rua para a qual os itens da ordem de compra são enviados.

    Campo de destino: u_ship_to_street

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    Contato[@role="shipTo"]/PostalAddress /Cidade Cidade para a qual os itens da ordem de compra são enviados.

    Campo de destino: u_ship_to_city

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    Contato[@role="shipTo"]/PostalAddress /State Estado ou província para o qual os itens da ordem de compra são enviados.

    Campo de destino: u_ship_to_state_or_province

    Contato[@role="shipTo"]/PostalAddress /PostalCode CEP para o qual os itens da ordem de compra são enviados.

    Campo de destino: u_ship_to_zip_or_postal_code

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    Contato[@role="shipTo"]/PostalAddress /Country País para o qual os itens da ordem de compra são enviados.

    Campo de destino: u_ship_from_country

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    /cXML/Request/InvoiceDetailRequest /InvoiceDetailRequestHeader/PaymentTerm A hora e as condições acordadas sob as quais um pagamento a um fornecedor é feito. Por exemplo, Net 30.

    Campo de destino: u_payment_terms

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    /cXML/Request/InvoiceDetailRequest/InvoiceDetailOrder /InvoiceDetailItem[@description]/ Descrição da linha da fatura.

    Campo de destino: u_line_description

    /cXML/Solicitação/InvoiceDetailRequest/InvoiceDetailOrder /InvoiceDetailItem[@quantity]/ Quantidade de bens ou serviços pela qual um cliente está sendo faturado.

    Campo de destino: u_line_quantity

    /cXML/Solicitação/InvoiceDetailRequest/InvoiceDetailOrder /InvoiceDetailItem/Distribution/Contabilidade /AccountingSegment[1]/Nome Número da conta do centro de custos para o qual a fatura é gerada. Listado na tabela Centro de custos [cmn_cost_center].

    Campo de destino: u_cost_center

    /cXML/Solicitação/InvoiceDetailRequest/InvoiceDetailOrder /InvoiceDetailItem/Distribution/Contabilidade /AccountingSegment[2]/Nome Número da conta do razão geral (GL) usado para gerar a fatura.

    Campo de destino: u_gl_account

    Consulte também:
    /cXML/Solicitação/InvoiceDetailRequest/InvoiceDetailOrder /InvoiceDetailItem/SubtotalAmount/Money Valor total a ser pago ao fornecedor, excluindo impostos e taxas de envio.

    Campo de destino: u_subtotal

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    /cXML/Solicitação/InvoiceDetailRequest/InvoiceDetailOrder /InvoiceDetailItem/NetAmount/Money Custo total, excluindo impostos e envio, que um cliente está sendo faturado para uma determinada linha de ordem de compra.

    Campo de destino: u_line_amount_invoiced

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    /cXML/Solicitação/InvoiceDetailRequest/InvoiceDetailOrder /InvoiceDetailOrderInfo/OrderReference Número da ordem de compra fornecido pelo cliente para esta ordem. Listado na tabela Ordem de compra [sn_shop_purchase_order].

    Campo de destino: u_purchase_order

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    /cXML/Solicitação/InvoiceDetailRequest/InvoiceDetailOrder /InvoiceDetailItem/UnitPrice/UnitOfMeasure Unidade de medida base (UOM) usada para contar o item na fatura.

    Campo de destino: u_uom

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    /cXML/Solicitação/InvoiceDetailRequest/InvoiceDetailOrder /InvoiceDetailItem/UnitPrice/Money Preço unitário do item de linha na fatura.

    Campo de destino: u_line_unit_Price

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    /cXML/Solicitação/InvoiceDetailRequest/InvoiceDetailOrder /InvoiceDetailItem/UnitPrice/Money[@currency] Moeda do item de linha. Por exemplo, USD.

    Campo de destino: u_currency

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    cXML/Solicitação/InvoiceDetailRequest/InvoiceDetailOrder /InvoiceDetailItem /InvoiceDetailItemReference[@lineNumber] ID da linha da ordem de compra do fornecedor referenciado. Listado na tabela Linha da ordem de compra [sn_shop_purchase_order_line].

    Campo de destino: u_purchase_order_line

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    cXML/Solicitação/InvoiceDetailRequest/InvoiceDetailOrder /InvoiceDetailItem/InvoiceDetailItemReference /ItemID/FornecedorPartID Número de peça gerado por um fornecedor para esta linha de fatura.

    Campo de destino: u_supplier_part_number

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    cXML/Solicitação/InvoiceDetailRequest/InvoiceDetailOrder /InvoiceDetailItem/InvoiceDetailItemReference /Description Descrição da linha da ordem de compra da fatura.

    Campo de destino: u_po_line_description

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    cXML/Solicitação/InvoiceDetailRequest/InvoiceDetailOrder /InvoiceDetailItem/Imposto/Money Valor total de impostos cobrados pela compra.

    Campo de destino: u_tax_amount

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    cXML/Solicitação/InvoiceDetailRequest/InvoiceDetailOrder /InvoiceDetailItem/Imposto/Descrição Código de imposto exclusivo gerado a partir da origem do ERP.

    Campo de destino: u_tax_code

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    /cXML/Solicitação/InvoiceDetailRequest/ InvoiceDetailSummary /SubtotalAmount/Money Valor total a ser pago ao fornecedor, excluindo impostos e taxas de envio.

    Campo de destino: u_subtotal

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    /cXML/Solicitação/InvoiceDetailRequest/InvoiceDetailSummary /Imposto/Dinheiro Valor total de impostos cobrados pela compra.

    Campo de destino: u_tax_amount

    Tabela relacionada: importação de linha de imposto da fatura [sn_spend_intg_imp_invoice_tax_line]

    /cXML/Solicitação/InvoiceDetailRequest/InvoiceDetailSummary /Imposto/TaxDetail[@category] Tipo de imposto aplicável na fatura. Listado na tabela Tipo de imposto [sn_fin_tax_type].

    Campo de destino: u_tax_type

    Tabela relacionada: importação de linha de imposto da fatura [sn_spend_intg_imp_invoice_tax_line]

    /cXML/Solicitação/InvoiceDetailRequest/InvoiceDetailSummary /Imposto/TaxDetail[@percentageRate] A taxa de imposto cobrada pelo fornecedor.

    Tabela relacionada: importação de linha de imposto da fatura [sn_spend_intg_imp_invoice_tax_line]

    Campo de destino: u_supplier_tax_rate

    Tabela relacionada: importação de linha de imposto da fatura [sn_spend_intg_imp_invoice_tax_line]

    /cXML/Solicitação/InvoiceDetailRequest/InvoiceDetailSummary /SpecialHandlingAmount/Money Outras cobranças adicionais associadas à fatura. Este é um campo editável.

    Campo de destino: u_other_charges

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    /cXML/Solicitação/InvoiceDetailRequest/InvoiceDetailSummary /ShippingAmount/Money Custo total de envio para a compra inteira.

    Campo de destino: u_shipping_amount

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    /cXML/Solicitação/InvoiceDetailRequest/InvoiceDetailSummary /GrossAmount/Money Obrigatório. Moeda para subtotal, imposto e envio. O subtotal, o imposto e o envio devem estar na mesma moeda.

    Campo de destino: u_currency

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    /cXML/Solicitação/InvoiceDetailRequest/InvoiceDetailSummary /InvoiceDetailDiscount/Money Descontos aplicados à fatura.

    Campo de destino: u_discounts

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    /cXML/Solicitação/InvoiceDetailRequest/InvoiceDetailSummary /NetAmount/Money Valor total a ser pago ao fornecedor, incluindo impostos e taxas de envio.

    Campo de destino: u_amount_invoiced

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

    Tabela 4. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Tipo de conteúdo Formato de dados do corpo da solicitação. Oferece suporte somente a application/xml.
    Sistema de origem Especifica o sistema de origem de onde a solicitação é proveniente.

    Os sistemas disponíveis são listados na tabela Credenciais dos sistemas de origem [sn_spend_intg_source_system_credential].

    Esta configuração ajuda a determinar se a solicitação fornecida segue a estrutura na tabela Mapeamento do campo de integração de fatura [sn_spend_intg_invoice_intg_field_mapping].

    Esta configuração também é usada para buscar credenciais da tabela Credenciais do sistema de origem [sn_spend_intg_source_system_credential].

    Tabela 5. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

    Tabela 6. Códigos de status
    Código do status Descrição
    202 Solicitação aceita. A solicitação foi bem-sucedida e o processamento da fatura está em andamento.
    400 Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
    429 Excesso de solicitações. A taxa de solicitação excedeu o máximo de 10 solicitações por hora.

    Parâmetros do corpo da resposta

    Nome Descrição
    batch_id Identificador exclusivo da solicitação em lote. Este ID pode ser usado para rastrear o status da solicitação. Este registro é armazenado na tabela Log de integração de fatura [sn_spend_intg_invoice_integration_log].

    Tipo de dados: cadeia de caracteres

    erro Contém mensagem de erro e detalhes quando a solicitação falha.
    {
      "detail": String,
      "message": String
    }

    Tipo de dados: objeto

    erro.detalhe Detalhes adicionais sobre o erro de solicitação.
    Possíveis resultados:
    • Falha na validação da ACL de nível de API: o usuário não tem acesso de leitura/gravação ao recurso.
    • Limite de taxa de 13 solicitações por hora para fatura de AP excedido – O número de registros no lote é maior do que o tamanho do lote definido.
    • Necessário para fornecer informações de autenticação - a senha ou o nome de usuário está incorreto.

    Tipo de dados: cadeia de caracteres

    mensagem.erro Mensagem de erro que contém o motivo da falha na solicitação
    Possíveis erros:
    • Carga inválida - Tipo de conteúdo inválido.
    • Carga inválida - Erro: estrutura de carga inválida.
    • Carga inválida - Erro: a carga excede o limite de faturas permitidas em um lote. O número de registros no lote é maior do que o conjunto de tamanho de lote. O tamanho máximo da carga padrão é de 100 registros. Este valor é configurável na propriedade do sistema sn_spend_intg.ap.invoice.create.api.record_limit.
    • Carga inválida - Erro: faturas vazias. Não há dados para processar. O número de registros no lote é zero.
    • Limite de taxa de 500 solicitações por hora para ingestão de fatura de APO excedido.
    • Usuário não autenticado. A senha ou o nome de usuário está incorreto.
    • Falha na validação da ACL de nível de API: o usuário não tem acesso de leitura/gravação ao recurso.

    Tipo de dados: cadeia de caracteres

    mensagem Mensagem de sucesso, por exemplo, Sua solicitação foi recebida com sucesso e está sendo processada.

    Você pode exibir o status da solicitação na tabela Log de integração de fatura [sn_spend_intg_invoice_integration_log].

    Tipo de dados: cadeia de caracteres

    status Indica o resultado da solicitação.
    Valores possíveis:
    • Êxito
    • Falha

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo a seguir mostra como processar uma fatura fornecida como uma solicitação no formato cXML.

    curl -X POST https://instance.servicenow.com/api/sn_spend_intg/v1/ap_invoice/cxml \
    -H "Source-System: Ariba" \
    -H "Content-Type: application/json" \
    -d '{
        "content": "------=_Part_1367_1859161670.1709186492411\r\nContent-Type: text/xml; charset=UTF-8\r\n
    Content-ID: 1709186492411.10815535@produs-c4-an-s2-z3-1.us2.gcpint.ariba.com\r\n<?xml version=\"1.0\" 
    encoding=\"UTF-8\"?>\r\n<!DOCTYPE cXML SYSTEM \"https://protect-us.mimecast.com/s/fgKrCERVqQU35PNzBuw39pz?domain=xml.cxml.org\">
    \r\n<cXML timestamp=\"2024-02-28T22:01:32-08:00\" payloadID=\"1709186492411-3401013259654180284@10.209.37.74\">
    \r\n    <Response>\r\n        <Status code=\"200\" text=\"OK\" />\r\n        <DataResponse>\r\n            <Attachment>
    \r\n                <URL>186492411.10815535@produs-c4-an-s2-z3-1.us2.gcpint.ariba.com.110</URL>\r\n            </Attachment>
    \r\n            <Attachment>\r\n                <URL>1709186492403.306612238@produs-c4-an-s2-z3-1.us2.gcpint.ariba.com.108</URL>
    \r\n            </Attachment>\r\n        </DataResponse>\r\n    </Response>\r\n</cXML>\r\n------=_Part_1367_1859161670.1709186492411
    \r\nContent-Type: text/xml; charset=UTF-8\r\nContent-ID: 1709186492403.306612238@produs-c4-an-s2-z3-1.us2.gcpint.ariba.com.108
    \r\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n
    <!DOCTYPE cXML SYSTEM \"https://protect-us.mimecast.com/s/7QpfCG6VRKf15gQPwFpUTKe?domain=xml.cxml.org\">\r\n
    <cXML payloadID=\"1705930173863-1790846563502652473@10.209.37.98\" timestamp=\"2024-01-22T05:29:33-08:00\" version=\"1.2.060\">\r\n
        <Header>\r\n        <From>\r\n            <Credential domain=\"NetworkID\">\r\n                <Identity>AN01532216648-T</Identity>\r\n
                </Credential>\r\n            <Credential domain=\"VendorID\">\r\n                <Identity>3245545</Identity>\r\n
                </Credential>\r\n            <Credential domain=\"PrivateID\">\r\n                <Identity>0000099123</Identity>\r\n
                </Credential>\r\n        </From>\r\n        <To>\r\n            <Credential domain=\"NetworkID\">\r\n
                    <Identity>AN01404744424-T</Identity>\r\n            </Credential>\r\n            <Credential domain=\"SystemID\">\r\n
                    <Identity>ERP1</Identity>\r\n            </Credential>\r\n            <Credential domain=\"EndPointID\">\r\n
                    <Identity>CIG</Identity>\r\n            </Credential>\r\n        </To>\r\n        <Sender>\r\n
                <Credential domain=\"NetworkID\">\r\n                <Identity>AN01000000001</Identity>\r\n
                    <SharedSecret>Ariba@123</SharedSecret>\r\n            </Credential>\r\n            <UserAgent>Supplier</UserAgent>\r\n
            </Sender>\r\n    </Header>\r\n    <Request deploymentMode=\"test\">\r\n        <InvoiceDetailRequest>\r\n
                <InvoiceDetailRequestHeader invoiceDate=\"2024-01-22\" invoiceID=\"\" invoiceOrigin=\"supplier\" operation=\"new\ purpose=\"PO Invoice\">\r\n
                    <InvoiceDetailHeaderIndicator></InvoiceDetailHeaderIndicator>\r\n
                    <InvoiceDetailLineIndicator></InvoiceDetailLineIndicator>\r\n                <InvoicePartner>\r\n
                        <Contact addressID=\"Test123\" role=\"remitTo\">\r\n
                            <Name xml:lang=\"en-US\">Oil and Natural Gas Corporation Limited</Name>\r\n
                            <PostalAddress>\r\n                            <Street>Xyz street</Street>\r\n                            <City>USA</City>\r\n
                                <State isoStateCode=\"US-NY\">NY</State>\r\n                            <PostalCode>10001</PostalCode>\r\n
                                <Country isoCountryCode=\"US\">United States</Country>\r\n                        </PostalAddress>\r\n
                        </Contact>\r\n                </InvoicePartner>\r\n                <InvoicePartner>\r\n
                        <Contact addressID=\"9009\" role=\"billTo\">\r\n                        <Name xml:lang=\"EN\">Bristlecone Inc</Name>\r\n
                            <PostalAddress>\r\n                            <Street>10 Boulvard-10</Street>\r\n
                                <City>San Jose</City>\r\n                            <State>CA</State>\r\n
                                <PostalCode>94077</PostalCode>\r\n                            <Country isoCountryCode=\"US\"></Country>\r\n
                            </PostalAddress>\r\n                        <Phone>\r\n                            <TelephoneNumber>\r\n
                                    <CountryCode isoCountryCode=\"US\">1</CountryCode>\r\n                                <Number>7687687799</Number>\r\n
                                </TelephoneNumber>\r\n                        </Phone>\r\n                        <Fax>\r\n
                                <TelephoneNumber>\r\n                                <CountryCode isoCountryCode=\"US\">1</CountryCode>\r\n
                                    <Number>768-FAX-NUMBER</Number>\r\n                            </TelephoneNumber>\r\n                        </Fax>\r\n
                        </Contact>\r\n                </InvoicePartner>\r\n                <InvoicePartner>\r\n                    <Contact role=\"from\">\r\n
                            <Name xml:lang=\"en-US\">Oil and Natural Gas Corporation Limited</Name>\r\n                        <PostalAddress>\r\n
                                <Street>123 , street no 5</Street>\r\n                            <City>Dallas</City>\r\n
                                <State isoStateCode=\"US-AL\">AL</State>\r\n                            <PostalCode>36615</PostalCode>\r\n
                                <Country isoCountryCode=\"US\">United States</Country>\r\n                        </PostalAddress>\r\n
                        </Contact>\r\n                </InvoicePartner>\r\n                <InvoiceDetailShipping>\r\n
                        <Contact role=\"shipFrom\">\r\n                        <Name xml:lang=\"en-US\">Oil and Natural Gas Corporation Limited</Name>\r\n
                            <PostalAddress>\r\n                            <Street>Deendayal Urja Bhawan</Street>\r\n
                                <City>New Delhi</City>\r\n                            <State isoStateCode=\"IN-MH\">Maharashtra</State>\r\n
                                <PostalCode>110070</PostalCode>\r\n                            <Country isoCountryCode=\"IN\">India</Country>\r\n
                            </PostalAddress>\r\n                    </Contact>\r\n                    <Contact addressID=\"9999\" role=\"shipTo\">\r\n
                            <Name xml:lang=\"EN\">Buyer Plant Bristlecone</Name>\r\n                        <PostalAddress name=\"default\">\r\n
                                <Street>18 Hanoi Road</Street>\r\n                            <City>San Jose</City>\r\n
                                <State>CA</State>\r\n                            <PostalCode>77077</PostalCode>\r\n
                                <Country isoCountryCode=\"US\"></Country>\r\n                        </PostalAddress>\r\n
                            <Email name=\"default\" preferredLang=\"en\">test@test.com</Email>\r\n                    </Contact>\r\n
                    </InvoiceDetailShipping>\r\n            </InvoiceDetailRequestHeader>\r\n            <InvoiceDetailOrder>\r\n
                    <InvoiceDetailOrderInfo>\r\n                    <OrderReference orderID=\"\">\r\n
                            <DocumentReference payloadID=\"0AAF8EA1FA5F1EDE9FDC97460BCB03E1\"></DocumentReference>\r\n
                        </OrderReference>\r\n                </InvoiceDetailOrderInfo>\r\n
                    <InvoiceDetailItem invoiceLineNumber=\"2\" quantity=\"25\" description=\"Indian Oil\">\r\n
                        <UnitOfMeasure>EA</UnitOfMeasure>\r\n                    <UnitPrice>\r\n                        <Money currency=\"USD\">50</Money>\r\n
                        </UnitPrice>\r\n                    <SubtotalAmount>\r\n                        <Money currency=\"USD\">1250.00</Money>\r\n
                        </SubtotalAmount>\r\n                </InvoiceDetailItem>\r\n            </InvoiceDetailOrder>\r\n        </InvoiceDetailRequest>\r\n
        </Request>\r\n</cXML>\r\n------=_Part_1367_1859161670.1709186492411--"
    }'
    

    O resultado a seguir mostra que a solicitação foi bem-sucedida e que os dados da fatura estão sendo processados. Você pode exibir o status da solicitação na tabela Log de integração de fatura [sn_spend_intg_invoice_integration_log]. Use o ID do lote listado na coluna ID do lote para localizar a fatura.

    {
        "batchId": "APIINV1729711710733280",
        "status": "Success",
        "message": "Your request has been successfully received and is being processed."
    }

    Fatura do AP – POST sn_spend_intg/ap_invoice/json

    Processa uma fatura automatizada no formato JSON.

    Função necessária: sn_spend_intg.procurement_integrator

    Use a tabela Mapeamentos de campo de integração de fatura [sn_spend_intg_invoice_intg_field_mapping] para determinar como os campos são mapeados para propriedades JSON.

    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

    Formato da URL

    URL com controle de versão: /api/sn_spend_intg/v1/ap_invoice/json

    URL padrão: /api/sn_spend_intg/ap_invoice/json

    Parâmetros de solicitação compatíveis

    Tabela 7. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: cadeia de caracteres

    Tabela 8. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 9. Parâmetros do corpo da solicitação
    Nome Descrição
    faturas Lista que contém cada fatura a ser processada.

    Tipo de dados: objeto de objetos de fatura aninhados.

    "invoices": {
      {
        "amount_invoiced": "String",
        "bill_to_city": "String",
        "bill_to_country": "String",
        "bill_to_state_or_province": "String",
        "bill_to_street": "String",
        "bill_to_zip_or_postal_code": "String",
        "business_owner": "String",
        "currency": "String",
        "discounts": "String",
        "erp_number": "String",
        "external_invoice_number": "String",
        "invoice_date": "String",
        "invoice_line_count": "String",
        "invoice_lines": [Array],
        "invoice_type": "String",
        "legal_entity": "String",
        "original_invoice": "String",
        "other_charges": "String",
        "payment_terms": "String",
        "purchase_order": "String",
        "remit_address": "String",
        "remit_to_city": "String",
        "remit_to_country": "String",
        "remit_to_state_or_province": "String",
        "remit_to_zip_or_postal_code": "String",
        "ship_from_city": "String",
        "ship_from_country": "String",
        "ship_from_state_or_province": "String",
        "ship_from_street": "String",
        "ship_from_zip_or_postal_code": "String",
        "ship_to_city": "String",
        "ship_to_country": "String",
        "ship_to_state_or_province": "String",
        "ship_to_street": "String",
        "ship_to_zip_or_postal_code": "String",
        "shipping_amount": "String",
        "subtotal": "String",
        "supplier": "String",
        "supplier_invoice_number": "String",
        "supplier_tax_id": "String"
      }
    }
    faturas.valor_infacturado Valor total a ser pago ao fornecedor, incluindo impostos e taxas de envio.

    Campo de destino: u_amount_invoiced

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40

    faturamento_para_cidade A cidade para a qual a fatura será enviada.

    Campo de destino: u_bill_to_city

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    faturamento_para_país O país para o qual a fatura é enviada no formato ISO 3166. Por exemplo, US.

    Campo de destino: u_bill_to_country

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    fatura_para_estado_ou_província O estado ou a província para o qual a fatura é enviada.

    Campo de destino: u_bill_to_state_or_province

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    fatura_para_rua O endereço para o qual a fatura é enviada.

    Campo de destino: u_bill_to_street

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    bill_to_zip_or_postal_code O CEP ou código postal para o qual a fatura é enviada.

    Campo de destino: u_bill_to_zip_or_postal_code

    faturas.proprietário_negócio Nome do proprietário que possui a aplicação do lado comercial.

    Campo de destino: u_business_owner

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40

    faturas.moeda Obrigatório. Moeda para subtotal, imposto e envio. O subtotal, o imposto e o envio devem estar na mesma moeda.

    Campo de destino: u_currency

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40

    faturas.descontos Descontos aplicados à fatura.

    Campo de destino: u_discounts

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas.erp_number Número exclusivo gerado no sistema ERP (Enterprise Resource Planning) para a ordem de compra. Para obter informações, consulte Purchase order integration.

    Campo de destino: u_erp_number

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40

    faturas. external_invoice_number Obrigatório. Número da fatura gerado a partir de uma aplicação de terceiros.

    Campo de destino: u_external_invoice_number

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40

    faturas.invoice_date Obrigatório. Data em que o cliente foi faturado.

    Campo de destino: u_invoice_date

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40

    Formato: AAAA-MM-DD

    faturas.invoice_line_count Número de linhas na fatura.

    Campo de destino: u_invoice_line_count

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40

    faturas.invoice_lines Lista de objetos que define as linhas que estão sendo faturadas para compras neste pedido. As linhas de fatura são preparadas na tabela Importação de linha de fatura de entrada [sn_spend_intg_imp_invoice_line].

    Tipo de dados: matriz

    "invoice_lines": [
      {
        "cost_center": "String",
        "currency": "String",
        "external_invoice_number": "String",
        "gl_account": "String",
        "line_amount_invoiced": "String",
        "line_description": "String",
        "line_quantity": "String",
        "line_unit_price": "String",
        "po_line_description": "String",
        "purchase_order_line": "String",
        "ship_to_city": "String",
        "ship_to_country": "String",
        "ship_to_state_or_province": "String",
        "ship_to_street": "String",
        "ship_to_zip_or_postal_code": "String",
        "subtotal": "String",
        "supplier_part_number": "String",
        "tax_code": "String",
        "tax_details": [Array],
        "uom": "String"
      }
    ]
    faturas.invoice_lines. cost_center Número da conta do centro de custos para o qual a fatura é gerada. Listado na tabela Centro de custos [cmn_cost_center].

    Campo de destino: u_cost_center

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40

    faturas.invoice_lines. moeda Moeda do item de linha. Por exemplo, USD.

    Campo de destino: u_currency

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40

    faturas.invoice_lines. external_invoice_number Obrigatório. Número da fatura gerado a partir de uma aplicação de terceiros.

    Campo de destino: u_external_invoice_number

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40

    faturas.invoice_lines. conta_gl Número da conta do razão geral (GL) usado para gerar a fatura.

    Campo de destino: u_gl_account

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40

    Consulte também:
    faturas.invoice_lines. valor_de_linha_faturado Obrigatório. Custo total, excluindo impostos e envio, que um cliente está sendo faturado para uma determinada linha de ordem de compra.

    Campo de destino: u_line_amount_invoiced

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40

    faturas.invoice_lines. linha_descrição Obrigatório. Descrição da linha da fatura.

    Campo de destino: u_line_description

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40

    faturas.invoice_lines. quantidade_linha Obrigatório. Quantidade de bens ou serviços pela qual um cliente está sendo faturado.

    Campo de destino: u_line_quantity

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40

    faturas.invoice_lines. preço_de_unidade Preço unitário do item de linha na fatura.

    Campo de destino: u_line_unit_Price

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40

    faturas.invoice_lines. descrição_de_linha_po Descrição da linha da ordem de compra da fatura.

    Campo de destino: u_po_line_description

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas.invoice_lines. linha_de_ordem_de_compra Obrigatório. ID da linha da ordem de compra do fornecedor referenciado. Listado na tabela Linha da ordem de compra [sn_shop_purchase_order_line].

    Campo de destino: u_purchase_order_line

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40

    faturas.invoice_lines. enviar_para_cidade Cidade para a qual os itens da ordem de compra são enviados.

    Campo de destino: u_ship_to_city

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas.invoice_lines. enviar_para_país País para o qual os itens da ordem de compra são enviados.

    Campo de destino: u_ship_to_country

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas.invoice_lines. enviar_para_estado_ou_província Estado ou província para o qual os itens da ordem de compra são enviados.

    Campo de destino: u_ship_to_state_or_province

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas.invoice_lines. envio_para_rua Rua para a qual os itens da ordem de compra são enviados.

    Campo de destino: u_ship_to_street

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas.invoice_lines. envio_para_zip_ou_código_postal CEP para o qual os itens da ordem de compra são enviados.

    Campo de destino: u_ship_to_zip_or_postal_code

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas.invoice_lines. subtotal Obrigatório. Valor total a ser pago ao fornecedor, excluindo impostos e taxas de envio.

    Campo de destino: u_subtotal

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas.invoice_lines. fornecedor_part_number Obrigatório. Número de peça gerado por um fornecedor para esta linha de fatura.

    Campo de destino: u_supplier_part_number

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas.invoice_lines. tax_code Código de imposto exclusivo gerado a partir da origem do ERP.

    Campo de destino: u_tax_code

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas.invoice_lines. tax_details Lista de linhas de imposto para compras associadas à linha da fatura.

    Tipo de dados: matriz de objetos

    "tax_details": [
      {
        "tax_amount": "String",
        "tax_rate": "String",
        "tax_type": "String"
      }
    ]
    faturas.invoice_lines. detalhes_imposto.valor_imposto Obrigatório. Valor total de impostos cobrados pela compra.

    Campo de destino: u_tax_amount

    Tabela relacionada: importação de linha de imposto da fatura [sn_spend_intg_imp_invoice_tax_line]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40

    faturas.invoice_lines. detalhes_imposto.taxa_taxa A taxa de imposto cobrada pelo fornecedor.

    Campo de destino: u_supplier_tax_rate

    Tabela relacionada: importação de linha de imposto da fatura [sn_spend_intg_imp_invoice_tax_line]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas.invoice_lines. tax_details.tax_type Tipo de imposto aplicável na fatura. Listado na tabela Tipo de imposto [sn_fin_tax_type].

    Campo de destino: u_tax_type

    Tabela relacionada: importação de linha de imposto da fatura [sn_spend_intg_imp_invoice_tax_line]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas.invoice_lines.uom Unidade de medida base (UOM) usada para contar o item na fatura.

    Campo de destino: u_uom

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas.invoice_type Tipo de fatura para processamento.

    Campo de destino: u_invoice_type

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas.legal_entity Nome da entidade jurídica do fornecedor. Localizado na tabela Entidade jurídica [sn_fin_legal_entity].

    Campo de destino: u_legal_entity

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas.original_invoice Número de fatura exclusivo criado pelo fornecedor.

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Campo de destino: u_original_invoice

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas.outros_encargos Outras cobranças adicionais associadas à fatura. Este é um campo editável.

    Campo de destino: u_other_charges

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas.pagamento_terms A hora e as condições acordadas sob as quais um pagamento a um fornecedor é feito. Por exemplo, Net 30.

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas.compra_ordem Obrigatório. Número da ordem de compra fornecido pelo cliente para esta ordem. Listado na tabela Ordem de compra [sn_shop_purchase_order].

    Campo de destino: u_purchase_order

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40

    faturas.remit_address Obrigatório. O endereço para o qual o pagamento é feito.

    Campo de destino: u_remit_address

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas.remeter_para_cidade Obrigatório. A cidade para a qual o pagamento será feito.

    Campo de destino: u_remit_to_city

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas.remeter_para_país Obrigatório. O país para o qual o pagamento é feito no formato ISO 3166. Por exemplo, US.

    Campo de destino: u_remit_to_country

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas. remeter_para_estado_ou_província Obrigatório. O estado ou a província para o qual o pagamento é feito.

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas. remeter_para_zip_ou_código_postal Obrigatório. O CEP ou código postal para o qual o pagamento é feito.

    Campo de destino: u_remit_to_state_or_province

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas.envio_de_cidade Cidade de onde os itens da ordem de compra são enviados.

    Campo de destino: u_ship_from_city

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas.enviar_do_país País do qual os itens da ordem de compra são enviados.

    Campo de destino: u_ship_from_country

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas. enviar_de_estado_ou_província Estado do qual os itens da ordem de compra são enviados.

    Campo de destino: u_ship_from_state_or_province

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas.envio_da_rua Rua de onde os itens da ordem de compra são enviados.

    Campo de destino: u_ship_from_street

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas. envio_de_zip_ou_código_postal CEP do qual os itens da ordem de compra são enviados.

    Campo de destino: u_ship_from_zip_or_postal_code

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas.envio_para_cidade Cidade para a qual os itens da ordem de compra são enviados.

    Campo de destino: u_ship_to_city

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas.envio_para_país País para o qual os itens da ordem de compra são enviados.

    Campo de destino: u_ship_to_country

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas. enviar_para_estado_ou_província Estado para o qual os itens da ordem de compra são enviados.

    Campo de destino: u_ship_to_state_or_province

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas.envio_para_rua Rua para a qual os itens da ordem de compra são enviados.

    Campo de destino: u_ship_to_street

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas. envio_para_zip_ou_código_postal CEP para o qual os itens da ordem de compra são enviados.

    Campo de destino: u_ship_to_zip_or_postal_code

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas.envio_valor Obrigatório. Custo total de envio para a compra inteira.

    Campo de destino: u_shipping_amount

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40

    faturas.subtotal Obrigatório. Valor total a ser pago ao fornecedor, excluindo impostos e taxas de envio.

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 40

    faturas.fornecedor Obrigatório. Identificador do revendedor ou fornecedor com o qual o cliente pode fazer pedidos.

    Campo de destino: u_supplier

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas. fornecedor_invoice_number Obrigatório. Número de identificação gerado por um fornecedor para esta fatura.

    Campo de destino: u_supplier_invoice_number

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas.supplier_tax_id Identificador de imposto associado ao revendedor terceirizado. Este é um campo editável.

    Campo de destino: u_supplier_tax_id

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Tipo de dados: cadeia de caracteres

    Tamanho máximo: 100

    faturas.target_erp Registro do ERP no qual a fatura é publicada. Localizado na tabela Origem do ERP [sn_fin_erp_source]. Consulte ERP source.

    Tipo de dados: cadeia de caracteres

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

    Tabela 10. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Tipo de conteúdo Formato de dados do corpo da solicitação. Oferece suporte somente a application/json.
    Sistema de origem Especifica o sistema de origem de onde a solicitação é proveniente.

    Esta configuração ajuda a determinar se a solicitação fornecida segue a estrutura na tabela Mapeamento do campo de integração de fatura [sn_spend_intg_invoice_intg_field_mapping].

    Tabela 11. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

    Tabela 12. Códigos de status
    Código do status Descrição
    202 Solicitação aceita. A solicitação foi bem-sucedida e o processamento da fatura está em andamento.
    400 Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
    429 Excesso de solicitações. A taxa de solicitação excedeu o máximo de 10 solicitações por hora.

    Parâmetros do corpo da resposta

    Nome Descrição
    batch_id Identificador exclusivo da solicitação em lote. Este ID pode ser usado para rastrear o status da solicitação. Este registro é armazenado na tabela Log de integração de fatura [sn_spend_intg_invoice_integration_log].

    Tipo de dados: cadeia de caracteres

    erro Contém mensagem de erro e detalhes quando a solicitação falha.
    {
      "detail": String,
      "message": String
    }

    Tipo de dados: objeto

    erro.detalhe Detalhes adicionais sobre o erro de solicitação.
    Possíveis resultados:
    • Falha na validação da ACL de nível de API: o usuário não tem acesso de leitura/gravação ao recurso.
    • Limite de taxa de 13 solicitações por hora para fatura de AP excedido – O número de registros no lote é maior do que o tamanho do lote definido.
    • Necessário para fornecer informações de autenticação - a senha ou o nome de usuário está incorreto.

    Tipo de dados: cadeia de caracteres

    mensagem.erro Mensagem de erro que contém o motivo da falha na solicitação
    Possíveis erros:
    • Carga inválida - Tipo de conteúdo inválido.
    • Carga inválida - Erro: estrutura de carga inválida.
    • Carga inválida - Erro: a carga excede o limite de faturas permitidas em um lote. O número de registros no lote é maior do que o conjunto de tamanho de lote. O tamanho máximo da carga padrão é de 100 registros. Este valor é configurável na propriedade do sistema sn_spend_intg.ap.invoice.create.api.record_limit.
    • Carga inválida - Erro: faturas vazias. Não há dados para processar. O número de registros no lote é zero.
    • Limite de taxa de 500 solicitações por hora para ingestão de fatura de APO excedido.
    • Usuário não autenticado. A senha ou o nome de usuário está incorreto.
    • Falha na validação da ACL de nível de API: o usuário não tem acesso de leitura/gravação ao recurso.

    Tipo de dados: cadeia de caracteres

    mensagem Mensagem de sucesso, por exemplo, Sua solicitação foi recebida com sucesso e está sendo processada.

    Você pode exibir o status da solicitação na tabela Log de integração de fatura [sn_spend_intg_invoice_integration_log].

    Tipo de dados: cadeia de caracteres

    status Indica o resultado da solicitação.
    Valores possíveis:
    • Êxito
    • Falha

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo a seguir mostra como processar uma fatura fornecida como uma solicitação no formato JSON.

    curl "https://instance.servicenow.com/api/sn_spend_intg/v1/ap_invoice/json" \
    --request \
     POST \
    --header \
     "Source-System: Coupa" \
    --header \
     "Content-Type: application/json" \
    --user 'username' \
    :'password' \
    --data \
     '{
        "invoices": [
            {
                "invoice_type": "non_po_invoice",
                "supplier_invoice_number": "SPOTLIGHT98",
                "external_invoice_number": "SPOTLIGHT98",
                "erp_number": "RTest12345",
                "purchase_order": "R0030R16537",
                "business_owner": "paula.smith@example.com",
                "supplier": "3245545",
                "original_invoice": "SIN188191",
                "invoice_date": "2023-08-15",
                "payment_terms": "Net 30",
                "legal_entity": "1000",
                "subtotal": "100.00",
                "shipping_amount": "50.00",
                "other_charges": "20.00",
                "discounts": "100.00",
                "amount_invoiced": "150.00",
                "currency": "USD",
                "invoice_line_count": "2",
                "ship_to_city": "",
                "ship_to_country": "USA",
                "ship_to_state_or_province": "NY",
                "ship_to_street": "123 Main St",
                "ship_to_zip_or_postal_code": "10001",
                "ship_from_city": "Los Angeles",
                "ship_from_country": "USA",
                "ship_from_state_or_province": "CA",
                "ship_from_street": "456 Oak Ave",
                "ship_from_zip_or_postal_code": "90001",
                "remit_address": "789 Elm St, Suite 200",
                "remit_to_city": "Chicago",
                "remit_to_country": "USA",
                "remit_to_state_or_province": "IL",
                "remit_to_zip_or_postal_code": "60601",
                "bill_to_city": "San Diego",
                "bill_to_country": "USA",
                "bill_to_state_or_province": "CA",
                "bill_to_street": "4810 Eastgate Mall",
                "bill_to_zip_or_postal_code": "92121",
                "supplier_tax_id": "123456789",
                "tax_details": [
                    {
                        "tax_type": "Central Goods and Services Tax",
                        "tax_amount": "25",
                        "tax_rate": ""
                    },
                    {
                        "tax_type": "Sales tax",
                        "tax_amount": "10",
                        "tax_rate": "10"
                    },
                    {
                        "tax_type": "IGST",
                        "tax_amount": "",
                        "tax_rate": "15"
                    },
                    {
                        "tax_type": "State Goods and Service Tax",
                        "tax_amount": "20",
                        "tax_rate": "10"
                    }
                ],
                "invoice_lines": [
                    {
                        "external_invoice_number": "SPOTLIGHT98",
                        "line_description": "Laptop",
                        "line_quantity": "5",
                        "line_unit_price": "20.00",
                        "subtotal": "100.00",
                        "line_amount_invoiced": "100.00",
                        "purchase_order_line": "232432",
                        "po_line_description": "Mac laptop",
                        "currency": "USD",
                        "cost_center": "41605600",
                        "gl_account": "141101",
                        "tax_code": "A0 - Sales tax, standard rate",
                        "ship_to_city": "New York",
                        "ship_to_country": "USA",
                        "ship_to_state_or_province": "NY",
                        "ship_to_street": "123 Main St",
                        "ship_to_zip_or_postal_code": "10001",
                        "supplier_part_number": "SPN-001",
                        "uom": "Hours",
                        "tax_details": [
                            {
                                "tax_type": "Central Goods and Services Tax",
                                "tax_amount": "25",
                                "tax_rate": ""
                            },
                            {
                                "tax_type": "Sales tax",
                                "tax_amount": "",
                                "tax_rate": "10"
                            }
                        ]
                    },
                    {
                        "external_invoice_number": "SPOTLIGHT98",
                        "line_description": "Charger",
                        "line_quantity": "5",
                        "line_unit_price": "40.00",
                        "subtotal": "200.00",
                        "line_amount_invoiced": "200.00",
                        "purchase_order_line": "232432",
                        "po_line_description": "Mac laptop",
                        "currency": "USD",
                        "cost_center": "41605600",
                        "gl_account": "141101",
                        "tax_code": "A0 - Sales tax, standard rate",
                        "ship_to_city": "New York",
                        "ship_to_country": "USA",
                        "ship_to_state_or_province": "NY",
                        "ship_to_street": "123 Main St",
                        "ship_to_zip_or_postal_code": "10001",
                        "supplier_part_number": "SPN-001",
                        "uom": "Hours",
                        "tax_details": [
                            {
                                "tax_type": "Central Goods and Services Tax",
                                "tax_amount": "25",
                                "tax_rate": ""
                            },
                            {
                                "tax_type": "Sales tax",
                                "tax_amount": "",
                                "tax_rate": "10"
                            }
                        ]
                    }
                ]
            }
        ],
        "target_erp": ""
    }'

    O resultado a seguir mostra que a solicitação foi bem-sucedida e que os dados da fatura estão sendo processados. Você pode exibir o status da solicitação na tabela Log de integração de fatura [sn_spend_intg_invoice_integration_log]. Use o ID do lote listado na coluna ID do lote para localizar a fatura.

    {
        "batchId": "APIINV1729711710733280",
        "status": "Success",
        "message": "Your request has been successfully received and is being processed."
    }

    Fatura do AP – POST sn_spend_intg/ap_invoice/xml

    Processa uma fatura automatizada no formato XML.

    Use a tabela Mapeamentos de campo de integração de fatura [sn_spend_intg_invoice_intg_field_mapping] para determinar como os campos são mapeados para marcadores XML.

    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

    Formato da URL

    URL com controle de versão: /api/sn_spend_intg/v1/ap_invoice/xml

    URL padrão: /api/sn_spend_intg/ap_invoice/xml

    Parâmetros de solicitação compatíveis

    Tabela 13. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessada. Por exemplo, v1 ou v2. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: cadeia de caracteres

    Tabela 14. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 15. Elementos do corpo da solicitação (XML)
    Caminho Descrição
    /Fatura/Valor faturado Valor total a ser pago ao fornecedor, incluindo impostos e taxas de envio.

    Campo de destino: u_amount_invoiced

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Fatura/BillToCity A cidade para a qual a fatura será enviada.

    Campo de destino: u_bill_to_city

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    /Fatura/Faturar para país O país para o qual a fatura é enviada no formato ISO 3166. Por exemplo, US.

    Campo de destino: u_bill_to_country

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    /Fatura/BillToStateOrProvince O estado ou a província para o qual a fatura é enviada.

    Campo de destino: u_bill_to_state_or_province

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    /Fatura/CobrançaParaStreet O endereço para o qual a fatura é enviada.

    Campo de destino: u_bill_to_street

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    /Fatura/BillToZipOrPostalCode O CEP ou código postal para o qual a fatura é enviada.

    Campo de destino: u_bill_to_zip_or_postal_code

    /Fatura/Moeda Obrigatório. Moeda para subtotal, imposto e envio. O subtotal, o imposto e o envio devem estar na mesma moeda.

    Campo de destino: u_currency

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    /Invoice/DateFormat Define o formato de data da fatura do AAAA-MM-DD padrão para outro formato de data compatível. O valor de data é definido no elemento InvoiceDate.
    Formatos de data compatíveis:
    • DD MMM AAAA
    • DD MMM, AA
    • DD MMM, AAAA
    • DD MMMM AAAA
    • DD MMMM, AA
    • DD MMMM, AAAA
    • DD-MM-AA
    • DD-MM-AAAA
    • DD-MMM-AA
    • DD-MMM-AAAA
    • DD.MM.AA
    • DD.MM.AAAA
    • DD/MM/AA
    • DD/MM/AAAA
    • dd/mmm/aaaa
    • MM-DD-AA
    • MM-DD-AAAA
    • MM.DD.AA
    • MM.DD.AAAA
    • DD/MM/AA
    • MM/DD/AAAA
    • MMM DD AAAA
    • MMM DD, AA
    • MMM DD, AAAA
    • MMMM DD AAAA
    • MMMM DD, AA
    • MMMM DD, AAAA
    • AA-MM-DD
    • AA.MM.DD
    • AA/MM/DD
    • AAAA-MM-DD (padrão)
    • AAAA.MM.DD
    • AAAA/MM/DD
    Nota:
    A entrada no formato MMM representa um mês em suas três primeiras letras, por exemplo, Ago. A entrada no formato MMMM representa o nome completo do mês, por exemplo, agosto.

    Campo de destino: u_date_format

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Formato padrão: AAAA-MM-DD

    /Fatura/Descontos Descontos aplicados à fatura.

    Campo de destino: u_discounts

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    /Invoice/ExternalInvoiceNumber Número da fatura gerado a partir de uma aplicação de terceiros.

    Campo de destino: u_external_invoice_number

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    /Invoice/InvoiceDate Data em que o cliente foi faturado. Use o elemento DateFormat para adicionar a data em um formato não padrão compatível.

    Campo de destino: u_invoice_date

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    Formato padrão: AAAA-MM-DD

    /Fatura/Entidade jurídica Nome da entidade jurídica do fornecedor. Localizado na tabela Entidade jurídica [sn_fin_legal_entity].

    Campo de destino: u_legal_entity

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    /Fatura/OutrosCobranças Outras cobranças adicionais associadas à fatura. Este é um campo editável.

    Campo de destino: u_other_charges

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    /Fatura/Termos de pagamento A hora e as condições acordadas sob as quais um pagamento a um fornecedor é feito. Por exemplo, Net 30.

    Campo de destino: u_payment_terms

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    /Invoice/RemitAddress O endereço para o qual o pagamento é feito.

    Campo de destino: u_remit_address

    Fatura/RemitToCity A cidade para a qual o pagamento será feito.

    Campo de destino: u_remit_to_city

    /Fatura/RemitToCountry O país para o qual o pagamento é feito no formato ISO 3166. Por exemplo, US.

    Campo de destino: u_remit_to_country

    /Fatura/RemitToStateOrProvince O estado ou a província para o qual o pagamento é feito.

    Campo de destino: u_remit_to_state_or_province

    /Fatura/RemitToZipOrPostalCode O CEP ou código postal para o qual o pagamento é feito.

    Campo de destino: u_remit_to_zip_or_postal_code

    /Fatura/Cidade de envio Cidade de onde os itens da ordem de compra são enviados.

    Campo de destino: u_ship_from_city

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    /Fatura/PaísDeEnvio País do qual os itens da ordem de compra são enviados.

    Campo de destino: u_ship_from_country

    Tabela relacionada: linha de fatura [sn_spend_intg_imp_invoice]

    /Fatura/ShipFromStateOrProvince Estado do qual os itens da ordem de compra são enviados.

    Campo de destino: u_ship_from_state_or_province

    Tabela relacionada: linha de fatura [sn_spend_intg_imp_invoice]

    /Fatura/ShipFromStreet Rua de onde os itens da ordem de compra são enviados.

    Campo de destino: u_ship_from_street

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    /Fatura/ShipFromZipOrPostalCode CEP do qual os itens da ordem de compra são enviados.

    Campo de destino: u_ship_from_zip_or_postal_code

    Tabela relacionada: linha de fatura [sn_spend_intg_imp_invoice]

    /Invoice/ShippingAmount Custo total de envio para a compra inteira.

    Campo de destino: u_shipping_amount

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    /Fatura/Subtotal Valor total a ser pago ao fornecedor, excluindo impostos e taxas de envio.

    Campo de destino: u_subtotal

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    /Fatura/Fornecedor Identificador do revendedor ou fornecedor com o qual o cliente pode fazer pedidos.

    Campo de destino: u_supplier

    Tabela relacionada: importação de fatura [sn_spend_intg_imp_invoice]

    /LinhaDeFatura/CentroDeCustos Número da conta do centro de custos para o qual a fatura é gerada. Listado na tabela Centro de custos [cmn_cost_center].

    Campo de destino: u_cost_center

    /InvoiceLine/Currency Moeda do item de linha. Por exemplo, USD.

    Campo de destino: u_currency

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    /InvoiceLine/GLAccount Número da conta do razão geral (GL) usado para gerar a fatura.

    Campo de destino: u_gl_account

    Consulte também:
    /InvoiceLine/LineAmountInvoiced Custo total, excluindo impostos e envio, que um cliente está sendo faturado para uma determinada linha de ordem de compra.

    Campo de destino: u_line_amount_invoiced

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    /InvoiceLine/LineDescription Descrição da linha da fatura.

    Campo de destino: u_line_description

    /InvoiceLine/LineQuantity Quantidade de bens ou serviços pela qual um cliente está sendo faturado.

    Campo de destino: u_line_quantity

    /InvoiceLine/LineUnitPrice Preço unitário do item de linha na fatura.

    Campo de destino: u_line_unit_Price

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    /InvoiceLine/POlineDescription Descrição da linha da ordem de compra da fatura.

    Campo de destino: u_po_line_description

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    /InvoiceLine/PurchaseOrderLine Número da ordem de compra fornecido pelo cliente para esta ordem. Listado na tabela Ordem de compra [sn_shop_purchase_order].

    Campo de destino: u_purchase_order

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    /InvoiceLine/Envio para cidade Cidade para a qual os itens da ordem de compra são enviados.

    Campo de destino: u_ship_to_city

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    /InvoiceLine/ShipToCountry País para o qual os itens da ordem de compra são enviados.

    Campo de destino: u_ship_to_country

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    /InvoiceLine/ShipToStateOrProvince Estado ou província para o qual os itens da ordem de compra são enviados.

    Campo de destino: u_ship_to_state_or_province

    /InvoiceLine/ShipToStreet Rua para a qual os itens da ordem de compra são enviados.

    Campo de destino: u_ship_to_street

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    /InvoiceLine/ShipToZipOrPostalCode CEP para o qual os itens da ordem de compra são enviados.

    Campo de destino: u_ship_to_zip_or_postal_code

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    /InvoiceLine/Subtotal Valor total a ser pago ao fornecedor, excluindo impostos e taxas de envio.

    Campo de destino: u_subtotal

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    /InvoiceLine/FornecedorPartNumber Número de peça gerado por um fornecedor para esta linha de fatura.

    Campo de destino: u_supplier_part_number

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    /InvoiceLine/TaxCode Código de imposto exclusivo gerado a partir da origem do ERP.

    Campo de destino: u_tax_code

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    /Linha da fatura/UOM Unidade de medida base (UOM) usada para contar o item na fatura.

    Campo de destino: u_uom

    Tabela relacionada: importação de linha de fatura [sn_spend_intg_imp_invoice_line]

    /TaxDetail/TaxType Tipo de imposto aplicável na fatura. Listado na tabela Tipo de imposto [sn_fin_tax_type].

    Campo de destino: u_tax_type

    Tabela relacionada: importação de linha de imposto da fatura [sn_spend_intg_imp_invoice_tax_line]

    /TaxDetail/TaxRate A taxa de imposto cobrada pelo fornecedor.

    Tabela relacionada: importação de linha de imposto da fatura [sn_spend_intg_imp_invoice_tax_line]

    Campo de destino: u_supplier_tax_rate

    Tabela relacionada: importação de linha de imposto da fatura [sn_spend_intg_imp_invoice_tax_line]

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.

    Tabela 16. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Tipo de conteúdo Formato de dados do corpo da solicitação. Oferece suporte somente a application/xml.
    Sistema de origem Especifica o sistema de origem de onde a solicitação é proveniente.

    Os sistemas disponíveis são listados na tabela Credenciais dos sistemas de origem [sn_spend_intg_source_system_credential].

    Esta configuração ajuda a determinar se a solicitação fornecida segue a estrutura na tabela Mapeamento do campo de integração de fatura [sn_spend_intg_invoice_intg_field_mapping].

    Esta configuração também é usada para buscar credenciais da tabela Credenciais do sistema de origem [sn_spend_intg_source_system_credential].

    Tabela 17. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

    Tabela 18. Códigos de status
    Código do status Descrição
    202 Solicitação aceita. A solicitação foi bem-sucedida e o processamento da fatura está em andamento.
    400 Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
    429 Excesso de solicitações. A taxa de solicitação excedeu o máximo de 10 solicitações por hora.

    Parâmetros do corpo da resposta

    Nome Descrição
    batch_id Identificador exclusivo da solicitação em lote. Este ID pode ser usado para rastrear o status da solicitação. Este registro é armazenado na tabela Log de integração de fatura [sn_spend_intg_invoice_integration_log].

    Tipo de dados: cadeia de caracteres

    erro Contém mensagem de erro e detalhes quando a solicitação falha.
    {
      "detail": String,
      "message": String
    }

    Tipo de dados: objeto

    erro.detalhe Detalhes adicionais sobre o erro de solicitação.
    Possíveis resultados:
    • Falha na validação da ACL de nível de API: o usuário não tem acesso de leitura/gravação ao recurso.
    • Limite de taxa de 13 solicitações por hora para fatura de AP excedido – O número de registros no lote é maior do que o tamanho do lote definido.
    • Necessário para fornecer informações de autenticação - a senha ou o nome de usuário está incorreto.

    Tipo de dados: cadeia de caracteres

    mensagem.erro Mensagem de erro que contém o motivo da falha na solicitação
    Possíveis erros:
    • Carga inválida - Tipo de conteúdo inválido.
    • Carga inválida - Erro: estrutura de carga inválida.
    • Carga inválida - Erro: a carga excede o limite de faturas permitidas em um lote. O número de registros no lote é maior do que o conjunto de tamanho de lote. O tamanho máximo da carga padrão é de 100 registros. Este valor é configurável na propriedade do sistema sn_spend_intg.ap.invoice.create.api.record_limit.
    • Carga inválida - Erro: faturas vazias. Não há dados para processar. O número de registros no lote é zero.
    • Limite de taxa de 500 solicitações por hora para ingestão de fatura de APO excedido.
    • Usuário não autenticado. A senha ou o nome de usuário está incorreto.
    • Falha na validação da ACL de nível de API: o usuário não tem acesso de leitura/gravação ao recurso.

    Tipo de dados: cadeia de caracteres

    mensagem Mensagem de sucesso, por exemplo, Sua solicitação foi recebida com sucesso e está sendo processada.

    Você pode exibir o status da solicitação na tabela Log de integração de fatura [sn_spend_intg_invoice_integration_log].

    Tipo de dados: cadeia de caracteres

    status Indica o resultado da solicitação.
    Valores possíveis:
    • Êxito
    • Falha

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo a seguir mostra como processar uma fatura fornecida como uma solicitação no formato XML.

    curl -X POST https://instance.servicenow.com/api/sn_spend_intg/v1/ap_invoice/xml \
    -H "Source-System: Ariba" \
    -H "Content-Type: application/json" \
    -d '<Invoices>
        <Invoice>
            <InvoiceType>invoice</InvoiceType>
            <SupplierInvoiceNumber>S-432432425</SupplierInvoiceNumber>
            <ExternalInvoiceNumber>EXT-INV-003</ExternalInvoiceNumber>
            <Supplier>3245545</Supplier>
            <PurchaseOrder>0004511198</PurchaseOrder>
            <BusinessOwner>Paula Smith</BusinessOwner>
            <InvoiceDate>2023-09-02</InvoiceDate>
            <PaymentTerms>Net 60</PaymentTerms>
            <OriginalInvoice></OriginalInvoice>
            <LegalEntity></LegalEntity>
            <Subtotal>23985.00</Subtotal>
            <ShippingAmount>750.00</ShippingAmount>
            <OtherCharges></OtherCharges>
            <Discounts></Discounts>
            <AmountInvoiced>27073.54</AmountInvoiced>
            <Currency>USD</Currency>
            <InvoiceLineCount>2</InvoiceLineCount>
            <ShipToCity>Los Angeles</ShipToCity>
            <ShipToCountry>USA</ShipToCountry>
            <ShipToStateOrProvince>CA</ShipToStateOrProvince>
            <ShipToStreet>456 Oak Ave</ShipToStreet>
            <ShipToZipOrPostalCode>90001</ShipToZipOrPostalCode>
            <ShipFromCity>Addison</ShipFromCity>
            <ShipFromCountry>USA</ShipFromCountry>
            <ShipFromStateOrProvince>TX</ShipFromStateOrProvince>
            <ShipFromStreet>15725 Dallas P</ShipFromStreet>
            <ShipFromZipOrPostalCode>55555</ShipFromZipOrPostalCode>
            <RemitAddress>47 W 11th St</RemitAddress>
            <RemitToCity>New York</RemitToCity>
            <RemitToCountry>USA</RemitToCountry>
            <RemitToStateOrProvince>NY</RemitToStateOrProvince>
            <RemitToZipOrPostalCode>99999</RemitToZipOrPostalCode>
            <BillToStreet>4810 Eastgate Mall</BillToStreet>
            <BillToCity>San Diego</BillToCity>
            <BillToCountry>USA</BillToCountry>
            <BillToStateOrProvince>CA</BillToStateOrProvince>
            <BillToZipOrPostalCode>92121</BillToZipOrPostalCode>
            <SupplierTaxID>7894328742</SupplierTaxID>
            <TaxDetails>
                <TaxDetail>
                    <TaxType>CGST</TaxType>
                    <TaxAmount></TaxAmount>
                    <TaxRate>15</TaxRate>
                </TaxDetail>
                <TaxDetail>
                    <TaxType>SGST</TaxType>
                    <TaxAmount>100</TaxAmount>
                    <TaxRate></TaxRate>
                </TaxDetail>
            </TaxDetails>
            <InvoiceLines>
                <InvoiceLine>
                    <ExternalInvoiceNumber>EXT-INV-002</ExternalInvoiceNumber>
                    <LineDescription>NowX Laptop</LineDescription>
                    <PurchaseOrderLine></PurchaseOrderLine>
                    <LineQuantity>15</LineQuantity>
                    <LineUnitPrice>1500.00</LineUnitPrice>
                    <Subtotal>22500.00</Subtotal>
                    <LineAmountInvoiced>24693.75</LineAmountInvoiced>
                    <Currency>USD</Currency>
                    <CostCenter></CostCenter>
                    <GLAccount></GLAccount>
                    <TaxCode></TaxCode>
                    <ShipToCity></ShipToCity>
                    <ShipToCountry></ShipToCountry>
                    <ShipToStateOrProvince></ShipToStateOrProvince>
                    <ShipToStreet></ShipToStreet>
                    <ShipToZipOrPostalCode></ShipToZipOrPostalCode>
                    <SupplierPartNumber></SupplierPartNumber>
                    <UOM>Individual Unit</UOM>
                    <TaxDetails>
                        <TaxDetail>
                            <TaxType>WHTTax</TaxType>
                            <TaxAmount>2193.75</TaxAmount>
                            <TaxRate>9.75</TaxRate>
                        </TaxDetail>
                    </TaxDetails>
                </InvoiceLine>
                <InvoiceLine>
                    <ExternalInvoiceNumber>EXT-INV-002</ExternalInvoiceNumber>
                    <LineDescription>NowX Charger</LineDescription>
                    <PurchaseOrderLine>PO-6789-001</PurchaseOrderLine>
                    <LineQuantity>15</LineQuantity>
                    <LineUnitPrice>99.00</LineUnitPrice>
                    <Subtotal>1485.00</Subtotal>
                    <LineAmountInvoiced>1629.79</LineAmountInvoiced>
                    <Currency>USD</Currency>
                    <CostCenter></CostCenter>
                    <GLAccount></GLAccount>
                    <TaxCode></TaxCode>
                    <ShipToCity></ShipToCity>
                    <ShipToCountry></ShipToCountry>
                    <ShipToStateOrProvince></ShipToStateOrProvince>
                    <ShipToStreet></ShipToStreet>
                    <ShipToZipOrPostalCode></ShipToZipOrPostalCode>
                    <SupplierPartNumber></SupplierPartNumber>
                    <UOM>Individual Unit</UOM>
                    <TaxDetails>
                        <TaxDetail>
                            <TaxType>GSTTax</TaxType>
                            <TaxAmount>144.79</TaxAmount>
                            <TaxRate>9.75</TaxRate>
                        </TaxDetail>
                        <TaxDetail>
                            <TaxType>CGST</TaxType>
                            <TaxAmount>1000</TaxAmount>
                            <TaxRate>12</TaxRate>
                        </TaxDetail>
                    </TaxDetails>
                </InvoiceLine>
            </InvoiceLines>
        </Invoice>
        <Invoice>
            <InvoiceType>invoice</InvoiceType>
            <SupplierInvoiceNumber>S-432432426</SupplierInvoiceNumber>
            <ExternalInvoiceNumber>EXT-INV-006</ExternalInvoiceNumber>
            <Supplier>3245545</Supplier>
            <PurchaseOrder>0004511198</PurchaseOrder>
            <BusinessOwner>Paula Smith</BusinessOwner>
            <InvoiceDate>2023-09-02</InvoiceDate>
            <PaymentTerms>Net 60</PaymentTerms>
            <OriginalInvoice></OriginalInvoice>
            <LegalEntity></LegalEntity>
            <Subtotal>23985.00</Subtotal>
            <ShippingAmount>750.00</ShippingAmount>
            <OtherCharges></OtherCharges>
            <Discounts></Discounts>
            <AmountInvoiced>27073.54</AmountInvoiced>
            <Currency>USD</Currency>
            <InvoiceLineCount>2</InvoiceLineCount>
            <ShipToCity>Los Angeles</ShipToCity>
            <ShipToCountry>USA</ShipToCountry>
            <ShipToStateOrProvince>CA</ShipToStateOrProvince>
            <ShipToStreet>456 Oak Ave</ShipToStreet>
            <ShipToZipOrPostalCode>90001</ShipToZipOrPostalCode>
            <ShipFromCity>Addison</ShipFromCity>
            <ShipFromCountry>USA</ShipFromCountry>
            <ShipFromStateOrProvince>TX</ShipFromStateOrProvince>
            <ShipFromStreet>15725 Dallas P</ShipFromStreet>
            <ShipFromZipOrPostalCode>55555</ShipFromZipOrPostalCode>
            <RemitAddress>47 W 11th St</RemitAddress>
            <RemitToCity>New York</RemitToCity>
            <RemitToCountry>USA</RemitToCountry>
            <RemitToStateOrProvince>NY</RemitToStateOrProvince>
            <RemitToZipOrPostalCode>99999</RemitToZipOrPostalCode>
            <BillToStreet>4810 Eastgate Mall</BillToStreet>
            <BillToCity>San Diego</BillToCity>
            <BillToCountry>USA</BillToCountry>
            <BillToStateOrProvince>CA</BillToStateOrProvince>
            <BillToZipOrPostalCode>92121</BillToZipOrPostalCode>
            <SupplierTaxID>7894328742</SupplierTaxID>
            <TaxDetails>
                <TaxDetail>
                    <TaxType>VATTax</TaxType>
                    <TaxAmount>2338.54</TaxAmount>
                    <TaxRate></TaxRate>
                </TaxDetail>
            </TaxDetails>
            <InvoiceLines>
                <InvoiceLine>
                    <ExternalInvoiceNumber>EXT-INV-002</ExternalInvoiceNumber>
                    <LineDescription>NowX Laptop</LineDescription>
                    <PurchaseOrderLine></PurchaseOrderLine>
                    <LineQuantity>15</LineQuantity>
                    <LineUnitPrice>1500.00</LineUnitPrice>
                    <Subtotal>22500.00</Subtotal>
                    <LineAmountInvoiced>24693.75</LineAmountInvoiced>
                    <Currency>USD</Currency>
                    <CostCenter></CostCenter>
                    <GLAccount></GLAccount>
                    <TaxCode></TaxCode>
                    <ShipToCity></ShipToCity>
                    <ShipToCountry></ShipToCountry>
                    <ShipToStateOrProvince></ShipToStateOrProvince>
                    <ShipToStreet></ShipToStreet>
                    <ShipToZipOrPostalCode></ShipToZipOrPostalCode>
                    <SupplierPartNumber></SupplierPartNumber>
                    <UOM>Individual Unit</UOM>
                    <TaxDetails>
                    </TaxDetails>
                </InvoiceLine>
                <InvoiceLine>
                    <ExternalInvoiceNumber>EXT-INV-002</ExternalInvoiceNumber>
                    <LineDescription>NowX Charger</LineDescription>
                    <PurchaseOrderLine>PO-6789-001</PurchaseOrderLine>
                    <LineQuantity>15</LineQuantity>
                    <LineUnitPrice>99.00</LineUnitPrice>
                    <Subtotal>1485.00</Subtotal>
                    <LineAmountInvoiced>1629.79</LineAmountInvoiced>
                    <Currency>USD</Currency>
                    <CostCenter></CostCenter>
                    <GLAccount></GLAccount>
                    <TaxCode></TaxCode>
                    <ShipToCity></ShipToCity>
                    <ShipToCountry></ShipToCountry>
                    <ShipToStateOrProvince></ShipToStateOrProvince>
                    <ShipToStreet></ShipToStreet>
                    <ShipToZipOrPostalCode></ShipToZipOrPostalCode>
                    <SupplierPartNumber></SupplierPartNumber>
                    <UOM>Individual Unit</UOM>
                    <TaxDetails>
                    </TaxDetails>
                </InvoiceLine>
            </InvoiceLines>
        </Invoice>
        <TargetERP>ERP1</TargetERP>
    </Invoices>'
    

    O resultado a seguir mostra que a solicitação foi bem-sucedida e que os dados da fatura estão sendo processados. Você pode exibir o status da solicitação na tabela Log de integração de fatura [sn_spend_intg_invoice_integration_log]. Use o ID do lote listado na coluna ID do lote para localizar a fatura.

    {
        "batchId": "APIINV1736249646168148",
        "status": "Success",
        "message": "Your request has been successfully received and is being processed."
    }