This guide is for your technical team, to anticipate the impact of the october 11 major update on your integration.
This article will give you details on that change.
The main point is:
- The functional state is stable, intuitive and won’t change in the future.
- The technical state is subject to evolution et require a deep understanding of ProAbono to be understood.
#1 API Live
API Live is the API to use when you are interacting with your customers. This check is probably the most important to ensure you won’t have a negative customer experience on october 11.
Objects
#1 Change in the endpoints:
- /V1/Subscription
- /V1/Subscriptions
The Subscription object returns a double state since august 10 (functional / technical state)
{
"Id": 42",
...
"ReferenceCustomer": "123456",
"Status": "Active", // Functional state
"StateSubscription": "ActiveDelayedTermination", // Technical state
...
}
#2 Change in the endpoints:
- /V1/Invoice
- /V1/Subscriptions
The Subscription object returns a double state since august 10 (functional / technical state)
{
"Id": 42",
...
"Status": "Due", // Functional state
"StateInvoice": "DueAuto", // Technical state
...
}
If you currently use the technical state (StateSubscription | StateInvoice) in your code, you have to use the functional state instead.
The matching table can be found in this article and this one.
The current values of the technical state will globally change on october 11.
The current values of the functional state won’t change.
#2 Webhooks
Objects
The webhooks return a double state since august 10 (functional / technical state) for the related resources:
- Invoice
- Subscription
- Customer
If you currently use the technical state (StateInvoice | StateSubscription | StateCustomer) in yoru code, you have to use the functional state (Status) instead.
The current values of the technical state will globally change on october 11.
The current values of the functional state won’t change.
Find the matching status in those articles:
#3 API BO (exports)
Objects
The following resources return a double state since august 10 (functional / technical state):
- Invoice
- Subscription
- Customer
- Payment
Requests
If you are using the technical state as querystring parameters of your GET requests (ex: https://via.proabono.com/Finance/Invoices?StateInvoice=PaymentDue ), change those requests to use the functional state as much as possible.
The current values of the technical state will globally change on october 11.
The current values of the functional state won’t change.
Find here the matching values :
| Before | After | Match |
| ?StateCustomer= | ?StatusCustomer= | https://docs.proabono.com/fr/documentation/clients/etats-client/ |
| ?StateInvoice= | ?StatusInvoice= | https://docs.proabono.com/fr/documentation/factures/etats-facture/ |
| ?StateInvoiceMin= | ?StatusInvoice= | use the functional state instead of a range |
| ?StateInvoiceMax= | ?StatusInvoice= | use the functional state instead of a range |
| ?StateSubscription= | ?StatusSubscription= | https://docs.proabono.com/documentation/subscriptions/subscription-status/ |
| ?StateSubscriptionMin= | ?StatusSubscription= | use the functional state instead of a range |
| ?StateSubscriptionMax= | ?StatusSubscription= | use the functional state instead of a range |
| ?StatePayment= | ?StatusPayment= | https://docs.proabono.com/fr/documentation/paiements/ |
#4 Zapier / Make
Objets
The following resources return a double state since august 10 (functional / technical state):
- Invoice
- Subscription
- Customer
If you are using the technical state in you workflows, update those to use the functional state instead.
The current values of the technical state will globally change on october 11.
The current values of the functional state won’t change.
See the section #3 API BO (exports) for the matching table.
Assistance
If you have cases that are not covered by this guide, feel free to contact us: login using you ProAbono account and use the inline messenger.