Skip to main content
Support Center
Help ArticlesAcademyCommunity
HomeCommunityMyAdminAccounts and BillingMyAdmin Billing API

MyAdmin Billing API

Open
MyAdmin
Accounts and Billing
P
P
pcoetzerhyrde-1882
Original Poster

Edited by EishiFUN

Hi All,

 

We want to automate getting billing related information for the devices linked to our account in myAdmin. Currently we have to request a report using the billing area in myAdmin, but I was wondering if there is a way to automate this?

 

The scenario:

  • A device is installed and the contract is activated. This in turn then triggers the rate plan to be applied and we can then bill the client for the month.
  • If the device is terminated, the device is still billed for the month that the devices was terminated in.
  • Same when the device is suspended, and the suspended rate plan is applied.

 

Device sharing:

  • According to what I understand, device sharing applies a new contract, thus except for the source device, the target device is also billed for (at a different rate)
  • This means for the time period that the device is shared, there is an additional subscription on the billing report

 

I'm not sure if Geotab applies billing changes in partial (i.e. the device was on a Go plan from 1st of the month and then on the 15th was suspended, then on the 28th terminated), thus applying partial costing for the number of days the device was in a specific rate plan.

 

What I'm looking for is a way to query this historical billing data for our finance department. The expected outcome would be multiple records per contract id during the query period, per billing plan type (to cover when the device changed from say GO to Suspended to Terminated):

 

Input:

  • Start Date
  • End Date
  • accountFilter
  • serialNumberFilter
  • vinFilter

 

Output:

 

  • Contract ID
  • Contract Comment
  • Contract Start Date
  • Contract End Date
  • Contract Status
  • Contract Promo Code
  • Billing Plan
  • Billing Start Date
  • Billing End Date
  • Billing Cost
  • Device Serial
  • Device Type
  • Device VIN
  • Database

 

 

Any insights would be helpful.

 

6
Join the conversation

You need to be logged in to reply to this post and participate in the Geotab Community discussions.

6 Replies

T
T
TuckerBA-1087

Hey @pcoetzerhyrde-1882​,

 

Have you read through the MyAdmin API documentation? What you want to do should be possible, I would start here and then if you run into specific issues on certain API requests, you can ask here. We've built stuff like that internally too (slightly different, but a lot of the same things).

 

Thanks,

Tucker

P
P
pcoetzerhyrde-1882
Original Poster

Hey Tucker,

 

Thanks for your reply. Yes, I'm quite familiar with the API/SDK docs, and we have performed some extensive integration with the platform.

 

I use the myAdmin API calls associated to get the Device Contracts with the Rate Plans and loop through these to get the total cost (also putting in validations to ensure the plan is active)

  • When I compare it to the reports generated in the myAdmin billing section, then the values do not match up. I'm also not sure if the Promo Code plays a role in the calculations, but by assumption, I would figure that this was already considered when I look at the rate plans array linked to the device. I also don't know if the billing report applies partial month billing or how it calculates device sharing (the scenarios explained above).
  • When I add date ranges to the query, I do not see in the output when a rate plan was applied and when it was stopped (all the dates show a plan start on the beginning of a month with a end date far in the future), even though I know a rate plan was activated on a device on say the 12th of November.

 

I know it's not a clear cut process, but the hope is that someone could explain the process the Billing Report follows to generate the output, as my attempts do not match the outputs using the myAdmin API.

 

Cheers!

 

T
T
TuckerBA-1087

Hey @pcoetzerhyrde-1882​,

 

I think someone from Geotab might have to provide that answer, but I'm also going to tag in someone else from my team to see if she can give any insight. She's the one at BlueArrow who has worked most with the MyAdmin API. @shelby shelby@bluearrowmail.com​ if you know the answer to this, can you help @pcoetzerhyrde-1882​ please?

 

Thanks,

Tucker

 

 

P
P
pcoetzerhyrde-1882
Original Poster

Thx Tucker...

 

Appreciate the help. Really good to see the community supporting each other!

I've also logged a support request with our account manager, but also thought to put it out here so that others may also know.

 

Keep well,

Pieter

C
C
Cshirshak-2114

Hi @pcoetzerhyrde-1882​  following this, were you able to get a concrete solution regarding this? I am also in the discovery phase of implementing the same.

P
P
pcoetzerhanab-2133

Hi @Cshirshak-2114​ ,

 

I was not able to find a good fit for the requirement, and we are still having to do manual checks as the Geotab API does not give all the data as expected (especially when it comes to the shared databases and their billing).

 

I do see that there has been an update on the GetContracts API call (now v3), but it is still quite limiting -

https://developers.geotab.com/myAdmin/apiReference/objects/ApiDeviceContract/

 

Hope it helps in some way.

 

Still have questions?
Learn with AcademyBrowse documents