€q\\›ÅP˜.ó0û¢m `¤(¼¹)bc˜Ù¡³eø¸+Ô¤'/Ù RUÖb\"³R¯•òE\u0005Žër™:òvêÔv\u001c‘ˆ¸‡5;\u000f©©ñ6ý £VS3V.׺”\u0012ûR¤&½õZlRGóhÌ„¤5ûÞ\u0003pª\"Óµ§+òŠ„•…õïÔËaXߴܲê\u001eÆ\u0002I^¾7…8yÍe}\u0005ƒn\r\nÖ—&ñ)\u0014æ§ rl:NBh¼ã\u001d÷öÔ>⺩d[Ò¹R#–˜ð.‘)ŠÌe²HŽ´°fGz1n!Ò8êb!à\u000e\u0017X7·8\r\n@囸Áv5! ±Ãö\u0014©¼[\r\n®3\u0007+Z`áËb\u0016zôÚ\u0002²áÆo¦‚dVõ`^áÀ¼U\\5š«\u0013LÑy\r\nÈï—BÝÌE°Üÿ<É&mS— Ñú{íhñM\u001d]Rd°ö\u000e˜_£}°œ¸~iCñ—Ýð°Ífrb¼ô¶Ž(ϦþTvâ\u0004/JÚ\u0011.}Z.<ô©5J\u00113b\u001aÍ7‚ÜFÞô\u001d\u0006¤Ï7Ÿï‡ØêhÖ\u0006\u0002{ü#C¹Aa/Ê\u00015dªôÀ\u0018Ä]˜ƒ…}¼‡5€½Ui€ïÁ ;\u001fÍx\r\níAT8°Øjª?¦%ƒg2e¢C¤{\"Ó\u001cW¹etÿN{pë‘\u0019\u001bNB>)\u0019a™ùê]¹!\u0007€ô‰J8:»dO®(eR¾\u000b¼\u0007ädj ÃÞ!:ö\u0018xW'H¥±³Ð×ÿ¥k\r\nû\u001d¹\u0015×ÌZ,”Á*ög\u000b\u001eOûÇËG~\u001fО&6z¤ð&×!…sÐYÕò2ƶ1\u0012gÉéç»xH$\u0014[NÇ\u0012Ñ]Ó#\\\u0005>ç¬[ü¹I·³ŠßC\u0016û\u0002i¿”È:\u0007¦š0 _“¢d±×Øü–¯4…6ÛéÒûPà#kÙ\f·WŒm‰‡.t\u0014J\u001aÑ þK\bcy$vxQÛ}3ó¯äM¨Œq| \"\u001eOᣬ?\u001cUâ/AçAØ*lb€©;nàÞìF\"b/&y²’ÞMsÜ·P\u0006r«t×\u000eÍÃÖû\f®Dé\u001bÎý‹ ª\fáƒU©¼v³6ˆfŽD2“@}œï\u0014&lÈ;=]£î˽*š\u0019—±1Ñ©´~¶±!ñ+_Ê\u0013ß\u0010J®Ö\u0002ãb˜EŒ÷Z8Ás¸$\u001b…¶]\fØÍ'ˆ\u0018a\b\u001b¾‡qt1ÂùèÉL\u001fjü¦6Aœå¡\u0015½JÝf¿žÜ±ƒÆ¤ÂâKÕùw×ñ-ëø\u0007õæ¿}\u0017Ÿƒ0[Å\"²¥x¥|˜\u0018\b2]@:\u000bú„Kùs팓\u0014«Æ{\u00112ãÊÈãWÇÅ}&\u000f‹œ0¼CÔ6óîš×€š„½{Hn‚\r\n`ÝùCHÙçeÜ›?Á‚\t°&-\u001cοjñBsNþ0C\u0007ç¡‚wæí¹\u0010Ǧ¡\u0010À3ã0TüßÕMV#1£¶T¡/ŸAëM6Õúž\u0014à\b»¢3¯EcäT\u001fÈ\u0004HíòX؆W¿5«‡Ap.vo5ê\u0011·pß;\bî®û«¤\u0019\u0006P'ìÔZ[*M,—\u0018\u0013’+U¹Õ*<Î óÛ¥+`‘æ®çÚ;FÜÄ¿ õ`¢0IZÓÖ»ÀœßÃ\u001ewÖèh\u000e:ÕÇB¹\r\n\u0004g%ôŒ\u0007\u0007¢\u001bbŽ„ß\u0012éd‚®Y÷\u001e«EŸ¶\bìtKI\u001côª¨E \u000egþß~«ÞB\u0019ñ8K;UúP\u0001V²AÛI†åP\u0013>Ós=§xô\u000e.\u0001èü'vT:o\r\n’oò”A\f‡Ð¨X—]¶±§h)6%±¦Sª'èE¿Å^”š²G \u0002œþ\u0005ñf\u0005ÅHlºÀZ5N51µ¢í±°-;ÝÓýüeñ§MßvY\fŠ{*š–sn\u000bõq³¸Ë 6R•Ñ]ÜíŒaÏ…Õc\"\u001eŸ£™ÙH–»?\u0002\u0014Ú}\\\u001eŸ9öœG,𼩤Ý}Λµno‹xÍ€\u0013Ô7: ÜjPäPrå£WèŒI\u001a{&‡Iº\u0016sc¢\u001e\u001b›™\u0015³ÿ\u001ePxgؾ|vÄöT]e”¾\fNíóZ.j&6útà&篔v’9ʳ\u001c°Íì.˫㔋ü!MAH·w°16ט΢ìŠ\tM¤‹WjÂÔ¿Ú¼Žë¿\u001cÆwcêoæPÞ¤3ÊÑø\u0013\u001b’Âe#\u0014\bœ“×dw\u001cöNN\u0005§ÝÖ€Î\u00152\u001c5€<9-Ú¡cïÒ–›\tÙœ÷å4ê\u0014ßòRuïMó\u0012Ðyç£X_ä[-q¶C¹5Ç8\u001cÎJSô \u0015aA™Ó\u001eµY\u0010{3‰^Ø`¹\u0004ù'RB#Ð\u0006úÓã\u0002V ×ñoCM\u0017AB,ÕD\u0013r!…n\u0004†šŽ&D\u001d\u0005ý\u0018 Û“ò(@ ³½Äï^ö>\u0007À/‡Å‰E”\u000e™U \u000e:ê\u0007;0ô\u001cÙŠ16\u000f+Ø'ÛfÉJO£’\r\nendstream\r\nendobj\r\n23 0 obj\r\n<>>>/EncryptMetadata false/Filter/Standard/Length 128/O (÷+Õ%êMz6OÁ\\002plÉ\\034¨u.\\020†Óî\\030}\\005؇âXl)/P -1852/R 4/StmF/StdCF/StrF/StdCF/U (\\024<˜¥—óp䟗ÿ¸Ì\\002è\\000\\000\\000\\000\\000\\000\\000\\000\\000\\000\\000\\000\\000\\000\\000\\000)/V 4>>\r\nendobj\r\nxref\r\n0 24\r\n0000000010 65535 f \r\n0000002863 00000 n \r\n0000003401 00000 n \r\n0000003659 00000 n \r\n0000003745 00000 n \r\n0000002707 00000 n \r\n0000003782 00000 n \r\n0000003911 00000 n \r\n0000002818 00000 n \r\n0000000015 00000 n \r\n0000000017 00001 f \r\n0000003488 00000 n \r\n0000003640 00000 n \r\n0000005663 00000 n \r\n0000005889 00000 n \r\n0000004039 00000 n \r\n0000004486 00000 n \r\n0000000022 00001 f \r\n0000009907 00000 n \r\n0000010092 00000 n \r\n0000004922 00000 n \r\n0000005275 00000 n \r\n0000000000 00001 f \r\n0000012574 00000 n \r\ntrailer\r\n<<3839e8b93935fb4ad454e7999428a671>]/Info 1 0 R/Root 8 0 R/Size 24>>\r\n%iText-7.1.13 for .NET\r\nstartxref\r\n12880\r\n%%EOF\r\n"}],"_postman_id":"b32eb466-82dc-4d02-aaba-0572d7990826"}],"id":"b897f948-dc81-4b52-8157-68e6bed116c8","description":"This API is used to list employee's payslips for given period with basic details about the gross/net payments, and a hyperlink to the physical copy of the document.
\nThe authorisation used in these requests is Bearer token authorisation where the token is encrypted using x509 private key pair.
\nThe API is disabled by default, i.e. if the company is not configured to work with it, and there is no pay group associated with it, no one will be able to access the information by just \"playing\" with it. The API is also using unique GUIDs for each company and file. This means that a user can see only the information relevant for them and they will be unable to access other customers data. Also, having GUIDs for each company and file, makes difficult for unauthorized parties to get information as GUIDs are hard to be hacked.
\nHow the API works:
\n\n- Authorization - the customer must provide the following claims issuer and audience, and the public key of the already generated x509 key-pair. Immedis will store this information within the customer's external configuration. Immedis will provide an unique URL (with a GUID imbedded within the URL) to the customer which they should use to access employee's information. In case that someone tries to get information with invalid token, the API will return 401. The customer must also provide their organization ID, name and code to Immedis, so they can setup those details on pay group level. If there is a mismatch, the API will reject the request and will not return information to the client.
\n- Successful authorization - if the user provides a valid token (Immedis will check the issuer, audience and key and will compare them with what Immedis has on their side), then they can access employee's information. If the client is using Workday to get the data, Workday could reject Immedis' response if there is a discrepancy between the response for organization ID, name and code, and the pay cycle's start, end and salary dates. If the data matches, then Workday will present information to the end user.
\n
\nThis API is a different service from the one called \"External File Processing\". They are different features which Immedis can enable to a customer, but are not enabled by default, and are not accessible without proper permissions.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"6b0e836e-64ee-4150-90de-66252442fc5d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9425f5b3-e06e-4f92-8b6b-ad33a5aad622","type":"text/javascript","exec":[""]}}],"_postman_id":"b897f948-dc81-4b52-8157-68e6bed116c8"},{"name":"External File Processing API","item":[{"name":"Login","item":[{"name":"Generate token","id":"433f469b-565d-44e8-b0fa-3631a27942a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"username\": \"john.doe@immedis.test\",\n \"password\": \"P@ssw0rd\"\n}"},"url":"{{baseUrl}}/api/Token","description":"This request is used to generate dynamic token that could be used to run the other requests in the documentation. The user must have an active account in the public portal and Immedis should give him Public API access. The needed parameters are:
\n\n- username - mandatory parameter; the email used in the public portal platform
\n- password - mandatory parameter; the password used to login into the public portal.
\n
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"913b7099-83b8-4c34-b4cf-593cfbc567bd","id":"913b7099-83b8-4c34-b4cf-593cfbc567bd","name":"External File Processing API","type":"folder"}},"urlObject":{"path":["api","Token"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"ed9df04e-709a-42be-baab-c4e96e54d88c","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"username\": \"john.doe@immedis.test\",\n \"password\": \"P@ssw0rd\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/Token"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiSm9obl9Eb2UiLCJpc3N1cmVyX2FwaSI6IkV4dGVybmFsIiwiaWQiOiIxNTk1Iiwicm9sZSI6ImFwaV9hY2Nlc3MiLCJzdWIiOiJKb2huX0RvZSIsImp0aSI6IjViYjVhMzFmLTlmNGMtNGNiMC04YzVhLWVjNjNkNTQ5YmI0ZSIsImlhdCI6MTYyMDIxODI3MSwibmJmIjoxNjIwMjE4MjcwLCJleHAiOjE2MjAyMTg4NzAsImlzcyI6IkltbWVkaXMgQ1JNIEFwaSIsImF1ZCI6IioifQ.xVKyN7eeqqqPSVxboqRieEmnrZWxYonuCT59oOky3Yk"},{"id":"24e71d18-a5a4-48c7-82ab-f14f6306e966","name":"Unsuccessful login","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"username\": \"john.doe@immedis.test\",\n \"password\": \"WrongPass\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/Token"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":"null"}],"_postman_id":"433f469b-565d-44e8-b0fa-3631a27942a2"}],"id":"6615c148-1b96-4c62-82f5-e65f01307212","description":"Used to get a dynamic token which could be used to run the other available requests.
\n","_postman_id":"6615c148-1b96-4c62-82f5-e65f01307212","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"913b7099-83b8-4c34-b4cf-593cfbc567bd","id":"913b7099-83b8-4c34-b4cf-593cfbc567bd","name":"External File Processing API","type":"folder"}}},{"name":"Documents","item":[{"name":"Send integration changes","id":"13937045-8e0c-48f3-8e0f-e4f808041bd1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"key":"File","value":"Updates.xml","type":"text","description":"(Required)
\n"},{"key":"FileType","value":"PI_HCM","type":"text","description":"(Required)
\n"}]},"url":"{{baseUrl}}/api/Documents?Paygroup=IRL_Month","description":"This requests is used for inbound integrations.
\nParameters:
\n\n- Paygroup - mandatory parameter; URL parameter; specifies the pay group which will be updated with that request
\n- File - mandatory parameter form-data body parameter; blop used to send the actual file (usually an *.xml file);
\n- FileType - mandatory parameter; form-data body parameter; used to specify the type of the update (ask Immedis operator for the allowed file types in your pay group(s)).
\n
\nValidations:
\n\n- When a request is initiated, the system verifies if the token, received with that request, is valid (i.e. belongs to an existing company contact). If it's not, an appropriate error message will appear; the file will not be saved
\n- If the token is valid, the system checks if that user has permissions to the pay group specified in the request. If not - an appropriate error message appears; the file will not be saved
\n- If the user has permissions to send files for this pay group, the system verifies if there is a configured way of communication for the specified file type. If not, an appropriate error message will appear; the file will not be saved
\n- A payroll cycle should be opened and in relevant status in order to proceed with the execution of the request (contact Immedis for more information)
\n- If all validations passed, the system will return a successful message saying that the file has been received.
\n
\nExceptions:
\n\n- In case that the token used in the request has been expired, the system will return 401 error asking for a new token
\n- If the other services working with the External API are not running, the system will make the above validations and will store the file. However, it will return an error 500 saying that the user must contact Immedis for more information.
\n
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"73df5c52-935a-4456-993f-23b637becac7","id":"73df5c52-935a-4456-993f-23b637becac7","name":"Documents","type":"folder"}},"urlObject":{"path":["api","Documents"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"(Required)
\n","type":"text/plain"},"key":"Paygroup","value":"IRL_Month"}],"variable":[]}},"response":[{"id":"adf3c71d-0600-4009-a70f-6fde07f553c2","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer "},{"key":"Content-Type","value":"multipart/form-data","type":"text"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) ","key":"File","value":"Updates.xml","type":"text"},{"description":"(Required) ","key":"FileType","value":"PI_HCM","type":"text"}]},"url":{"raw":"{{baseUrl}}/api/Documents?Paygroup=IRL_Month","host":["{{baseUrl}}"],"path":["api","Documents"],"query":[{"key":"Paygroup","value":"IRL_Month"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":"{\n \"messages\": [\n \"The File Type PI_HCM:Updates.xml for Pay Group IRL_Month has been successfully received by Immedis.\"\n ],\n \"date\": \"2021-04-26T12:03:37.7666022+00:00\"\n}"},{"id":"f892f083-293c-43be-8c7e-74687f1cad5f","name":"Incorrect Pay Group ID","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"multipart/form-data","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"File","value":"Updates.xml","type":"text","description":"(Required) "},{"key":"FileType","value":"PI_HCM","type":"text","description":"(Required) "}]},"url":{"raw":"{{baseUrl}}/api/Documents?Paygroup=CHE_02","host":["{{baseUrl}}"],"path":["api","Documents"],"query":[{"key":"Paygroup","value":"CHE_02","description":"(Required) "}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"messages\": [\n \"The specified Pay Group CHE_02 was not found.\"\n ],\n \"date\": \"2021-04-26T12:06:11.1181359+00:00\"\n}"},{"id":"e7cf775d-3699-4dd8-89f9-d7a495085edd","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text","description":"Added as a part of security scheme: apikey"},{"key":"Content-Type","value":"multipart/form-data","type":"text"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) ","key":"File","value":"Updates.xml","type":"text"},{"description":"(Required) ","key":"FileType","value":"PI_HCM","type":"text"}]},"url":{"raw":"{{baseUrl}}/api/Documents?Paygroup=IRL_Month","host":["{{baseUrl}}"],"path":["api","Documents"],"query":[{"key":"Paygroup","value":"IRL_Month"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"862a06e0-49c3-4c9a-9e33-40c4dc1df63e","name":"Sending file to a pay group with a contact who has no access to it","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text","description":"Added as a part of security scheme: apikey"},{"key":"Content-Type","value":"multipart/form-data","type":"text"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) ","key":"File","value":"Updates.xml","type":"text"},{"description":"(Required) ","key":"FileType","value":"PI_HCM","type":"text"}]},"url":{"raw":"{{baseUrl}}/api/Documents?Paygroup=BGR_Month","host":["{{baseUrl}}"],"path":["api","Documents"],"query":[{"key":"Paygroup","value":"BGR_Month","type":"text"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"17d38250-cf7d-4c96-bfd5-6f6cec5016f8","name":"Not opened payroll cycle","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text","description":"Added as a part of security scheme: apikey"},{"key":"Content-Type","value":"multipart/form-data","type":"text"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) ","key":"File","value":"Updates.xml","type":"text"},{"description":"(Required) ","key":"FileType","value":"PI_HCM","type":"text"}]},"url":{"raw":"{{baseUrl}}/api/Documents?Paygroup=IRL_Month","host":["{{baseUrl}}"],"path":["api","Documents"],"query":[{"key":"Paygroup","value":"IRL_Month"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":"{\r\n \"messages\": [\r\n \"There is no open Payroll Cycle for Pay Group IRL_Month into which to receive the file, please contact Immedis.\"\r\n ],\r\n \"date\": \"2021-05-05T12:10:57.0968545+00:00\"\r\n}"},{"id":"1a9b7e1b-9a5a-4006-a5b0-a0891b67debd","name":"File Type not configured in Immedis","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text","description":"Added as a part of security scheme: apikey"},{"key":"Content-Type","value":"multipart/form-data","type":"text"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) ","key":"File","value":"Updates.xml","type":"text"},{"description":"(Required) ","key":"FileType","value":"PI_HCM","type":"text"}]},"url":{"raw":"{{baseUrl}}/api/Documents?Paygroup=IRL_Month","host":["{{baseUrl}}"],"path":["api","Documents"],"query":[{"key":"Paygroup","value":"IRL_Month"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":"{\r\n \"messages\": [\r\n \"The Pay Group IRL_Month is not configured to receive File Type PI_HCM.\"\r\n ],\r\n \"date\": \"2021-05-05T12:31:01.7961246+00:00\"\r\n}"}],"_postman_id":"13937045-8e0c-48f3-8e0f-e4f808041bd1"},{"name":"Send documents to the payroll log","id":"39172382-46a4-4f67-bb3a-b8c279e805c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"key":"File","value":"Updates.xlsx","type":"text","description":"(Required)
\n"},{"key":"FileType","value":"PI_CHG","type":"text","description":"(Required)
\n"},{"key":"AutoClose","value":"false","type":"text"},{"key":"AutoProcess","value":"false","type":"text"}]},"url":"{{baseUrl}}/api/Documents/v2?Paygroup=IRL_Month","description":"This request has the same structure as api/Documents. The only difference is that this request is not used for running live integrations, but it's used to send change files to the payroll operations team.
The validations are similar to those used in api/Documents.
The request is used to store files into the payroll log so Immedis users can process them. The files should contain the latest changes on customer's side.
One of the improvements that will be introduced in the future is enabling the user to process the file automatically.
\nParameters:
\n\nPaygroup - mandatory parameter; URL parameter; specifies the pay group which will be updated with that request
\nFile - mandatory parameter form-data body parameter; blop used to send the actual file (usually an *.xml file);
\nFileType - mandatory parameter; form-data body parameter; used to specify the type of the update (ask Immedis operator for the allowed file types in your pay group(s))
\nAutoClose - optional parameter; allows two values - true and false. In case that true is sent, the system will close the inputs automatically and the client will not be able to provide any details after this request; currently there is no logic implemented
\nAutoProcess) - **optional parameter;**allows two values - true and false. In case that true is sent, the platform will try to process the changes automatically; currently there is no logic implemented
\n
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"73df5c52-935a-4456-993f-23b637becac7","id":"73df5c52-935a-4456-993f-23b637becac7","name":"Documents","type":"folder"}},"urlObject":{"path":["api","Documents","v2"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"(Required)
\n","type":"text/plain"},"key":"Paygroup","value":"IRL_Month"}],"variable":[]}},"response":[{"id":"6fae4b78-2903-4a9a-8f56-de67ab0c9dc3","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text","description":"Added as a part of security scheme: apikey"},{"key":"Content-Type","value":"multipart/form-data","type":"text"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) ","key":"File","value":"Updates.xlsx","type":"text"},{"description":"(Required) ","key":"FileType","value":"PI_CHG","type":"text"},{"key":"AutoClose","value":"false","type":"text"},{"key":"AutoProcess","value":"false","type":"text"}]},"url":{"raw":"{{baseUrl}}/api/Documents/v2?Paygroup=IRL_Month","host":["{{baseUrl}}"],"path":["api","Documents","v2"],"query":[{"key":"Paygroup","value":"IRL_Month"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":"{\n \"messages\": [\n \"The File Type PI_HCM:Updates.xlsx for Pay Group IRL_Month has been successfully received by Immedis.\"\n ],\n \"date\": \"2021-04-26T12:03:37.7666022+00:00\"\n}"},{"id":"e3836476-058e-40d2-adcd-410631c369ad","name":"Incorrect Pay Group ID","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"multipart/form-data","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"File","value":"Updates.xml","type":"text","description":"(Required) "},{"key":"FileType","value":"PI_CHG","type":"text","description":"(Required) "},{"key":"AutoClose","value":"false","type":"text"},{"key":"AutoProcess","value":"false","type":"text"}]},"url":{"raw":"{{baseUrl}}/api/Documents/v2?Paygroup=CHE_02","host":["{{baseUrl}}"],"path":["api","Documents","v2"],"query":[{"key":"Paygroup","value":"CHE_02","description":"(Required) "}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"messages\": [\n \"The specified Pay Group CHE_02 was not found.\"\n ],\n \"date\": \"2021-04-26T12:06:11.1181359+00:00\"\n}"},{"id":"50ed33d9-e9d8-44be-9203-f70b4a050d17","name":"Not opened payroll cycle","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text","description":"Added as a part of security scheme: apikey"},{"key":"Content-Type","value":"multipart/form-data","type":"text"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) ","key":"File","value":"Updates.xml","type":"text"},{"description":"(Required) ","key":"FileType","value":"PI_CHG","type":"text"},{"key":"AutoClose","value":"false","type":"text"},{"key":"AutoProcess","value":"false","type":"text"}]},"url":{"raw":"{{baseUrl}}/api/Documents/v2?Paygroup=IRL_Month","host":["{{baseUrl}}"],"path":["api","Documents","v2"],"query":[{"key":"Paygroup","value":"IRL_Month"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":"{\r\n \"messages\": [\r\n \"There is no open Payroll Cycle for Pay Group IRL_Month into which to receive the file, please contact Immedis.\"\r\n ],\r\n \"date\": \"2021-05-05T12:10:57.0968545+00:00\"\r\n}"},{"id":"769bb0ee-9eb4-49c0-a465-bbada52cb2ab","name":"File Type not configured in Immedis","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text","description":"Added as a part of security scheme: apikey"},{"key":"Content-Type","value":"multipart/form-data","type":"text"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) ","key":"File","value":"Updates.xml","type":"text"},{"description":"(Required) ","key":"FileType","value":"PI_CHG","type":"text"},{"key":"AutoClose","value":"false","type":"text"},{"key":"AutoProcess","value":"false","type":"text"}]},"url":{"raw":"{{baseUrl}}/api/Documents/v2?Paygroup=IRL_Month","host":["{{baseUrl}}"],"path":["api","Documents","v2"],"query":[{"key":"Paygroup","value":"IRL_Month"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":"{\r\n \"messages\": [\r\n \"The Pay Group IRL_Month is not configured to receive File Type PI_CHG.\"\r\n ],\r\n \"date\": \"2021-05-05T12:31:01.7961246+00:00\"\r\n}"}],"_postman_id":"39172382-46a4-4f67-bb3a-b8c279e805c5"},{"name":"Import G2N data","id":"aa8b7668-13e1-4b81-8cc8-44ca9fb3a9a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"ElementIdentifierType\": 1,\r\n \"EmployeeIdentifierType\": 1,\r\n \"Employees\": [\r\n {\r\n \"Elements\": [\r\n {\r\n \"Amount\": 450.64,\r\n \"Id\": \"0IL\"\r\n }\r\n ],\r\n \"Id\": \"112150\"\r\n }\r\n ],\r\n \"PayGroup\": \"PG_ShortCode_145\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/Documents/UploadGtn","description":"The POST /api/Documents/UploadGtn endpoint is used to upload GTN documents. The request should include the following payload in raw JSON format:
\n{\n \"ElementIdentifierType\": 0,\n \"EmployeeIdentifierType\": 0,\n \"Employees\": [\n {\n \"Elements\": [\n {\n \"Amount\": 0,\n \"Id\": \"\"\n }\n ],\n \"Id\": \"\"\n }\n ],\n \"PayGroup\": \"\"\n}\n\n
\n\nElementIdentifierType - this property has two possible options:
\n\nEmployeeIdentifierType - this property has also two possible options:
\n\nPayGroup - the customer pay group ID stored in OneView
\nEmployees - an array with all employees incluged in the GTN and their pay elements. Each employee object contains an array \"Elements\" with the data which needs to be imported:
\n\n
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"73df5c52-935a-4456-993f-23b637becac7","id":"73df5c52-935a-4456-993f-23b637becac7","name":"Documents","type":"folder"}},"urlObject":{"path":["api","Documents","UploadGtn"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"6f94533b-8e27-4950-b35d-754177d011ff","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"ElementIdentifierType\": 1,\r\n \"EmployeeIdentifierType\": 1,\r\n \"Employees\": [\r\n {\r\n \"Elements\": [\r\n {\r\n \"Amount\": 450.64,\r\n \"Id\": \"0IL\"\r\n }\r\n ],\r\n \"Id\": \"112150\"\r\n }\r\n ],\r\n \"PayGroup\": \"PG_ShortCode_145\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/Documents/UploadGtn"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"messages\": [\n \"The json for Pay Group: PG_ShortCode_145 has been successfully received by Immedis.\"\n ],\n \"date\": \"2024-10-01T07:43:51.4278445+00:00\"\n}"},{"id":"41d723c2-086d-41e1-8c27-c23dcfbaf64c","name":"Unauthorized","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"ElementIdentifierType\": 1,\r\n \"EmployeeIdentifierType\": 1,\r\n \"Employees\": [\r\n {\r\n \"Elements\": [\r\n {\r\n \"Amount\": 450.64,\r\n \"Id\": \"0IL\"\r\n }\r\n ],\r\n \"Id\": \"112150\"\r\n }\r\n ],\r\n \"PayGroup\": \"PG_ShortCode_145\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/Documents/UploadGtn"},"status":"Unauthorized","code":401,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"df6f3fcc-6dec-404b-83da-3c0b3813a968","name":"Not found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"ElementIdentifierType\": 1,\r\n \"EmployeeIdentifierType\": 1,\r\n \"Employees\": [\r\n {\r\n \"Elements\": [\r\n {\r\n \"Amount\": 450.64,\r\n \"Id\": \"0IL\"\r\n }\r\n ],\r\n \"Id\": \"112150\"\r\n }\r\n ],\r\n \"PayGroup\": \"PG_ShortCode_145\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/Documents/UploadGtn"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"messages\": [\n \"The specified Pay Group 125848493 was not found.\"\n ],\n \"date\": \"2024-10-01T07:46:46.3571175+00:00\"\n}"},{"id":"c63797ba-ae1c-4f53-9b84-e4970ed471b0","name":"Forbidden","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"ElementIdentifierType\": 1,\r\n \"EmployeeIdentifierType\": 1,\r\n \"Employees\": [\r\n {\r\n \"Elements\": [\r\n {\r\n \"Amount\": 450.64,\r\n \"Id\": \"0IL\"\r\n }\r\n ],\r\n \"Id\": \"112150\"\r\n }\r\n ],\r\n \"PayGroup\": \"PG_ShortCode_145\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/Documents/UploadGtn"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"date\": \"2024-10-01T07:41:20.6470214+00:00\",\n \"messages\": [\n \"The specified user does not have access to Pay Group uk123.\"\n ]\n}"}],"_postman_id":"aa8b7668-13e1-4b81-8cc8-44ca9fb3a9a0"}],"id":"73df5c52-935a-4456-993f-23b637becac7","description":"The endpoints in this section are used to send documents from external clients to Immedis.
\n\n- /api/Documents is used by clients using HCM platforms to send their latest changes
\n- /api/Documents/v2 is used to send change files to the current cycle's payroll log.
\n
\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"2dfdcc9d-107c-4ddd-b9f1-2d814f296b88","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0ba566d5-db0e-49cd-ac68-78e0894e2717","type":"text/javascript","exec":[""]}}],"_postman_id":"73df5c52-935a-4456-993f-23b637becac7"},{"name":"Other requests","item":[{"name":"GET all available country specific information by country ISO-3 code","id":"a77fee1c-a3bd-4f7f-ad97-ba872c025a48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/api/CountrySpecificInformation/country-specific-informations/:countryCode","description":"This request is used to get all available country specific fields in Immedis.
\nThe API has the following response:
\n\n- \ncountryCode - the ISO-3 country code\n
\n- \ncountrySpecificInformationGroups - an array listing all CSIs by type\n
\n- \ngroup - the name of the CSI group (possible options are National Identifiers, Contact Information, Statistical Reporting, Working Pattern)\n
\n- \nfields - an array with all CSIs under the specified group\n
\n- \nshortCode - the code used for saving information\n
\n- \ndescription - description of the CSI\n
\n- \nlocalDescription - the CSI's description in the selected country\n
\n- \ninformationType - the type of the CSI - Text, List of Values, Document, Country, Date\n
\n- \noptionality - the optionality of the CSI - Required, Preferred, Optional\n
\n- \ntextValueRegex - if the informationType is Text, this parameter will return the REGEX validation added for that field\n
\n- \nlistOfValues - if the informationType is List of Values, this parameter will return an array with all available values\n
\n- \nconditional - has two values - true and false. If it's set to true, this means that this CSI can be used only if its \"parent\" CSI has value against the employee's record\n
\n- \nparentKey - returns a value if the conditional parameter is set to true. It will be populated with the parent's short code.\n
\n
\n \n
\n \n
","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"913b7099-83b8-4c34-b4cf-593cfbc567bd","id":"913b7099-83b8-4c34-b4cf-593cfbc567bd","name":"External File Processing API","type":"folder"}},"urlObject":{"path":["api","CountrySpecificInformation","country-specific-informations",":countryCode"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"4dc31c42-aa63-43ac-bb18-88402a134828","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"IRL","key":"countryCode"}]}},"response":[{"id":"d0d020d4-445e-4782-a9e4-ba47e8f7ea1f","name":"Success","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"{{baseUrl}}/api/CountrySpecificInformation/country-specific-informations/:countryCode","host":["{{baseUrl}}"],"path":["api","CountrySpecificInformation","country-specific-informations",":countryCode"],"variable":[{"key":"countryCode","value":"IRL"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"countryCode\": \"IRL\",\n \"countrySpecificInformationGroups\": [\n {\n \"group\": \"National Identifiers\",\n \"fields\": [\n {\n \"shortCode\": \"CSI_TAX_NUM\",\n \"description\": \"Enter Employee Personal Public Service Number (PPS No). The format of the number is a unique alphanumeric in the general form 1234567A or 1234567AB. In cases where the PPS no is not provided then there will be negative tax consequences an emergency tax will be withheld from the employees paycheck until such time that this PPS no is provided.\",\n \"localDescription\": \"Personal Public Service Number (PPS no)\",\n \"informationType\": \"Text\",\n \"optionality\": \"Preferred\",\n \"textValueRegex\": \"^[ ]$|^([0-9]{7}[A-Z]{1,2})$\",\n \"listOfValues\": null,\n \"conditional\": false,\n \"parentKey\": null\n },\n {\n \"shortCode\": \"CSI_PAYROLL_ID\",\n \"description\": \"Enter Employee Payroll ID registered with Revenue, please note that this is different to the employee work number. Will vary according to employment. \",\n \"localDescription\": \"Revenue ID (Employment ID)\",\n \"informationType\": \"Text\",\n \"optionality\": \"Preferred\",\n \"textValueRegex\": null,\n \"listOfValues\": null,\n \"conditional\": false,\n \"parentKey\": null\n }\n ]\n },\n {\n \"group\": \"Contract Information\",\n \"fields\": [\n {\n \"shortCode\": \"CSI_WORKING_PATTERN_TYPE\",\n \"description\": \"Contract Type. Default is Full Time.\",\n \"localDescription\": \"Contract Type\",\n \"informationType\": \"List Of Values\",\n \"optionality\": \"Required\",\n \"textValueRegex\": \"\",\n \"listOfValues\": [\n \"Part Time\",\n \"Full Time\"\n ],\n \"conditional\": false,\n \"parentKey\": null\n },\n {\n \"shortCode\": \"CSI_EMPLOYMENT_TYPE\",\n \"description\": \"Contract of Employment Type. Default value is Permanent.\",\n \"localDescription\": \"Contract of Employment Type\",\n \"informationType\": \"List Of Values\",\n \"optionality\": \"Required\",\n \"textValueRegex\": \"\",\n \"listOfValues\": [\n \"Job Share\",\n \"Contract\",\n \"Casual\",\n \"Temporary\",\n \"Permanent\"\n ],\n \"conditional\": false,\n \"parentKey\": null\n },\n {\n \"shortCode\": \"CSI_WEEKLY_HOURS\",\n \"description\": \"Enter number of hours per week (E.g. 40 hrs/week) that the person normally works. No impact on payroll or revenue if this is not provided but can be used for advanced reporting.\",\n \"localDescription\": \"Weekly Hours\",\n \"informationType\": \"Text\",\n \"optionality\": \"Preferred\",\n \"textValueRegex\": \"\\\\b([0-9]|[1-4][0-9]|50)\\\\b\",\n \"listOfValues\": null,\n \"conditional\": false,\n \"parentKey\": null\n }\n ]\n },\n {\n \"group\": \"Statistical Reporting\",\n \"fields\": [\n {\n \"shortCode\": \"CSI_STATISTICAL_CONTRACT_TYPE\",\n \"description\": \"Type of Employment Contracts - only required where Immedis is providing additional CSO reporting service. \\n\",\n \"localDescription\": \"Type of Employment Contract\",\n \"informationType\": \"List Of Values\",\n \"optionality\": \"Preferred\",\n \"textValueRegex\": \"\",\n \"listOfValues\": [\n \"Indefinite\",\n \"Fixed\",\n \"Apprentice\"\n ],\n \"conditional\": false,\n \"parentKey\": null\n },\n {\n \"shortCode\": \"CSI_STATISTICAL_CONTRACT_CATEGORY\",\n \"description\": \"Occupational Category - only required where Immedis is providing additional CSO reporting service. \\n\",\n \"localDescription\": \"Occupation Category\",\n \"informationType\": \"List Of Values\",\n \"optionality\": \"Preferred\",\n \"textValueRegex\": \"\",\n \"listOfValues\": [\n \"Other Manual Workers\",\n \"Craft & Tradespersons\",\n \"Transport Workers\",\n \"SaleService Workers Production\",\n \"Professionals & Associate Professional Clerical\",\n \"Managers\"\n ],\n \"conditional\": false,\n \"parentKey\": null\n },\n {\n \"shortCode\": \"CSI_DAILY_HOURS\",\n \"description\": \"Enter employee's hours per working day - only required where Immedis is providing additional CSO reporting service. \\n\",\n \"localDescription\": \"Hours per Working Day\",\n \"informationType\": \"Text\",\n \"optionality\": \"Preferred\",\n \"textValueRegex\": null,\n \"listOfValues\": null,\n \"conditional\": false,\n \"parentKey\": null\n },\n {\n \"shortCode\": \"CSI_MONTHLY_HOURS\",\n \"description\": \"Enter employee's monthly contracted hours of employment - only required where Immedis is providing additional CSO reporting service.\",\n \"localDescription\": \"Contracted Hours\",\n \"informationType\": \"Text\",\n \"optionality\": \"Preferred\",\n \"textValueRegex\": null,\n \"listOfValues\": null,\n \"conditional\": false,\n \"parentKey\": null\n },\n {\n \"shortCode\": \"CSI_STATISTICAL_CODE\",\n \"description\": \"Statistical Code - only required where Immedis is providing additional CSO reporting service. Default is Not included for NES.\",\n \"localDescription\": \"Statistical Code\",\n \"informationType\": \"List Of Values\",\n \"optionality\": \"Preferred\",\n \"textValueRegex\": \"\",\n \"listOfValues\": [\n \"Mgr Physical, mathematical and engineering science professionals\",\n \"Mgr Managers of small enterprises\",\n \"Mgr Corporate managers\",\n \"Mgr Legislators and senior officials\",\n \"Not included for NES\",\n \"Ot Labourers in mining, construction, manufacturing and transport\",\n \"Ot Agricultural, fishery and related labourers\",\n \"Ot Sales and services elementary occupations\",\n \"Ot Drivers and mobile plant operators\",\n \"Ot Machine operators and assemblers\",\n \"Ot Stationary plant and related operators\",\n \"Ot Other craft and related trades workers\",\n \"Ot Precision, handicraft, craft printing and related trades workers\",\n \"Ot Metal, machinery and related trades workers\",\n \"Ot Extraction and building trades workers\",\n \"Ot Skilled agricultural and fishery workers1\",\n \"CI Models, salespersons and demonstrators\",\n \"CI Personal and protective services workers\",\n \"CI Customer services clerks\",\n \"CI Office clerks\",\n \"Mgr Other associate professionals\",\n \"Mgr Teaching associate professionals\",\n \"Mgr Life science and health associate professionals\",\n \"Mgr Physical and engineering science associate professionals\",\n \"Mgr Other professionals\",\n \"Mgr Teaching professionals\",\n \"Mgr Life science and health professionals\"\n ],\n \"conditional\": false,\n \"parentKey\": null\n },\n {\n \"shortCode\": \"CSI_STATISTICAL_EMPL_TYPE\",\n \"description\": \"Statistical Employee Type - only required where Immedis is providing additional CSO reporting service. Default is Full-time.\",\n \"localDescription\": \"Statistical Employee Type\",\n \"informationType\": \"List Of Values\",\n \"optionality\": \"Preferred\",\n \"textValueRegex\": \"\",\n \"listOfValues\": [\n \"Other\",\n \"Full-time\",\n \"Part-time\"\n ],\n \"conditional\": true,\n \"parentKey\": {\n \"shortCode\": \"CSI_STATISTICAL_CODE\",\n \"conditionalValue\": [\n \"CI Models, salespersons and demonstrators\",\n \"CI Office clerks\",\n \"CI Personal and protective services workers\",\n \"Mgr Corporate managers\",\n \"Mgr Legislators and senior officials\",\n \"Mgr Life science and health associate professionals\",\n \"Mgr Life science and health professionals\",\n \"Mgr Managers of small enterprises\",\n \"Mgr Other associate professionals\",\n \"Mgr Other professionals\",\n \"Mgr Physical and engineering science associate professionals\",\n \"Mgr Physical, mathematical and engineering science professionals\",\n \"Mgr Teaching associate professionals\",\n \"Mgr Teaching professionals\",\n \"Ot Agricultural, fishery and related labourers\",\n \"Ot Drivers and mobile plant operators\",\n \"Ot Extraction and building trades workers\",\n \"Ot Labourers in mining, construction, manufacturing and transport\",\n \"Ot Machine operators and assemblers\",\n \"Ot Metal, machinery and related trades workers\",\n \"Ot Other craft and related trades workers\",\n \"Ot Precision, handicraft, craft printing and related trades workers\",\n \"Ot Sales and services elementary occupations\",\n \"Ot Skilled agricultural and fishery workers1\",\n \"Ot Stationary plant and related operators\",\n \"CI Customer services clerks\"\n ]\n }\n }\n ]\n },\n {\n \"group\": \"Working Pattern\",\n \"fields\": [\n {\n \"shortCode\": \"CSI_WORKING_PATTERN_A_MONDAY\",\n \"description\": \"Is Monday a typical workday? If Monday is a standard working day, enter Yes. If it is not, enter No. Default value is Yes.\",\n \"localDescription\": \"Is Monday a Working Day?\",\n \"informationType\": \"List Of Values\",\n \"optionality\": \"Required\",\n \"textValueRegex\": \"\",\n \"listOfValues\": [\n \"No\",\n \"Yes\"\n ],\n \"conditional\": false,\n \"parentKey\": null\n },\n {\n \"shortCode\": \"CSI_WORKING_PATTERN_B_TUESDAY\",\n \"description\": \"Is Tuesday a typical workday? If Tuesday is a standard working day, enter Yes. If it is not, enter No. Default value is Yes.\",\n \"localDescription\": \"Is Tuesday a Working Day?\",\n \"informationType\": \"List Of Values\",\n \"optionality\": \"Required\",\n \"textValueRegex\": \"\",\n \"listOfValues\": [\n \"No\",\n \"Yes\"\n ],\n \"conditional\": false,\n \"parentKey\": null\n },\n {\n \"shortCode\": \"CSI_WORKING_PATTERN_C_WEDNESDAY\",\n \"description\": \"Is Wednesday a typical workday? If Wednesday is a standard working day, enter Yes. If it is not, enter No. Default value is Yes.\",\n \"localDescription\": \"Is Wednesday a Working Day?\",\n \"informationType\": \"List Of Values\",\n \"optionality\": \"Required\",\n \"textValueRegex\": \"\",\n \"listOfValues\": [\n \"No\",\n \"Yes\"\n ],\n \"conditional\": false,\n \"parentKey\": null\n },\n {\n \"shortCode\": \"CSI_WORKING_PATTERN_D_THURSDAY\",\n \"description\": \"Is Thursday a typical workday? If Thursday is a standard working day, enter Yes. If it is not, enter No. Default value is Yes.\",\n \"localDescription\": \"Is Thursday a Working Day?\",\n \"informationType\": \"List Of Values\",\n \"optionality\": \"Required\",\n \"textValueRegex\": \"\",\n \"listOfValues\": [\n \"No\",\n \"Yes\"\n ],\n \"conditional\": false,\n \"parentKey\": null\n },\n {\n \"shortCode\": \"CSI_WORKING_PATTERN_E_FRIDAY\",\n \"description\": \"Is Friday a typical workday? If Friday is a standard working day, enter Yes. If it is not, enter No. Default value is Yes.\",\n \"localDescription\": \"Is Friday a Working Day?\",\n \"informationType\": \"List Of Values\",\n \"optionality\": \"Required\",\n \"textValueRegex\": \"\",\n \"listOfValues\": [\n \"No\",\n \"Yes\"\n ],\n \"conditional\": false,\n \"parentKey\": null\n },\n {\n \"shortCode\": \"CSI_WORKING_PATTERN_F_SATURDAY\",\n \"description\": \"Is Saturday a typical workday? If Saturday is a standard working day, enter Yes. If it is not, enter No. Default value is No.\",\n \"localDescription\": \"Is Saturday a Working Day?\",\n \"informationType\": \"List Of Values\",\n \"optionality\": \"Required\",\n \"textValueRegex\": \"\",\n \"listOfValues\": [\n \"No\",\n \"Yes\"\n ],\n \"conditional\": false,\n \"parentKey\": null\n },\n {\n \"shortCode\": \"CSI_WORKING_PATTERN_G_SUNDAY\",\n \"description\": \"Is Sunday a typical workday? If Sunday is a standard working day, enter Yes. If it is not, enter No. Default value is No.\",\n \"localDescription\": \"Is Sunday a Working Day?\",\n \"informationType\": \"List Of Values\",\n \"optionality\": \"Required\",\n \"textValueRegex\": \"\",\n \"listOfValues\": [\n \"No\",\n \"Yes\"\n ],\n \"conditional\": false,\n \"parentKey\": null\n }\n ]\n }\n ]\n}"},{"id":"aeb91d0e-1fbf-48b2-a5ff-d907c87d1b97","name":"Incorrect ISO-3 code","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"{{baseUrl}}/api/CountrySpecificInformation/country-specific-informations/:countryCode","host":["{{baseUrl}}"],"path":["api","CountrySpecificInformation","country-specific-informations",":countryCode"],"variable":[{"key":"countryCode","value":"DDD"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"messages\": [\n \"There is no country specific info for country with code DDD.\"\n ],\n \"date\": \"2021-05-05T13:58:31.6168602+00:00\"\n}"}],"_postman_id":"a77fee1c-a3bd-4f7f-ad97-ba872c025a48"}],"id":"f717ddc8-a270-4472-afb4-8ef7499885bd","_postman_id":"f717ddc8-a270-4472-afb4-8ef7499885bd","description":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"913b7099-83b8-4c34-b4cf-593cfbc567bd","id":"913b7099-83b8-4c34-b4cf-593cfbc567bd","name":"External File Processing API","type":"folder"}}}],"id":"913b7099-83b8-4c34-b4cf-593cfbc567bd","description":"This documentation represents the so-called \"Immedis External API\". It's used by clients to send files with updates for their employees.
\nThe authorization used in those requests is Bearer Token. There is only one way at the moment to get a token - using the api/Token endpoint with valid credentials. In order to do that:
\n\n- Immedis must provide a valid account to the client;
\n- The client must set a password and configure their integration to work with it;
\n- Immedis must configure this user to send files to the system. Note that the user will be able to do only that and no one will be able to use it for accessing other services or information;
\n- Immedis must configure the user to be able to send documents for the agreed pay groups.
\n
\nIf there is mismatch between the 4 points above and what the client is sending as a token, the API will return an error and will not store the file.
\nNote: This user will be unable to access the other service mentioned here - Immedis External Payslips API.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"f3328438-dbc9-4f3a-a0f4-aa27c45278a2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c25f2c9b-88fe-47d8-bb86-0c65914c9691","type":"text/javascript","exec":[""]}}],"_postman_id":"913b7099-83b8-4c34-b4cf-593cfbc567bd"}]}