e-Invoice lifecycle/flow + APP API usage questions

Lex

Many thanks for taking your time to clearly explain this. Just 2 more question from me.

Testing the Full Lifecycle

How do I confirm my test business as both the Accounting Supplier and Customer?
Is it something I can do by myself or do I need to request via a channel? If I do need to request via a channel, what channel do I use?

Transmit Lookup by IRN vs by TIN

What is the difference between GET /api/v1/invoice/transmit/lookup/{IRN} and GET /api/v1/invoice/transmit/lookup/tin/{TIN} in terms of use case?
Also will they both return same response?

SysAdmin

1. Testing the Full Lifecycle

How do I confirm my test business as both the Accounting Supplier and Customer? Enter the same details in the Account Supplier Party and Accounting Customer Party. You can retrieve your test business by calling the search entity endpoint using your APP Keys.
Is it something I can do by myself or do I need to request via a channel? If I do need to request via a channel, what channel do I use? You can do it yourself. Just update the invoice schema to reflect your test data for both parties.

2. Transmit Lookup by IRN vs by TIN

What is the difference between GET /api/v1/invoice/transmit/lookup/{IRN} and GET /api/v1/invoice/transmit/lookup/tin/{TIN} in terms of use case? Both serve the same purpose: retrieving taxpayer invoice exchange details, including accounting party profiles and corresponding APPs. The key difference lies in the scope of information returned:
-LookUp IRN: Returns exchange details for both parties involved in the invoice.
-LookUp TIN: Returns exchange details for the single party whose TIN is provided.
Also will they both return same response? No.

Lex

Thanks a lot for your response. A question around pulling invoice. Each time an APP calls the pull invoice APP, does it get the list of all invoices transmitted to the APP since beginning of time, or does it return only invoices that are transmitted but have not been PAID? I am trying to understand if the returned invoice list grows forever or it cuts off by time, or by something else.

Also, can I use the API GET /api/v1/entity (Search Entity) to search by business Id? i.e. /api/v1/entity?business_id=xxxxxx-xxxx-xxxxx. Also I assume any business where I am their APP, the search API will return it. Pls can you confirm this?

SysAdmin

Please find our response below:
Each time an APP calls the pull invoice APP:

Does it get the list of all invoices transmitted to the APP since the beginning of time? Yes
Does it return only invoices that are transmitted but have not been PAID? No, all invoices, whether paid or not
Does the returned invoices list grow forever, or does it cut off by time, or by something else? For now, the list will continue to grow.

GET Entity/ Search Entity

Can I use the API GET /api/v1/entity (Search Entity) to search by business ID? i.e. /api/v1/entity?business_id=xxxxxx-xxxx-xxxxx? Yes, but not with Business ID, instead with Entity ID
Business where I am their APP, the search API will return it. Pls can you confirm this? Yes, the search entity API will help retrieve the names of businesses that as selected you as their APP

Ams

SysAdmin

Point No. 8 - Testing the Full LifeCycle
i'm a system integrator

i'm not quite clear on what i need to do to pull(download) the invoices sent by the supplier if i'm integrating for a receiver(buyer). Or will i need to provide the receiver's(buyer) system Endpoint to the APP so they send the invoice to the endpoint i provide.

Also as a system integrator, will i be able to test the full lifecycle just as you suggested by specifying the same details as Account supplier and Account customer party.

SysAdmin

Dear @Ams,

The response referenced is for an entity that is performing the role of both the SI and APP.

If you intend to carryout an E2E as a SI, you will need to work with an APP.

However, your system implementation and design must cater for scenarios where your client is either the issuer or receiver of invoice so that you can make room to accommodate proper bidirectional communication with the APP.

Ams

SysAdmin

Ok thank you for providing more clarity

So if i get you correctly, the decision on the handshake modal to receive the e-invoice on the receiver's(buyer's) system is entirely between the receiver's APP and the receiver ?

i.e (a.) the receiver can decide to provide an endpoint to the APP to send the e-invoice whenever the receiver APP receives it or (b.) the receiver's system calls receiver APP endpoint at interval to check and fetch e-invoice if available or (c.) via webhook

i just want to know if FIRS has rules defined on how the receiver receives the e-invoice or the conversation is entirely between the APP and the SI implementing for (receiver)

SysAdmin

Dear @Ams,

Your analogies are correct.

Ams

SysAdmin
Thank you for your response

Owoeye

SysAdmin

Thanks for this verbose clarity.

However, on the webhook notification, l've set the webhook url on my APP dashboard, however, whenever i transmit an invoice, i'm not receiving the real-time webhook notification before confirming the invoice transmisison.

I used my test business as both the Accounting Supplier and Customer, but i don't get the webhook notification.

SysAdmin

Owoeye Please confirm if you got a test notification when you set up your webhook?

Owoeye

SysAdmin

No, i didn't get the test notification;

Please advice.

SysAdmin

Hello @Owoeye,

This indicates that your webhook is not actively listening. You should normally receive a test notification immediately after setting up your webhook.

Please ensure that your webhook endpoint is correctly configured and accessible.