periodKey - possible values about vat-api

[markogrady]

You get the period key when you retrieve the obligations

…

On 6 Mar 2018 13:26, "Andy Lee" ***@***.***> wrote: Thx @jacobbrownlowhmrc <https://github.com/jacobbrownlowhmrc> So can I understand periodKey is a mandatory field, but you have no criteria for what it may contain? I saw on #63 <#63> that it can be any 4 chr alpha Must they be kept unique at all? It sounds like it is for the our calling service to use how we like, is that right? — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#72 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAMI61sahe2XvuX_LCQzqmug5zA9D67uks5tbo6RgaJpZM4Seqdx> .

[jacobbrownlow]

Hi
Please see these issues about the period key: #49 and #63
Jacob

[AndyLee-Avalara]

Thx @jacobbrownlowhmrc

So can I understand periodKey is a mandatory field, but you have no criteria for what it may contain?

I saw on #63 that it can be any 4 chr alpha

Must they be kept unique at all?

It sounds like it is for the our calling service to use how we like, is that right?

[jacobbrownlow]

The period key is created by one of our backend systems. It is created when an obligation is created, therefore it is unique to the VRN and period.

The backend system has its own validation, but we only validate that it is 4 alpha-numeric characters.

[AndyLee-Avalara]

Ok thanks, I understand it now, it is a reference to the obligation.. thx