· 6 years ago · Jan 06, 2020, 04:18 PM
1{
2 "swagger": "2.0",
3 "info": {
4 "version": "1.2.0",
5 "title": "",
6 "description": "System Operations Microservice",
7 "termsOfService": "http://taxnexus.net/terms/",
8 "contact": {
9 "email": "noc@taxnexus.net"
10 },
11 "license": {
12 "name": "Proprietary - Copyright (c) 2018-2019 by Taxnexus, Inc."
13 },
14 "x-apisguru-categories": ["compliance", "cannabis", "tax"],
15 "x-origin": [
16 {
17 "format": "swagger",
18 "url": "https://docs.taxnexus.net/taxnexus-swagger.json",
19 "version": "2.0"
20 }
21 ],
22 "x-providerName": "Taxnexus.net"
23 },
24 "securityDefinitions": {
25 "ApiKeyAuth": {
26 "type": "apiKey",
27 "in": "header",
28 "name": "X-API-Key"
29 }
30 },
31 "security": [
32 {
33 "ApiKeyAuth": []
34 }
35 ],
36 "schemes": ["https"],
37 "basePath": "devops/v1",
38 "host": "api.taxnexus.net",
39 "consumes": ["application/json"],
40 "produces": ["application/json"],
41 "parameters": {
42 "accountIdQuery": {
43 "description": "Taxnexus Record Id of an Account",
44 "in": "query",
45 "name": "accountId",
46 "required": false,
47 "type": "string"
48 },
49 "accountNumberQuery": {
50 "description": "The Taxnexus Account Number of the Account to be used a record retrieval",
51 "in": "query",
52 "name": "accountNumber",
53 "required": false,
54 "type": "string"
55 },
56 "apiKeyQuery": {
57 "description": "Service account or developer API key",
58 "in": "query",
59 "name": "apikey",
60 "type": "string"
61 },
62 "companyIdQuery": {
63 "description": "Taxnexus Record Id of a Company",
64 "in": "query",
65 "name": "companyId",
66 "required": false,
67 "type": "string"
68 },
69 "ingestIdQuery": {
70 "description": "Taxnexus Record Id of an Ingest",
71 "in": "query",
72 "name": "ingestId",
73 "required": false,
74 "type": "string"
75 },
76 "ingestRequest": {
77 "description": "An array of new Ingest records",
78 "in": "body",
79 "name": "ingestRequest",
80 "required": true,
81 "schema": {
82 "$ref": "#/definitions/ingestRequest"
83 }
84 },
85 "jobIdQuery": {
86 "description": "Taxnexus Record Id of a Job",
87 "in": "query",
88 "name": "jobId",
89 "required": false,
90 "type": "string"
91 },
92 "jobRequest": {
93 "description": "An array of new Job records",
94 "in": "body",
95 "name": "jobRequest",
96 "required": true,
97 "schema": {
98 "$ref": "#/definitions/jobRequest"
99 }
100 },
101 "limitQuery": {
102 "default": 100,
103 "description": "How many objects to return at one time (max 300, default 100)",
104 "format": "int32",
105 "in": "query",
106 "name": "limit",
107 "required": false,
108 "type": "integer"
109 },
110 "offsetQuery": {
111 "default": 0,
112 "description": "How many objects to skip? (default 0)",
113 "format": "int32",
114 "in": "query",
115 "name": "offset",
116 "required": false,
117 "type": "integer"
118 },
119 "queueRequest": {
120 "description": "An array of new Queue commands",
121 "in": "body",
122 "name": "queueRequest",
123 "required": true,
124 "schema": {
125 "$ref": "#/definitions/queueRequest"
126 }
127 },
128 "userIdQuery": {
129 "description": "Service account or developer API key",
130 "in": "query",
131 "name": "userId",
132 "type": "string"
133 },
134 "userRequest": {
135 "description": "An array of user records",
136 "in": "body",
137 "name": "UserRequest",
138 "required": true,
139 "schema": {
140 "$ref": "#/definitions/UserRequest"
141 }
142 }
143 },
144 "responses": {
145 "DeveopsDeleteResponse": {
146 "description": "Taxnexus Response with Message Objects with Delete Status",
147 "schema": {
148 "$ref": "#/definitions/DeleteResponse"
149 }
150 },
151 "AccessForbidden": {
152 "description": "Access forbidden, account lacks access",
153 "schema": {
154 "$ref": "#/definitions/Error"
155 }
156 },
157 "NotFound": {
158 "description": "Resource was not found",
159 "schema": {
160 "$ref": "#/definitions/Error"
161 }
162 },
163 "PostResponse": {
164 "description": "Taxnexus Response with an array of Message objects in response to a POST -> [\"ref\", \"id\"]",
165 "schema": {
166 "$ref": "#/definitions/PostResponse"
167 }
168 },
169 "PutResponse": {
170 "description": "Taxnexus Response with an array of Message objects in response to a PUT",
171 "schema": {
172 "$ref": "#/definitions/PutResponse"
173 }
174 },
175 "ServerError": {
176 "description": "Server Internal Error",
177 "schema": {
178 "$ref": "#/definitions/Error"
179 }
180 },
181 "Unauthorized": {
182 "description": "Access Unauthorized, invalid API-KEY was used",
183 "schema": {
184 "$ref": "#/definitions/Error"
185 }
186 },
187 "UnprocessableEntity": {
188 "description": "Unprocessable Entity, likely a bad parameter",
189 "schema": {
190 "$ref": "#/definitions/Error"
191 }
192 },
193 "IngestResponse": {
194 "description": "Taxnexus Response with Ingest objects",
195 "schema": {
196 "$ref": "#/definitions/IngestResponse"
197 }
198 },
199 "JobResponse": {
200 "description": "Taxnexus Response with Job objects",
201 "schema": {
202 "$ref": "#/definitions/JobResponse"
203 }
204 },
205 "QueueResponse": {
206 "description": "Taxnexus Response with Queue objects",
207 "schema": {
208 "$ref": "#/definitions/QueueResponse"
209 }
210 },
211 "UserResponse": {
212 "description": "Taxnexus Response with User objects",
213 "schema": {
214 "$ref": "#/definitions/UserResponse"
215 }
216 }
217 },
218 "paths": {
219 "/ingests": {
220 "get": {
221 "summary": "Get a list Ingests",
222 "operationId": "getIngests",
223 "description": "Return a list of Print-Ready Ingest records",
224 "parameters": [
225 {
226 "$ref": "#/parameters/accountIdQuery"
227 },
228 {
229 "$ref": "#/parameters/companyIdQuery"
230 },
231 {
232 "$ref": "#/parameters/ingestIdQuery"
233 },
234 {
235 "$ref": "#/parameters/limitQuery"
236 },
237 {
238 "$ref": "#/parameters/offsetQuery"
239 }
240 ],
241 "tags": ["Ingest"],
242 "responses": {
243 "200": {
244 "$ref": "#/responses/IngestResponse"
245 },
246 "401": {
247 "$ref": "#/responses/Unauthorized"
248 },
249 "403": {
250 "$ref": "#/responses/AccessForbidden"
251 },
252 "404": {
253 "$ref": "#/responses/NotFound"
254 },
255 "422": {
256 "$ref": "#/responses/UnprocessableEntity"
257 },
258 "500": {
259 "$ref": "#/responses/ServerError"
260 }
261 }
262 },
263 "post": {
264 "tags": ["Ingest"],
265 "summary": "Create new Ingests",
266 "operationId": "postIngests",
267 "description": "Create new Ingests",
268 "parameters": [
269 {
270 "$ref": "#/parameters/ingestRequest"
271 }
272 ],
273 "responses": {
274 "200": {
275 "$ref": "#/responses/IngestResponse"
276 },
277 "401": {
278 "$ref": "#/responses/Unauthorized"
279 },
280 "403": {
281 "$ref": "#/responses/AccessForbidden"
282 },
283 "404": {
284 "$ref": "#/responses/NotFound"
285 },
286 "422": {
287 "$ref": "#/responses/UnprocessableEntity"
288 },
289 "500": {
290 "$ref": "#/responses/ServerError"
291 }
292 }
293 },
294 "put": {
295 "tags": ["Ingest"],
296 "summary": "Update Ingests",
297 "operationId": "putIngests",
298 "description": "Update Ingests",
299 "parameters": [
300 {
301 "$ref": "#/parameters/ingestRequest"
302 }
303 ],
304 "responses": {
305 "200": {
306 "$ref": "#/responses/IngestResponse"
307 },
308 "401": {
309 "$ref": "#/responses/Unauthorized"
310 },
311 "403": {
312 "$ref": "#/responses/AccessForbidden"
313 },
314 "404": {
315 "$ref": "#/responses/NotFound"
316 },
317 "422": {
318 "$ref": "#/responses/UnprocessableEntity"
319 },
320 "500": {
321 "$ref": "#/responses/ServerError"
322 }
323 }
324 }
325 },
326 "/jobs": {
327 "get": {
328 "summary": "Get a list Jobs",
329 "operationId": "getJobs",
330 "description": "Return a list of Job records from the datastore",
331 "parameters": [
332 {
333 "$ref": "#/parameters/accountIdQuery"
334 },
335 {
336 "$ref": "#/parameters/companyIdQuery"
337 },
338 {
339 "$ref": "#/parameters/jobIdQuery"
340 },
341 {
342 "$ref": "#/parameters/limitQuery"
343 },
344 {
345 "$ref": "#/parameters/offsetQuery"
346 }
347 ],
348 "tags": ["Job"],
349 "responses": {
350 "200": {
351 "$ref": "#/responses/JobResponse"
352 },
353 "401": {
354 "$ref": "#/responses/Unauthorized"
355 },
356 "403": {
357 "$ref": "#/responses/AccessForbidden"
358 },
359 "404": {
360 "$ref": "#/responses/NotFound"
361 },
362 "422": {
363 "$ref": "#/responses/UnprocessableEntity"
364 },
365 "500": {
366 "$ref": "#/responses/ServerError"
367 }
368 }
369 },
370 "post": {
371 "tags": ["Job"],
372 "summary": "Create new Jobs",
373 "operationId": "postJobs",
374 "description": "Create and enqueue Jobs in Taxnexus",
375 "parameters": [
376 {
377 "$ref": "#/parameters/jobRequest"
378 }
379 ],
380 "responses": {
381 "200": {
382 "$ref": "#/responses/PostResponse"
383 },
384 "401": {
385 "$ref": "#/responses/Unauthorized"
386 },
387 "403": {
388 "$ref": "#/responses/AccessForbidden"
389 },
390 "404": {
391 "$ref": "#/responses/NotFound"
392 },
393 "422": {
394 "$ref": "#/responses/UnprocessableEntity"
395 },
396 "500": {
397 "$ref": "#/responses/ServerError"
398 }
399 }
400 },
401 "put": {
402 "tags": ["Job"],
403 "summary": "Update Jobs",
404 "operationId": "putJobs",
405 "description": "Update Jobs in Taxnexus",
406 "parameters": [
407 {
408 "$ref": "#/parameters/jobRequest"
409 }
410 ],
411 "responses": {
412 "200": {
413 "$ref": "#/responses/PutResponse"
414 },
415 "401": {
416 "$ref": "#/responses/Unauthorized"
417 },
418 "403": {
419 "$ref": "#/responses/AccessForbidden"
420 },
421 "404": {
422 "$ref": "#/responses/NotFound"
423 },
424 "422": {
425 "$ref": "#/responses/UnprocessableEntity"
426 },
427 "500": {
428 "$ref": "#/responses/ServerError"
429 }
430 }
431 }
432 },
433 "/queues": {
434 "get": {
435 "summary": "Get a list Queues",
436 "operationId": "getQueues",
437 "description": "Return a list of Queue records from the datastore",
438 "parameters": [
439 {
440 "$ref": "#/parameters/accountIdQuery"
441 },
442 {
443 "$ref": "#/parameters/accountNumberQuery"
444 },
445 {
446 "$ref": "#/parameters/companyIdQuery"
447 },
448 {
449 "$ref": "#/parameters/ingestIdQuery"
450 },
451 {
452 "$ref": "#/parameters/limitQuery"
453 },
454 {
455 "$ref": "#/parameters/offsetQuery"
456 }
457 ],
458 "tags": ["Queue"],
459 "responses": {
460 "200": {
461 "$ref": "#/responses/QueueResponse"
462 },
463 "401": {
464 "$ref": "#/responses/Unauthorized"
465 },
466 "403": {
467 "$ref": "#/responses/AccessForbidden"
468 },
469 "404": {
470 "$ref": "#/responses/NotFound"
471 },
472 "422": {
473 "$ref": "#/responses/UnprocessableEntity"
474 },
475 "500": {
476 "$ref": "#/responses/ServerError"
477 }
478 }
479 },
480 "post": {
481 "tags": ["Queue"],
482 "summary": "Create new Queue Entries",
483 "operationId": "postQueues",
484 "description": "Command Queue Actions in Taxnexus",
485 "parameters": [
486 {
487 "$ref": "#/parameters/queueRequest"
488 }
489 ],
490 "responses": {
491 "200": {
492 "$ref": "#/responses/PostResponse"
493 },
494 "401": {
495 "$ref": "#/responses/Unauthorized"
496 },
497 "403": {
498 "$ref": "#/responses/AccessForbidden"
499 },
500 "404": {
501 "$ref": "#/responses/NotFound"
502 },
503 "422": {
504 "$ref": "#/responses/UnprocessableEntity"
505 },
506 "500": {
507 "$ref": "#/responses/ServerError"
508 }
509 }
510 },
511 "put": {
512 "tags": ["Queue"],
513 "summary": "Update Queue Entries",
514 "operationId": "putQueues",
515 "description": "Command Queue Actions in Taxnexus",
516 "parameters": [
517 {
518 "$ref": "#/parameters/queueRequest"
519 }
520 ],
521 "responses": {
522 "200": {
523 "$ref": "#/responses/PostResponse"
524 },
525 "401": {
526 "$ref": "#/responses/Unauthorized"
527 },
528 "403": {
529 "$ref": "#/responses/AccessForbidden"
530 },
531 "404": {
532 "$ref": "#/responses/NotFound"
533 },
534 "422": {
535 "$ref": "#/responses/UnprocessableEntity"
536 },
537 "500": {
538 "$ref": "#/responses/ServerError"
539 }
540 }
541 }
542 },
543 "/users": {
544 "get": {
545 "summary": "Get a list Users",
546 "operationId": "getUsers",
547 "description": "Return a list of User records from the datastore",
548 "parameters": [
549 {
550 "$ref": "#/parameters/accountIdQuery"
551 },
552 {
553 "$ref": "#/parameters/apiKeyQuery"
554 },
555 {
556 "$ref": "#/parameters/limitQuery"
557 },
558 {
559 "$ref": "#/parameters/offsetQuery"
560 },
561 {
562 "$ref": "#/parameters/userIdQuery"
563 }
564 ],
565 "tags": ["User"],
566 "responses": {
567 "200": {
568 "$ref": "#/responses/UserResponse"
569 },
570 "401": {
571 "$ref": "#/responses/Unauthorized"
572 },
573 "403": {
574 "$ref": "#/responses/AccessForbidden"
575 },
576 "404": {
577 "$ref": "#/responses/NotFound"
578 },
579 "422": {
580 "$ref": "#/responses/UnprocessableEntity"
581 },
582 "500": {
583 "$ref": "#/responses/ServerError"
584 }
585 }
586 }
587 }
588 },
589 "definitions": {
590 "Address": {
591 "properties": {
592 "city": {
593 "description": "City",
594 "type": "string"
595 },
596 "country": {
597 "description": "Country full name",
598 "type": "string"
599 },
600 "countrycode": {
601 "description": "Country Code",
602 "type": "string"
603 },
604 "postalcode": {
605 "description": "Postal Code",
606 "type": "string"
607 },
608 "state": {
609 "description": "State full name",
610 "type": "string"
611 },
612 "statecode": {
613 "description": "State Code",
614 "type": "string"
615 },
616 "street": {
617 "description": "Street number and name",
618 "type": "string"
619 }
620 },
621 "type": "object"
622 },
623 "DeleteResponse": {
624 "properties": {
625 "data": {
626 "items": {
627 "$ref": "#/definitions/Message"
628 },
629 "type": "array"
630 },
631 "meta": {
632 "$ref": "#/definitions/ResponseMeta"
633 }
634 },
635 "type": "object"
636 },
637 "Error": {
638 "properties": {
639 "code": {
640 "format": "int32",
641 "type": "integer"
642 },
643 "fields": {
644 "type": "string"
645 },
646 "message": {
647 "type": "string"
648 }
649 },
650 "type": "object"
651 },
652 "Message": {
653 "properties": {
654 "message": {
655 "type": "string"
656 },
657 "ref": {
658 "type": "string"
659 },
660 "status": {
661 "default": 200,
662 "maximum": 600,
663 "minimum": 100,
664 "type": "integer"
665 }
666 },
667 "type": "object"
668 },
669 "Pagination": {
670 "properties": {
671 "limit": {
672 "format": "int32",
673 "type": "integer"
674 },
675 "pagesize": {
676 "format": "int32",
677 "type": "integer"
678 },
679 "poffset": {
680 "format": "int32",
681 "type": "integer"
682 },
683 "setsize": {
684 "format": "int32",
685 "type": "integer"
686 }
687 },
688 "type": "object"
689 },
690 "PostResponse": {
691 "properties": {
692 "data": {
693 "items": {
694 "$ref": "#/definitions/Message"
695 },
696 "type": "array"
697 },
698 "meta": {
699 "$ref": "#/definitions/ResponseMeta"
700 }
701 },
702 "type": "object"
703 },
704 "PutResponse": {
705 "properties": {
706 "data": {
707 "items": {
708 "$ref": "#/definitions/Message"
709 },
710 "type": "array"
711 },
712 "meta": {
713 "$ref": "#/definitions/ResponseMeta"
714 }
715 },
716 "type": "object"
717 },
718 "RequestMeta": {
719 "properties": {
720 "password": {
721 "description": "Salesforce Password",
722 "type": "string"
723 },
724 "taxnexusaccount": {
725 "description": "Taxnexus Account Number of the Reseller or OEM",
726 "type": "string"
727 },
728 "testonly": {
729 "default": false,
730 "description": "Set to TRUE to perform rating without saving ingest",
731 "type": "boolean"
732 },
733 "token": {
734 "description": "Salesforce Security Token",
735 "type": "string"
736 },
737 "username": {
738 "description": "Salesforce 'API User' User Name",
739 "type": "string"
740 }
741 },
742 "required": ["taxnexusaccount"],
743 "type": "object"
744 },
745 "ResponseMeta": {
746 "properties": {
747 "contact": {
748 "description": "Microservice Contact Info",
749 "type": "string"
750 },
751 "copyright": {
752 "description": "Copyright Info",
753 "type": "string"
754 },
755 "license": {
756 "description": "License Information and Restrictions",
757 "type": "string"
758 },
759 "operationid": {
760 "description": "Operation ID",
761 "type": "string"
762 },
763 "pagination": {
764 "$ref": "#/definitions/Pagination"
765 },
766 "requestip": {
767 "description": "Request IP Address",
768 "type": "string"
769 },
770 "requesttype": {
771 "description": "Request Type",
772 "type": "string"
773 },
774 "requesturl": {
775 "description": "Request URL",
776 "type": "string"
777 },
778 "serverinfo": {
779 "description": "Data Server Info",
780 "type": "string"
781 },
782 "serverresponsetime": {
783 "description": "Data Server Response Time (ms)",
784 "type": "string"
785 },
786 "servertimestamp": {
787 "description": "Backend Server Timestamp",
788 "type": "string"
789 },
790 "taxnexusaccount": {
791 "description": "Taxnexus Account Number used for recording transactions",
792 "type": "string"
793 }
794 },
795 "type": "object"
796 },
797 "Ingest": {
798 "description": "A record of the Ingest of information into Taxnexus",
799 "properties": {
800 "accountid": {
801 "description": "Account ID",
802 "type": "string"
803 },
804 "amount": {
805 "description": "Rollup Tax Amount",
806 "type": "number"
807 },
808 "backendid": {
809 "description": "Backend ID",
810 "type": "string"
811 },
812 "companyid": {
813 "description": "Company ID",
814 "type": "string"
815 },
816 "createdbyid": {
817 "description": "Taxnexus User ID",
818 "type": "string"
819 },
820 "createddate": {
821 "description": "Date of Job Creation",
822 "type": "string"
823 },
824 "description": {
825 "description": "Ingest Description",
826 "type": "string"
827 },
828 "enddate": {
829 "description": "End Date",
830 "type": "string"
831 },
832 "filename": {
833 "description": "Filename",
834 "type": "string"
835 },
836 "formatted": {
837 "description": "Numeric and Date Values Pre-formatted as Text",
838 "properties": {
839 "amount": {
840 "type": "string"
841 },
842 "ingestdate": {
843 "type": "string"
844 },
845 "invoicecount": {
846 "type": "string"
847 },
848 "pocount": {
849 "type": "string"
850 },
851 "revenuebase": {
852 "type": "string"
853 },
854 "revenuenottaxable": {
855 "type": "string"
856 },
857 "tax": {
858 "type": "string"
859 },
860 "taxontax": {
861 "type": "string"
862 },
863 "unitbase": {
864 "type": "string"
865 }
866 },
867 "type": "object"
868 },
869 "id": {
870 "description": "Record Id",
871 "type": "string"
872 },
873 "ingestdate": {
874 "description": "Ingest Date",
875 "type": "string"
876 },
877 "ingestfailurereason": {
878 "description": "Ingest Failure Reason",
879 "type": "string"
880 },
881 "ingesttype": {
882 "description": "Ingest Type",
883 "enum": ["fabric", "internal", "suretax", "taxnexus-api"],
884 "type": "string"
885 },
886 "invoicecount": {
887 "description": "Invoice Count",
888 "type": "number"
889 },
890 "jobid": {
891 "description": "Job ID",
892 "type": "string"
893 },
894 "lastmodifiedbyid": {
895 "description": "Taxnexus User ID",
896 "type": "string"
897 },
898 "lastmodifieddate": {
899 "description": "Last Modified Date",
900 "type": "string"
901 },
902 "metrclicense": {
903 "description": "License",
904 "type": "string"
905 },
906 "metrcstate": {
907 "description": "State Code",
908 "type": "string"
909 },
910 "objecttype": {
911 "description": "Ingest Object Type",
912 "enum": [
913 "account",
914 "cash-receipt",
915 "contact",
916 "invoice",
917 "order",
918 "po",
919 "quote"
920 ],
921 "type": "string"
922 },
923 "parentfk": {
924 "description": "Parent Foreign Key",
925 "type": "string"
926 },
927 "periodid": {
928 "description": "Period ID",
929 "type": "string"
930 },
931 "pocount": {
932 "description": "PO Count",
933 "type": "number"
934 },
935 "postfailurereason": {
936 "description": "Post Failure Reason",
937 "type": "string"
938 },
939 "production": {
940 "description": "Production Ingest?",
941 "type": "boolean"
942 },
943 "ratingengineid": {
944 "description": "Rating Engine ID",
945 "type": "string"
946 },
947 "ref": {
948 "description": "Source System Reference",
949 "type": "string"
950 },
951 "revenuebase": {
952 "description": "Rollup Revenue Base",
953 "type": "number"
954 },
955 "revenuenet": {
956 "description": "Rollup Revenue Net",
957 "type": "number"
958 },
959 "revenuenottaxable": {
960 "description": "Rollup Revenue Not Taxable",
961 "type": "number"
962 },
963 "startdate": {
964 "description": "Start Date",
965 "type": "string"
966 },
967 "status": {
968 "description": "Ingest Status",
969 "enum": [
970 "failed_accounting",
971 "failed_existing",
972 "failed_glpost",
973 "failed_invoice",
974 "failed_po",
975 "ingested",
976 "new",
977 "posted",
978 "queued",
979 "rated",
980 "rejected"
981 ],
982 "type": "string"
983 },
984 "tax": {
985 "description": "Rollup Tax",
986 "type": "number"
987 },
988 "taxontax": {
989 "description": "Rollup Tax On Tax",
990 "type": "number"
991 },
992 "taxtransactioncount": {
993 "description": "Tax Transaction Count",
994 "type": "number"
995 },
996 "templateid": {
997 "description": "Template",
998 "type": "string"
999 },
1000 "unitbase": {
1001 "description": "Rollup Unit Base",
1002 "type": "number"
1003 },
1004 "uuid": {
1005 "description": "UUID assigned by Salesforce",
1006 "type": "string"
1007 }
1008 },
1009 "required": ["accountid", "objecttype"],
1010 "type": "object"
1011 },
1012 "ingestRequest": {
1013 "properties": {
1014 "data": {
1015 "items": {
1016 "$ref": "#/definitions/Ingest"
1017 },
1018 "type": "array"
1019 },
1020 "meta": {
1021 "$ref": "#/definitions/RequestMeta"
1022 }
1023 },
1024 "required": ["meta", "data"],
1025 "type": "object"
1026 },
1027 "IngestResponse": {
1028 "description": "An array of Print-Ready ingest Objects",
1029 "properties": {
1030 "data": {
1031 "items": {
1032 "$ref": "#/definitions/Ingest"
1033 },
1034 "type": "array"
1035 },
1036 "meta": {
1037 "$ref": "#/definitions/ResponseMeta"
1038 }
1039 },
1040 "type": "object"
1041 },
1042 "Job": {
1043 "properties": {
1044 "accountid": {
1045 "description": "Taxnexus Account Id",
1046 "type": "string"
1047 },
1048 "backendid": {
1049 "description": "Taxnexus Backend ID",
1050 "type": "string"
1051 },
1052 "companyid": {
1053 "description": "Taxnexus Company ID",
1054 "type": "string"
1055 },
1056 "coordinateid": {
1057 "description": "Taxnexus Coordinate ID",
1058 "type": "string"
1059 },
1060 "createdbyid": {
1061 "description": "Taxnexus User ID",
1062 "type": "string"
1063 },
1064 "createddate": {
1065 "description": "Date of Job Creation",
1066 "type": "string"
1067 },
1068 "enddate": {
1069 "description": "End Date",
1070 "type": "string"
1071 },
1072 "endtime": {
1073 "description": "End Time",
1074 "type": "string"
1075 },
1076 "errorreason": {
1077 "description": "Error Reason",
1078 "type": "string"
1079 },
1080 "id": {
1081 "description": "Taxnexus Record Id of the Job record",
1082 "type": "string"
1083 },
1084 "ingesttype": {
1085 "description": "The Ingest type which governs job execution",
1086 "type": "string"
1087 },
1088 "jobdate": {
1089 "description": "Job Date",
1090 "type": "string"
1091 },
1092 "lastmodifiedbyid": {
1093 "description": "Last Modified By",
1094 "type": "string"
1095 },
1096 "lastmodifieddate": {
1097 "description": "Last Modified Date",
1098 "type": "string"
1099 },
1100 "nextjobid": {
1101 "description": "Next Job",
1102 "type": "string"
1103 },
1104 "number": {
1105 "description": "Taxnexus Job Number",
1106 "type": "string"
1107 },
1108 "objecttype": {
1109 "description": "Object Type",
1110 "type": "string"
1111 },
1112 "periodid": {
1113 "description": "Period",
1114 "type": "string"
1115 },
1116 "ratingengineid": {
1117 "description": "Rating Engine",
1118 "type": "string"
1119 },
1120 "ref": {
1121 "description": "External Reference",
1122 "type": "string"
1123 },
1124 "reschedule": {
1125 "description": "Reschedule?",
1126 "type": "boolean"
1127 },
1128 "rescheduleinterval": {
1129 "description": "Reschedule Interval",
1130 "type": "number"
1131 },
1132 "startdate": {
1133 "description": "Start Date",
1134 "type": "string"
1135 },
1136 "starttime": {
1137 "description": "Start Time",
1138 "type": "string"
1139 },
1140 "status": {
1141 "description": "Status",
1142 "type": "string"
1143 },
1144 "type": {
1145 "description": "Type",
1146 "type": "string"
1147 },
1148 "uuid": {
1149 "description": "Type",
1150 "type": "string"
1151 }
1152 },
1153 "type": "object"
1154 },
1155 "jobRequest": {
1156 "properties": {
1157 "data": {
1158 "items": {
1159 "$ref": "#/definitions/Job"
1160 },
1161 "type": "array"
1162 },
1163 "meta": {
1164 "$ref": "#/definitions/RequestMeta"
1165 }
1166 },
1167 "required": ["meta", "data"],
1168 "type": "object"
1169 },
1170 "JobResponse": {
1171 "description": "An array of Print-Ready ingest Objects",
1172 "properties": {
1173 "data": {
1174 "items": {
1175 "$ref": "#/definitions/Job"
1176 },
1177 "type": "array"
1178 },
1179 "meta": {
1180 "$ref": "#/definitions/ResponseMeta"
1181 }
1182 },
1183 "type": "object"
1184 },
1185 "Queue": {
1186 "properties": {
1187 "accountid": {
1188 "description": "Taxnexus Account Id",
1189 "type": "string"
1190 },
1191 "backendid": {
1192 "description": "Taxnexus Backend ID",
1193 "type": "string"
1194 },
1195 "companyid": {
1196 "description": "Taxnexus Company ID",
1197 "type": "string"
1198 },
1199 "coordinateid": {
1200 "description": "Taxnexus Coordinate ID",
1201 "type": "string"
1202 },
1203 "createdbyid": {
1204 "description": "Taxnexus User ID",
1205 "type": "string"
1206 },
1207 "createddate": {
1208 "description": "Date of Job Creation",
1209 "type": "string"
1210 },
1211 "enddate": {
1212 "description": "End Date",
1213 "type": "string"
1214 },
1215 "endtime": {
1216 "description": "End Time",
1217 "type": "string"
1218 },
1219 "errorreason": {
1220 "description": "Error Reason",
1221 "type": "string"
1222 },
1223 "id": {
1224 "description": "Taxnexus Record Id of the Job record",
1225 "type": "string"
1226 },
1227 "ingesttype": {
1228 "description": "The Ingest type which governs job execution",
1229 "type": "string"
1230 },
1231 "lastmodifiedbyid": {
1232 "description": "Last Modified By",
1233 "type": "string"
1234 },
1235 "lastmodifieddate": {
1236 "description": "Last Modified Date",
1237 "type": "string"
1238 },
1239 "number": {
1240 "description": "Taxnexus Job Number",
1241 "type": "string"
1242 },
1243 "objecttype": {
1244 "description": "Object Type",
1245 "type": "string"
1246 },
1247 "periodid": {
1248 "description": "Period",
1249 "type": "string"
1250 },
1251 "queuedate": {
1252 "description": "Job Date",
1253 "type": "string"
1254 },
1255 "ratingengineid": {
1256 "description": "Rating Engine",
1257 "type": "string"
1258 },
1259 "ref": {
1260 "description": "External Reference",
1261 "type": "string"
1262 },
1263 "reschedule": {
1264 "description": "Reschedule?",
1265 "type": "boolean"
1266 },
1267 "rescheduleinterval": {
1268 "description": "Reschedule Interval",
1269 "type": "number"
1270 },
1271 "startdate": {
1272 "description": "Start Date",
1273 "type": "string"
1274 },
1275 "starttime": {
1276 "description": "Start Time",
1277 "type": "string"
1278 },
1279 "status": {
1280 "description": "Status",
1281 "type": "string"
1282 },
1283 "type": {
1284 "description": "Type",
1285 "type": "string"
1286 },
1287 "uuid": {
1288 "description": "Type",
1289 "type": "string"
1290 }
1291 },
1292 "type": "object"
1293 },
1294 "queueRequest": {
1295 "properties": {
1296 "data": {
1297 "items": {
1298 "$ref": "#/definitions/Queue"
1299 },
1300 "type": "array"
1301 },
1302 "meta": {
1303 "$ref": "#/definitions/RequestMeta"
1304 }
1305 },
1306 "required": ["meta", "data"],
1307 "type": "object"
1308 },
1309 "QueueResponse": {
1310 "description": "An array of Print-Ready ingest Objects",
1311 "properties": {
1312 "data": {
1313 "items": {
1314 "$ref": "#/definitions/Queue"
1315 },
1316 "type": "array"
1317 },
1318 "meta": {
1319 "$ref": "#/definitions/ResponseMeta"
1320 }
1321 },
1322 "type": "object"
1323 },
1324 "User": {
1325 "properties": {
1326 "aboutme": {
1327 "description": "About Me",
1328 "type": "string"
1329 },
1330 "accountid": {
1331 "description": "Account ID",
1332 "type": "string"
1333 },
1334 "address": {
1335 "$ref": "#/definitions/Address"
1336 },
1337 "alias": {
1338 "description": "Alias",
1339 "type": "string"
1340 },
1341 "apikey": {
1342 "description": "API Key",
1343 "type": "string"
1344 },
1345 "communitynickname": {
1346 "description": "Nickname",
1347 "type": "string"
1348 },
1349 "companyname": {
1350 "description": "Company Name",
1351 "type": "string"
1352 },
1353 "contactid": {
1354 "description": "Contact",
1355 "type": "string"
1356 },
1357 "createdbyid": {
1358 "description": "Created User ID",
1359 "type": "string"
1360 },
1361 "createddate": {
1362 "description": "Date Created",
1363 "type": "string"
1364 },
1365 "delegatedapproverid": {
1366 "description": "Delegated Approver",
1367 "type": "string"
1368 },
1369 "department": {
1370 "description": "Department",
1371 "type": "string"
1372 },
1373 "division": {
1374 "description": "Division",
1375 "type": "string"
1376 },
1377 "email": {
1378 "description": "Email address",
1379 "type": "string"
1380 },
1381 "employeenumber": {
1382 "description": "Employee Number",
1383 "type": "string"
1384 },
1385 "environment": {
1386 "description": "Environment",
1387 "type": "string"
1388 },
1389 "extension": {
1390 "description": "Extension",
1391 "type": "string"
1392 },
1393 "fabricapikey": {
1394 "description": "Fabric API Key",
1395 "type": "string"
1396 },
1397 "fax": {
1398 "description": "Fax",
1399 "type": "string"
1400 },
1401 "forecastenabled": {
1402 "description": "Allow Forecasting",
1403 "type": "boolean"
1404 },
1405 "fullphotourl": {
1406 "description": "Full Photo URL",
1407 "type": "string"
1408 },
1409 "id": {
1410 "description": "Taxnexus ID",
1411 "type": "string"
1412 },
1413 "isactive": {
1414 "description": "Active",
1415 "type": "boolean"
1416 },
1417 "isprofilephotoactive": {
1418 "description": "Has Profile Photo",
1419 "type": "boolean"
1420 },
1421 "lastmodifiedbyid": {
1422 "description": "Last Modified User ID",
1423 "type": "string"
1424 },
1425 "lastmodifieddate": {
1426 "description": "Last Modified Date",
1427 "type": "string"
1428 },
1429 "managerid": {
1430 "description": "Manager",
1431 "type": "string"
1432 },
1433 "mobilephone": {
1434 "description": "Mobile",
1435 "type": "string"
1436 },
1437 "name": {
1438 "description": "Name",
1439 "type": "string"
1440 },
1441 "outofofficemessage": {
1442 "description": "Out of office message",
1443 "type": "string"
1444 },
1445 "phone": {
1446 "description": "Phone",
1447 "type": "string"
1448 },
1449 "portalrole": {
1450 "description": "Portal Role Level",
1451 "type": "string"
1452 },
1453 "profileid": {
1454 "description": "Profile",
1455 "type": "string"
1456 },
1457 "receivesadmininfoemails": {
1458 "description": "Admin Info Emails",
1459 "type": "boolean"
1460 },
1461 "receivesinfoemails": {
1462 "description": "Info Emails",
1463 "type": "boolean"
1464 },
1465 "senderemail": {
1466 "description": "Email Sender Address",
1467 "type": "string"
1468 },
1469 "sendername": {
1470 "description": "Email Sender Name",
1471 "type": "string"
1472 },
1473 "signature": {
1474 "description": "Email Signature",
1475 "type": "string"
1476 },
1477 "taxnexusaccount": {
1478 "description": "Taxnexus Account",
1479 "type": "string"
1480 },
1481 "timezone": {
1482 "description": "Time Zone",
1483 "type": "string"
1484 },
1485 "title": {
1486 "description": "Title",
1487 "type": "string"
1488 },
1489 "username": {
1490 "description": "Username",
1491 "type": "string"
1492 },
1493 "userroleid": {
1494 "description": "Role",
1495 "type": "string"
1496 }
1497 },
1498 "type": "object"
1499 },
1500 "UserRequest": {
1501 "properties": {
1502 "data": {
1503 "items": {
1504 "$ref": "#/definitions/User"
1505 },
1506 "type": "array"
1507 },
1508 "meta": {
1509 "$ref": "#/definitions/RequestMeta"
1510 }
1511 },
1512 "required": ["meta", "data"],
1513 "type": "object"
1514 },
1515 "UserResponse": {
1516 "description": "An array of Print-Ready ingest Objects",
1517 "properties": {
1518 "data": {
1519 "items": {
1520 "$ref": "#/definitions/User"
1521 },
1522 "type": "array"
1523 },
1524 "meta": {
1525 "$ref": "#/definitions/ResponseMeta"
1526 }
1527 },
1528 "type": "object"
1529 }
1530 }
1531}