Novas APIs de Faturas - Perguntas Frequentes
Nossas APIs de fatura estão mudando.
Para garantir que você continue recebendo os dados de fatura mais precisos, atualizados e completos, incluindo notas de crédito e informações fiscais, você precisará migrar para os novos endpoints das APIs de fatura.
Para mais informações sobre as APIs de fatura, visite https://dev.megaport.com.
Quais APIs de fatura são afetadas?
Esses endpoints de API foram descontinuados e substituídos por novos endpoints de API.
Título | Antiga API | Nova API |
---|---|---|
GET Faturas | GET /v2/invoice Retorna uma lista de faturas para a empresa associada à conta do usuário. |
GET /v2/company/${companyUid}/invoice/supplierId/{supplierId}?fromDate=${fromDate}&toDate=${toDate}? Retorna uma lista de faturas para a combinação de ID da empresa e ID de mercado de cobrança, para o intervalo de datas especificado. |
GET Fatura Única | GET v2/invoice/{invoiceId} Retorna a fatura para o invoiceId especificado. |
GET /v2/company/${companyId}/invoice/${invoiceId} Retorna a fatura para o companyId e invoiceId especificados em formato JSON. |
GET Fatura Única em PDF | GET /v2/invoice/{invoiceId}/pdf Retorna uma versão PDF da fatura para o invoiceId especificado. |
GET /v2/company/${companyId}/invoice/${invoiceId}/pdf Retorna uma versão PDF da fatura para o companyId e invoiceId especificados. |
GET Fatura Única em CSV | GET /v2/invoice/{invoiceId}/csv Retorna uma versão CSV da fatura para o invoiceId especificado. |
GET /v2/company/${companyId}/invoice/${invoiceId}/csv Retorna uma versão CSV da fatura para o companyId e invoiceId especificados. |
Onde encontro as informações da empresa e do fornecedor?
Todas as novas APIs de fatura exigem que você envie as informações da empresa e do fornecedor como parte da chamada API. Você pode encontrar esses valores nas seguintes APIs da Megaport:
supplierId
é o “firstPartyId” retornado na API GET Mercados de Cobrança/v2/market
para o fornecedor relevante.companyUid
é retornado na API GET Lista de Produtos/v2/products
ou na API GET Chaves de API/v2/auth/apikeys
.companyId
é retornado na API GET Detalhes da Empresa/v2/company/companyUid
.
Quando devo começar a usar as novas APIs de fatura?
O mais rápido possível. As novas APIs de fatura já estão disponíveis em Produção, e qualquer melhoria futura relacionada a faturas será aplicada apenas às novas APIs.
Quando as APIs de fatura legadas serão desativadas?
As APIs de fatura legadas foram descontinuadas e não são mais suportadas.
Com quem posso falar para obter mais informações?
Entre em contato com seu Gerente de Conta ou o Suporte da Megaport. Para mais informações, veja Entrando em Contato com o Suporte.