AP Invoice API

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

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

    Consulte AP Invoice API do desenvolvedorpara obter ajuda com as seguintes tarefas:
    • Defina um campo personalizado para faturas, linhas de fatura e linhas de imposto de fatura.
    • Mapeie o campo personalizado entre as 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.
    • Definindo 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 no sn_spend_intg.ap.invoice.create.api.record_limitpropriedade do sistema.

    Fatura de AP – PUBLICAR sn_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 recursos cXML adicionais, consulte Guia de referência do cXML em https://xml.cxml.org .

    As credenciais desta API estão incluídas na carga. Você pode configurar credenciais na tabela Credencial do sistema de origem [sn_spend_intg_source_system_credential]. Para obter instruções, consulte Definindo 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. Adicione campos personalizados para importação de fatura
    2. Mapeie campos personalizados entre as tabelas de origem e de destino
    3. Mapeie campos personalizados para um formato de origem de carga

    Formato de URL

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

    URL padrão: /api/sn_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 para acessar. Por exemplo, v1 ou v2 . Especifique este valor somente 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 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[ em 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/Request/InvoiceDetailRequest /InvoiceDetailRequestHeader[ em 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 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/Request/InvoiceDetailRequest /InvoiceDetailRequestHeader/InvoicePartner /Contact 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 O país para o qual a fatura é enviada no formato ISO 3166. Por exemplo, EUA .

    Campo de destino: u_bill_to_country

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

    /CXML/Request/InvoiceDetailRequest /InvoiceDetailRequestHeader/InvoicePartner /Contact O estado ou 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 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/Request/InvoiceDetailRequest /InvoiceDetailRequestHeader/InvoicePartner /Contact O CEP ou CEP para o qual a fatura é enviada.

    Campo de destino: u_bill_to_zip_or_postal_code

    Contato/PostalAddress/Rua O endereço para o qual o pagamento é feito.

    Campo de destino: u_remit_address

    Contato/Endereço postal/Cidade A cidade para a qual o pagamento será feito.

    Campo de destino: u_remit_to_city

    Contato/PostalAddress/Estado O estado ou província para o qual o pagamento é feito.

    Campo de destino: u_remit_to_state_or_province

    Contato/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/Endereço postal/País O país para o qual o pagamento é feito no formato ISO 3166. Por exemplo, EUA .

    Campo de destino: u_remit_to_country

    /CXML/Request/InvoiceDetailRequest/InvoiceDetailRequestHeader /InvoiceDetails/Contact Rua da qual os itens na 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 /InvoiceDetails/Contact Cidade da qual os itens na 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 /InvoiceDetails/Contact Estado do qual os itens na 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 /InvoiceDetails/Contact CEP do qual os itens na 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 /InvoiceDetails/Contact País do qual os itens na 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 /InvoicePartner/Contact 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/Nome Nome do contato para o qual os itens na ordem de compra devem ser enviados.

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

    Contato/Endereço postal/Rua Rua para a qual os itens na 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/Endereço postal/Cidade Cidade para a qual os itens na 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/Endereço postal/Estado Estado ou província para o qual os itens na ordem de compra são enviados.

    Campo de destino: u_ship_to_state_or_province

    Contato/PostalAddress/PostalCode CEP para o qual os itens na 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/Endereço postal/País País para o qual os itens na 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 O tempo acordado e as condições sob as quais um pagamento a um fornecedor é feito. Por exemplo, Rede 30 .

    Campo de destino: u_payment_terms

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

    /CXML/Request/InvoiceDetailRequest/InvoiceDetailOrder /InvoiceDetailItem[ em descrição]/ Descrição da linha da fatura.

    Campo de destino: u_line_description

    /CXML/Request/InvoiceDetailRequest/InvoiceDetailOrder /InvoiceDetailItem[ em quantidade]/ Quantidade de bens ou serviços pelos quais um cliente está sendo faturado.

    Campo de destino: u_line_quantity

    /CXML/Request/InvoiceDetailRequest/InvoicDetailOrder /InvoicDetailItem/Distribution/Accounting /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/Request/InvoiceDetailRequest/InvoicDetailOrder /InvoicDetailItem/Distribution/Accounting /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/Request/InvoiceDetailRequest/InvoiceDetailOrder /InvoiceDetailItem/SubtotalAmount/Money Valor total do dinheiro 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/Request/InvoiceDetailRequest/InvoiceDetailOrder /InvoicDetailItem/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_faturado

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

    /CXML/Request/InvoiceDetailRequest/InvoiceDetailOrder /InvoicDetailOrderInfo/OrderReference Número da ordem de compra fornecido pelo cliente para este pedido. 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/Request/InvoiceDetailRequest/InvoiceDetailOrder /InvoicItem/UnitPrice/UnitOfMeasure Unidade de medida (UOM) base 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/Request/InvoiceDetailRequest/InvoiceDetailOrder /InvoicDetailItem/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/Request/InvoiceDetailRequest/InvoiceDetailOrder /InvoicDetailItem/UnitPrice/Money[ na 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]

    CXML/Solicitação/InvoiceDetailRequest/InvoiceDetailOrder /InvoicDetailItem /InvoicDetailItemReferência[ em lineNumber] ID da linha da ordem de compra do fornecedor referenciado. Listado na tabela Linha de 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 /InvoicDetailItem/InvoicDetailItemReference /ItemID/SupplierPartID 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 /InvoicDetailItem/InvoicDetailItemReferência/Descrição 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 /InvoicDetailItem/Imposto/Dinheiro Valor total de impostos faturados 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 /InvoicDetailItem/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/Request/InvoiceDetailRequest/ InvoicDetailSummary /SubtotalAmount/Money Valor total do dinheiro 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/Request/InvoiceDetailRequest/InvoiceDetailSummary /Tax/Money Valor total de impostos faturados pela compra.

    Campo de destino: u_tax_amount

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

    /CXML/Request/InvoiceDetailRequest/InvoicDetailSummary /Tax/TaxDetail[ na categoria] 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 da linha de imposto da fatura [sn_spend_intg_imp_invoice_tax_line]

    /CXML/Request/InvoiceDetailRequest/InvoicDetailSummary /Tax/TaxDetail[ em percentageRate] A alíquota de imposto cobrada pelo fornecedor.

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

    Campo de destino: u_supplier_tax_rate

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

    /CXML/Request/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/Request/InvoiceDetailRequest/InvoicDetailSummary /ShippingAmount/Money Custo total de envio para toda a compra.

    Campo de destino: u_shipping_amount

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

    /CXML/Request/InvoiceDetailRequest/InvoiceDetailSummary /GrossAmount/Money Necessá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/Request/InvoiceDetailRequest/InvoiceDetailSummary /InvoiceDetailDiscount/Money Descontos aplicados à fatura.

    Campo de destino: u_discounts

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

    /CXML/Request/InvoiceDetailRequest/InvoiceDetailSummary /NetAmount/Money Valor total do dinheiro a ser pago ao fornecedor, incluindo impostos e taxas de envio.

    Campo de destino: u_amount_faturado

    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 da 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. Suporta somente application/xml.
    Sistema de origem Especifica o sistema de origem do qual a solicitação vem.

    Os sistemas disponíveis estã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_sp_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 possíveis códigos de status usados na REST API, consulte REST API códigos de resposta HTTP .

    Tabela 6. Códigos de status
    Código de 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. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
    429 Excesso de solicitações. A taxa de solicitações 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

    error.detail Detalhes adicionais sobre o erro de solicitação.
    Resultados possíveis:
    • Falha na validação de 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 está incorreta ou o nome de usuário está errado.

    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 tamanho do lote definido. O tamanho máximo da carga padrão é de 100 registros. Este valor é configurável no sn_spend_intg.ap.invoice.create.api.record_limitpropriedade do sistema.
    • 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 do APO excedido.
    • Usuário não autenticado. A senha está incorreta ou o nome de usuário está errado.
    • Falha na validação de 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_sp_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_sp_intg_invoice_integration_log]. Use o ID do lote listado na coluna ID do lote para encontrar a fatura.

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

    Fatura de AP – PUBLICAR sn_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. Adicione campos personalizados para importação de fatura
    2. Mapeie campos personalizados entre as tabelas de origem e de destino
    3. Mapeie campos personalizados para um formato de origem de carga

    Formato de URL

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

    URL padrão: /api/sn_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 para acessar. Por exemplo, v1 ou v2 . Especifique este valor somente 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"
      }
    }
    amount_faturado.amount_faturado Valor total do dinheiro a ser pago ao fornecedor, incluindo impostos e taxas de envio.

    Campo de destino: u_amount_faturado

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

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 40

    bill_to_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]

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

    Campo de destino: u_bill_to_country

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

    bill_to_state_or_province O estado ou 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]

    bill_to_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]

    bill_to_zip_or_postal_code O CEP ou CEP para o qual a fatura é enviada.

    Campo de destino: u_bill_to_zip_or_postal_code

    invoices.business_owner Nome do responsável pela 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

    Comprimento máximo: 40

    moeda.faturas Necessá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

    Comprimento máximo: 40

    descontos.faturas 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

    Comprimento máximo: 100

    invoices.erp_number Número exclusivo gerado no sistema ERP (Planejamento de recursos empresariais) 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

    Comprimento máximo: 40

    faturas. external_invoice_number Necessá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

    Comprimento máximo: 40

    invoices.invoice_date Necessá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

    Comprimento máximo: 40

    FORMATO: AAAA-MM-DD

    invoices.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

    Comprimento máximo: 40

    invoices.invoice_lines Lista de objetos que definem as linhas que estão sendo faturadas para compras neste pedido. As linhas de fatura são preparadas na tabela de entrada de importação de linha de fatura [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"
      }
    ]
    invoices.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

    Comprimento máximo: 40

    invoices.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

    Comprimento máximo: 40

    invoices.invoice_lines. external_invoice_number Necessá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

    Comprimento máximo: 40

    invoices.invoice_lines. gl_account 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

    Comprimento máximo: 40

    Consulte também:
    invoices.invoice_lines. line_amount_faturado Necessá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_faturado

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

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 40

    invoices.invoice_lines. line_description Necessá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

    Comprimento máximo: 40

    invoices.invoice_lines. line_quantity Necessário. Quantidade de bens ou serviços pelos quais 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

    Comprimento máximo: 40

    invoices.invoice_lines. line_unit_price 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

    Comprimento máximo: 40

    invoices.invoice_lines. po_line_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]

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 100

    invoices.invoice_lines. purchase_order_line Necessário. ID da linha da ordem de compra do fornecedor referenciado. Listado na tabela Linha de 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

    Comprimento máximo: 40

    invoices.invoice_lines. enviar_para_cidade Cidade para a qual os itens na 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

    Comprimento máximo: 100

    invoices.invoice_lines. enviar_para_país País para o qual os itens na 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

    Comprimento máximo: 100

    invoices.invoice_lines. enviar_para_estado_ou_província Estado ou província para o qual os itens na 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

    Comprimento máximo: 100

    invoices.invoice_lines. enviar_para_rua Rua para a qual os itens na 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

    Comprimento máximo: 100

    invoices.invoice_lines. enviar_para_zip_ou_postal_code CEP para o qual os itens na 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

    Comprimento máximo: 100

    invoices.invoice_lines. subtotal Necessário. Valor total do dinheiro 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

    Comprimento máximo: 100

    invoices.invoice_lines. supplier_part_number Necessá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

    Comprimento máximo: 100

    invoices.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

    Comprimento máximo: 100

    invoices.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"
      }
    ]
    invoices.invoice_lines. tax_details.tax_amount Necessário. Valor total de impostos faturados pela compra.

    Campo de destino: u_tax_amount

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

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 40

    invoices.invoice_lines. tax_details.tax_rate A alíquota de imposto cobrada pelo fornecedor.

    Campo de destino: u_supplier_tax_rate

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

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 100

    invoices.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 da linha de imposto da fatura [sn_spend_intg_imp_invoice_tax_line]

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 100

    invoices.invoice_lines.uom Unidade de medida (UOM) base 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

    Comprimento máximo: 100

    invoices.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

    Comprimento máximo: 100

    invoices.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

    Comprimento máximo: 100

    invoices.original_invoice Número da 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

    Comprimento máximo: 100

    other_chards 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

    Comprimento máximo: 100

    invoices.payment_terms O tempo acordado e as condições sob as quais um pagamento a um fornecedor é feito. Por exemplo, Rede 30 .

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

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 100

    purchase_order.purchase_order Necessário. Número da ordem de compra fornecido pelo cliente para este pedido. 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

    Comprimento máximo: 40

    invoices.remit_address Necessá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

    Comprimento máximo: 100

    invoices.remit_to_city Necessá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

    Comprimento máximo: 100

    invoices.remit_to_country Necessário. O país para o qual o pagamento é feito no formato ISO 3166. Por exemplo, EUA .

    Campo de destino: u_remit_to_country

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

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 100

    faturas. remit_to_state_or_province Necessário. O estado ou 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

    Comprimento máximo: 100

    faturas. remit_to_zip_or_postal_code Necessá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

    Comprimento máximo: 100

    invoices.ship_from_city Cidade da qual os itens na ordem de compra são enviados.

    Campo de destino: u_ship_from_city

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 100

    invoices.ship_from_country País do qual os itens na ordem de compra são enviados.

    Campo de destino: u_ship_from_country

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 100

    faturas. send_from_state_or_province Estado do qual os itens na ordem de compra são enviados.

    Campo de destino: u_ship_from_state_or_province

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 100

    invoices.ship_from_street Rua da qual os itens na ordem de compra são enviados.

    Campo de destino: u_ship_from_street

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 100

    faturas. send_from_zip_or_postal_code CEP do qual os itens na ordem de compra são enviados.

    Campo de destino: u_ship_from_zip_or_postal_code

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 100

    invoices.ship_to_city Cidade para a qual os itens na 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

    Comprimento máximo: 100

    invoices.ship_to_country País para o qual os itens na 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

    Comprimento máximo: 100

    faturas. send_to_state_or_province Estado para o qual os itens na 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

    Comprimento máximo: 100

    invoices.ship_to_street Rua para a qual os itens na 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

    Comprimento máximo: 100

    faturas. send_to_zip_or_postal_code CEP para o qual os itens na 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

    Comprimento máximo: 100

    invoices.shipping_amount Necessário. Custo total de envio para toda a compra.

    Campo de destino: u_shipping_amount

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

    Tipo de dados: Cadeia de caracteres

    Comprimento máximo: 40

    subtotal de faturas.subtotal Necessário. Valor total do dinheiro 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

    Comprimento máximo: 40

    fornecedor.faturas Necessá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

    Comprimento máximo: 100

    faturas. supplier_invoice_number Necessá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

    Comprimento máximo: 100

    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

    Comprimento máximo: 100

    invoices.target_erp Registro de ERP no qual a fatura é lançada. Localizado na tabela Origem de 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 da 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. Suporta somente application/json.
    Sistema de origem Especifica o sistema de origem do qual a solicitação vem.

    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_sp_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 possíveis códigos de status usados na REST API, consulte REST API códigos de resposta HTTP .

    Tabela 12. Códigos de status
    Código de 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. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
    429 Excesso de solicitações. A taxa de solicitações 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

    error.detail Detalhes adicionais sobre o erro de solicitação.
    Resultados possíveis:
    • Falha na validação de 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 está incorreta ou o nome de usuário está errado.

    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 tamanho do lote definido. O tamanho máximo da carga padrão é de 100 registros. Este valor é configurável no sn_spend_intg.ap.invoice.create.api.record_limitpropriedade do sistema.
    • 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 do APO excedido.
    • Usuário não autenticado. A senha está incorreta ou o nome de usuário está errado.
    • Falha na validação de 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_sp_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_sp_intg_invoice_integration_log]. Use o ID do lote listado na coluna ID do lote para encontrar a fatura.

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

    Fatura de AP – PUBLICAR sn_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. Adicione campos personalizados para importação de fatura
    2. Mapeie campos personalizados entre as tabelas de origem e de destino
    3. Mapeie campos personalizados para um formato de origem de carga

    Formato de URL

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

    URL padrão: /api/sn_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 para acessar. Por exemplo, v1 ou v2 . Especifique este valor somente 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
    /Invoice/AmostoFaturado Valor total do dinheiro a ser pago ao fornecedor, incluindo impostos e taxas de envio.

    Campo de destino: u_amount_faturado

    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/billToCountry O país para o qual a fatura é enviada no formato ISO 3166. Por exemplo, EUA .

    Campo de destino: u_bill_to_country

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

    /Invoice/BiltoStateOrProvince O estado ou 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]

    /Invoice/billToStreet 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]

    /Invoice/billToZipOrPostalCode O CEP ou CEP para o qual a fatura é enviada.

    Campo de destino: u_bill_to_zip_or_postal_code

    /Fatura/Moeda Necessá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 padrão AAAA-MM-DD para outro formato de data compatível. O valor de data é definido em InvoiceDateelemento.
    Formatos de data compatíveis:
    • DD MMM AAAA
    • DD MMM, YY
    • DD MMM, AAAA
    • DD MMMM AAAA
    • DD MMMM, YY
    • DD MMMM, AAAA
    • DD-MM-AA
    • DD-MM-AAAA
    • DD-MMM-AA
    • DD-MMM-AAAA
    • DD.MM.AA
    • DD.MM.AAAA
    • DD/MM/AAAA
    • DD/MM/AAAA
    • dd/mmm/aaaa
    • MM-DD-AAAA
    • MM-DD-AAAA
    • MM.DD.AA
    • MM.DD.AAAA
    • DD/MM/AA
    • MM/DD/AAAA
    • DD AAAA
    • MM DD, YY
    • DD DE MMM, AAAA
    • MM DD AAAA
    • MM DD, YY
    • MMMM DD, AAAA
    • AA-MM-DD
    • MM.DD.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, agosto 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/FatuceDate Data em que o cliente foi faturado.Use o. DateFormatelemento 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

    /Invoice/LegalEntity 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/OutrosCargas 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]

    /Invoice/PaymentTerms O tempo acordado e as condições sob as quais um pagamento a um fornecedor é feito. Por exemplo, Rede 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/RememetToCity A cidade para a qual o pagamento será feito.

    Campo de destino: u_remit_to_city

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

    Campo de destino: u_remit_to_country

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

    Campo de destino: u_remit_to_state_or_province

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

    Campo de destino: u_remit_to_zip_or_postal_code

    /Invoice/ShipFromCity Cidade da qual os itens na ordem de compra são enviados.

    Campo de destino: u_ship_from_city

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

    /Invoice/ShipFromCountry País do qual os itens na ordem de compra são enviados.

    Campo de destino: u_ship_from_country

    Tabela relacionada: Linha da fatura [sn_spend_intg_imp_invoice]

    /Invoice/ShipFromStateorProvince Estado do qual os itens na ordem de compra são enviados.

    Campo de destino: u_ship_from_state_or_province

    Tabela relacionada: Linha da fatura [sn_spend_intg_imp_invoice]

    /Invoice/ShipFromStreet Rua da qual os itens na ordem de compra são enviados.

    Campo de destino: u_ship_from_street

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

    /Invoice/ShipFromZipOrPostalCode CEP do qual os itens na ordem de compra são enviados.

    Campo de destino: u_ship_from_zip_or_postal_code

    Tabela relacionada: Linha da fatura [sn_spend_intg_imp_invoice]

    /Invoice/Valor de envio Custo total de envio para toda a compra.

    Campo de destino: u_shipping_amount

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

    /Fatura/subtotal Valor total do dinheiro 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]

    /InvoiceLine/Centro de custos 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

    /Linha de fatura/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]

    /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/LineAmountFaturado 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_faturado

    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 pelos quais 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 este pedido. 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/ShipToCity Cidade para a qual os itens na 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 na 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 na ordem de compra são enviados.

    Campo de destino: u_ship_to_state_or_province

    /InvoiceLine/ShipToStreet Rua para a qual os itens na 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 na 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 do dinheiro 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/SupplierPartNumber 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 de fatura/UOM Unidade de medida (UOM) base 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]

    /Detalhe do imposto/Tipo de imposto 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 da linha de imposto da fatura [sn_spend_intg_imp_invoice_tax_line]

    /Detalhe do imposto/Taxa de imposto A alíquota de imposto cobrada pelo fornecedor.

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

    Campo de destino: u_supplier_tax_rate

    Tabela relacionada: Importação da 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 da 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. Suporta somente application/xml.
    Sistema de origem Especifica o sistema de origem do qual a solicitação vem.

    Os sistemas disponíveis estã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_sp_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 possíveis códigos de status usados na REST API, consulte REST API códigos de resposta HTTP .

    Tabela 18. Códigos de status
    Código de 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. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
    429 Excesso de solicitações. A taxa de solicitações 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

    error.detail Detalhes adicionais sobre o erro de solicitação.
    Resultados possíveis:
    • Falha na validação de 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 está incorreta ou o nome de usuário está errado.

    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 tamanho do lote definido. O tamanho máximo da carga padrão é de 100 registros. Este valor é configurável no sn_spend_intg.ap.invoice.create.api.record_limitpropriedade do sistema.
    • 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 do APO excedido.
    • Usuário não autenticado. A senha está incorreta ou o nome de usuário está errado.
    • Falha na validação de 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_sp_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_sp_intg_invoice_integration_log]. Use o ID do lote listado na coluna ID do lote para encontrar a fatura.

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