Guia de casos de uso da API de pagamentos de envio direto do fornecedor v1
How to help vendors in the direct fulfillment (DF) program use the Payments API to manage their direct fulfillment operations.
Versão da API: v1
O que é a API de pagamentos de atendimento direto?
Os fornecedores podem usar a API de pagamentos de envios diretos para trocar documentos relacionados a pagamentos com a Amazon. A operação submitInvoice
permite que os fornecedores enviem faturas de fornecedores à Amazon para pedidos confirmados e enviados.
As seguintes operações estão incluídas na API de pagamentos:
Operação | Método HTTP | Path | Descrição |
---|---|---|---|
submitInvoice | POST | /vendor/directFulfillment/payments/v1/invoices | Envia uma ou mais faturas para pedidos de atendimento direto de um fornecedor. |
submitInvoice
A operação submitInvoice
permite que os fornecedores enviem faturas de fornecedores para solicitar o pagamento da Amazon pelos itens enviados. Usando essa API, os fornecedores podem enviar várias faturas em uma única chamada de API.
Items should be invoiced only after they are confirmed and shipped to Amazon. Otherwise, the invoice will be rejected. An invoice with correct information will be processed by Amazon without any human interaction, which means that the vendor receives payment more quickly. Invoices with incorrect information will be rejected in Amazon's payee system, so sending correct information is very important. Refer to the business requirements section to learn how to create invoices with correct information.
Teste paralelo de envio de faturas
After you complete the API invoice integration, our Accounts Payable (AP) department requires you to send one successful API invoice in production before considering you as live. If there are any issues with your initial production invoice, our AP team will contact you. After the API invoice is integrated into production, you must send invoices via API only. If you want to return to using just the Vendor Central option, contact us to update your account. Before finalizing your API invoice integration, submit all invoices with a "Non-submitted" status in your account under the Payments tab in the Direct Fulfillment invoices section. Existing invoices with the "Non-submitted" status might be rejected and not paid if sent via API.
Verificação de faturas enviadas com sucesso
The Transaction Status API doesn't show the actual status of invoice processing, it only shows the status of the semantic validations of the submitted invoices. Vendors can verify the actual status of the original/updated version of the invoices via Vendor Central > Payments > Direct Fulfillment Invoices. For more information on how to use the Transaction Status API, refer to the business use case documentation for Transaction Status. Allow the system to take up to 15 minutes to show the original/updated version after submission. If Vendor Central is not showing the correct values for the updated invoice, open a Contact Us case in Vendor Central.
O diagrama a seguir mostra o fluxo de trabalho de integração para o envio de faturas para pedidos confirmados e enviados diretamente:
Requisitos comerciais
Invoice numbers
must be unique, and they should never be reused (even after one year).
Se uma fatura enviada usando a API falhar devido a dados incorretos, mas uma fatura impressa tiver os dados corretos, o fornecedor deverá atualizar a fatura por meio da API com os dados corretos usando os mesmos Invoice ID
.
If an invoice has incorrect data (both paper and API) then the invoice is canceled and a new invoice should be sent with a new Invoice ID
.
Uma fatura com um total amount
= 0 não deve ser enviada, pois isso faria com que a fatura falhasse.
A Amazon exige os detalhes completos do endereço nos segmentos de endereço por motivos de conformidade fiscal. Isso é especialmente importante para bill to party
. Para esse segmento, o sistema Amazon Payee exige uma correspondência exata. Para obter uma lista completa de endereços de cobrança da Amazon para partes e exemplos de códigos JSON, consulte Fatura da SP-API para endereços de partes. Se você não souber a identificação fiscal da Amazon para uma fatura no local, acesse Vendor Central e da página Suporte, selecione o botão Entrar em contato conosco para criar um caso.
O Payment terms
enviado em uma fatura deve corresponder às condições de pagamento acordadas com o comprador da Amazon.
O Item product identifier
deve corresponder ao identificador do produto do item do pedido que foi enviado ao fornecedor no pedido de compra correspondente.
The invoice total amount
should be equal to the total sum of the items, charges, and allowances.
O total do tax amount
para cada nível de linha deve ser igual ao total do valor do imposto no nível do cabeçalho.
A fatura total quantity
deve corresponder à soma da quantidade de todos os itens.
Every different charge and allowance
must be itemized on the header level (for example, freight charge, package charge, small ordering charge).
Requisitos comerciais específicos do país
As faturas para envio direto não são aceitas na Índia por meio da API.
Funcionalidade | Índia | Europa | América do Norte |
---|---|---|---|
Invoice Type |
Não suportado | O tipo de fatura deve sempre ser “Fatura”. | O tipo de fatura deve sempre ser “Fatura”. |
Date |
Não suportado | Deve ser “agora” ou antes. | Deve ser “agora” ou antes. |
HSN Number |
Não suportado | Não usado | Não usado |
Tax Type at line and header level |
Não suportado | Tipo de imposto a ser enviado. | Não usado |
Tax Registration Number |
Não suportado | Número de IVA | Número de IVA |
Tax Details at line and header level |
Não suportado |
Se vários impostos forem aplicáveis a um item, a seção Detalhes fiscais deverá ser enviada várias vezes com o tipo de imposto apropriado para esse item. O mesmo se aplica ao valor total da fatura. Há também um tipo de imposto adicional chamado “IVA doméstico”, que pode ser usado para enviar o valor do imposto na moeda local. Para processar o IVA doméstico, você deve usar a mesma taxa de imposto usada no tipo de imposto “IVA”. |
Se vários impostos forem aplicáveis a um item, a seção Detalhes fiscais deverá ser enviada várias vezes com o tipo de imposto apropriado para esse item. O mesmo se aplica ao valor total da fatura. |
Remit To Party |
Não suportado | Detalhes fiscais e de endereço da parte (fornecedor) que receberá o pagamento pelos itens enviados. Isso é obrigatório. | Detalhes fiscais e de endereço da parte (fornecedor) que receberá o pagamento pelos itens enviados. Isso é obrigatório. |
Ship From Party |
Não suportado | Código do fornecedor ou código do depósito e endereço da parte de onde os itens serão enviados. | Código do fornecedor ou código do depósito e endereço da parte de onde os itens serão enviados. |
Ship To Party |
Não suportado | ID da Amazon ou código do depósito e endereço da parte para a qual os itens serão enviados. | ID da Amazon ou código do depósito e endereço da parte para a qual os itens serão enviados. |
Bill To Party |
Não suportado |
Detalhes fiscais e de endereço da parte (Amazon) que será cobrada pelos itens enviados. Este campo é obrigatório. |
Detalhes fiscais e de endereço da parte (Amazon) que será cobrada pelos itens enviados. Este campo é obrigatório. |
Amazon Product Identifier and External Product Identifier |
Não suportado | Pelo menos um desses valores é obrigatório. O identificador deve ser o mesmo que é recebido no pedido. | Pelo menos um desses valores é obrigatório. O identificador deve ser o mesmo que é recebido no pedido. |
Net Cost |
Não suportado | Este campo é obrigatório. | Este campo é obrigatório. |
Purchase Order Number |
Não suportado |
Uma fatura pode conter informações para vários pedidos. O número da PO deve ser enviado adequadamente para diferentes itens de linha. Obrigatório. |
Uma fatura pode conter informações para vários pedidos. O número da PO deve ser enviado adequadamente para diferentes itens de linha. Obrigatório. |
Additional Details |
Não suportado | Esse campo é usado quando a parte vendedora precisa enviar detalhes adicionais para fins especiais. Por exemplo, no caso de faturas de pagamento parceladas polonesas, a parte vendedora deve enviar os detalhes “mechanizm podzielonej płatności” do tipo “SUR” e o LanguageCode “PL”. | Não usado |
referenceNumber |
Não suportado | Não usado | Não usado |
Solicitação submitInvoice
Para enviar uma ou mais faturas, chame a operação submitInvoice
e passe o seguinte parâmetro:
Parâmetro do corpo:
Nome | Descrição | Obrigatório |
---|---|---|
invoices |
O esquema de solicitação da operação submitInvoice . Tipo: < matriz |
Sim |
Exemplo de solicitação
POST https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/payments/v1/invoices
{
"invoiceNumber": "0092590411",
"invoiceDate": "2020-03-13T11:16:24Z",
"remitToParty": {
"partyId": "YourVendorCode",
"address": {
"name": "Jane Doe",
"addressLine1": "123 Any Street",
"addressLine2": "123 Any Street",
"addressLine3": "123 Any Street",
"city": "Any Town",
"county": "Schwabing",
"district": "München",
"stateOrRegion": "Bayern",
"postalCode": "DEPostCode",
"countryCode": "DE"
},
"taxRegistrationDetails": [
{
"taxRegistrationType": "VAT",
"taxRegistrationNumber": "DE123456789"
}
]
},
"shipFromParty": {
"partyId": "ABCD"
},
"billToParty": {
"partyId": "5450534005838",
"address": {
"name": "John Doe",
"addressLine1": "100 Main Street",
"city": "Anytown",
"county": "Schwabing",
"district": "München",
"stateOrRegion": "Bayern",
"postalCode": "80807",
"countryCode": "DE"
},
"taxRegistrationDetails": [
{
"taxRegistrationType": "VAT",
"taxRegistrationNumber": "DE814584193",
"taxRegistrationAddress": {
"name": "John Doe",
"addressLine1": "100 Main Street",
"city": "Anytown",
"postalCode": "80807",
"countryCode": "DE"
},
"taxRegistrationMessage": "txmessage"
}
]
},
"shipToCountryCode": "DE",
"paymentTermsCode": "Basic",
"invoiceTotal": {
"currencyCode": "EUR",
"amount": "1428.00"
},
"taxTotals": [
{
"taxType": "CGST",
"taxRate": "0.19",
"taxAmount": {
"currencyCode": "EUR",
"amount": "228.00"
},
"taxableAmount": {
"currencyCode": "EUR",
"amount": "1200.00"
}
}
],
"items": [
{
"itemSequenceNumber": "1",
"buyerProductIdentifier": "B00IVLAABC",
"invoicedQuantity": {
"amount": 1,
"unitOfMeasure": "Each"
},
"netCost": {
"currencyCode": "EUR",
"amount": "1200.00"
},
"purchaseOrderNumber": "D3rC3KTxG",
"vendorOrderNumber": "0092590411",
"hsnCode": "76.06.92.99.00",
"taxDetails": [
{
"taxType": "CGST",
"taxRate": "0.19",
"taxAmount": {
"currencyCode": "EUR",
"amount": "228.00"
},
"taxableAmount": {
"currencyCode": "EUR",
"amount": "1200.00"
}
}
]
}
]
}
Resposta de submitInvoice
Uma resposta bem-sucedida inclui o seguinte:
Nome | Descrição | Obrigatório |
---|---|---|
transactionId |
GUID para identificar essa transação. Esse valor pode ser usado com a API de status da transação para retornar o status dessa transação. Tipo: string |
Não |
Exemplo de resposta
{
"transactionId": "20190905010908-8a3b6901-ef20-412f-9270-21c021796605"
}
Updated 23 days ago