forked from XeroAPI/Xero-OpenAPI
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathxero_files.yaml
1069 lines (1069 loc) · 34.4 KB
/
xero_files.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
servers:
- description: Xero Files API
url: https://api.xero.com/files.xro/1.0/
info:
title: Xero Files API
version: "2.40.3"
description: "These endpoints are specific to Xero Files API"
termsOfService: "https://developer.xero.com/xero-developer-platform-terms-conditions/"
contact:
name: "Xero Platform Team"
email: "[email protected]"
url: "https://developer.xero.com"
tags:
- name: Files
description: Operations available to regular developers
paths:
/Files:
parameters:
- $ref: '#/components/parameters/requiredHeader'
get:
security:
- OAuth2: [files, files.read]
tags:
- Files
operationId: getFiles
summary: Retrieves files
parameters:
- in: query
name: pagesize
description: pass an optional page size value
schema:
type: integer
maximum: 100
example: 50
- in: query
name: page
description: number of records to skip for pagination
schema:
type: integer
minimum: 1
example: 2
- in: query
name: sort
description: values to sort by
schema:
type: string
enum:
- Name
- Size
- CreatedDateUTC
example: "CreatedDateUTC DESC"
responses:
'200':
description: search results matching criteria
content:
application/json:
schema:
$ref: '#/components/schemas/Files'
example: '{
"TotalCount": 100,
"Page": 1,
"PerPage": 2,
"Items": [
{
"Name": "helo-heros.jpg",
"MimeType": "application/jpg",
"Size": 2878711,
"CreatedDateUtc": "2021-02-10T16:02:54.9930000",
"UpdatedDateUtc": "2021-02-10T16:02:54.9930000",
"User": {
"Name": "[email protected]",
"FirstName": "Sidney",
"LastName": "Maestre",
"FullName": "Sidney Maestre",
"Id": "740add2a-a703-4b8a-a670-1093919c2040"
},
"FolderId": "bf924975-7097-46f2-a143-1ecfbab3c8c3",
"Id": "3d413bfe-f40f-4807-b953-9a42f834ff15"
},
{
"Name": "helo-heros.jpg",
"MimeType": "application/jpg",
"Size": 2878711,
"CreatedDateUtc": "2021-02-09T21:16:00.6130000",
"UpdatedDateUtc": "2021-02-09T21:16:00.6130000",
"User": {
"Name": "[email protected]",
"FirstName": "Sidney",
"LastName": "Maestre",
"FullName": "Sidney Maestre",
"Id": "740add2a-a703-4b8a-a670-1093919c2040"
},
"FolderId": "bf924975-7097-46f2-a143-1ecfbab3c8c3",
"Id": "22f87409-cdfd-4813-a868-559481bcb052"
}
]
}'
post:
security:
- OAuth2: [files]
tags:
- Files
summary: Uploads a File to the inbox
parameters:
- $ref: '#/components/parameters/idempotencyKey'
operationId: uploadFile
responses:
'201':
description: A successful request
content:
application/json:
schema:
$ref: '#/components/schemas/FileObject'
example: '{
"Name": "helo-heros.jpg",
"MimeType": "application/jpg",
"Size": 2878711,
"CreatedDateUtc": "2021-02-10T23:17:50.1930000",
"UpdatedDateUtc": "2021-02-10T23:17:50.1930000",
"User": {
"Name": "[email protected]",
"FirstName": "Sidney",
"LastName": "Maestre",
"FullName": "Sidney Maestre",
"Id": "740add2a-a703-4b8a-a670-1093919c2040"
},
"FolderId": "bf924975-7097-46f2-a143-1ecfbab3c8c3",
"Id": "22f87409-cdfd-4813-a868-559481bcb052"
}'
'400':
description: invalid input, object invalid
content:
application/json:
example: '[
{
"type":"Validation",
"title":"Validation failure",
"detail":"Extension: boo is not a valid File extension."
}
]'
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/UploadObject'
/Files/{FileId}:
parameters:
- $ref: '#/components/parameters/requiredHeader'
get:
security:
- OAuth2: [files, files.read]
tags:
- Files
summary: Retrieves a file by a unique file ID
operationId: getFile
parameters:
- name: FileId
x-snake: file_id
in: path
required: true
description: File id for single object
schema:
type: string
format: uuid
example: 4ff1e5cc-9835-40d5-bb18-09fdb118db9c
responses:
'200':
description: search results matching criteria
content:
application/json:
schema:
$ref: '#/components/schemas/FileObject'
example: '{
"Name": "helo-heros.jpg",
"MimeType": "application/jpg",
"Size": 2878711,
"CreatedDateUtc": "2021-02-10T23:17:50.1930000",
"UpdatedDateUtc": "2021-02-10T23:17:50.1930000",
"User": {
"Name": "[email protected]",
"FirstName": "Sidney",
"LastName": "Maestre",
"FullName": "Sidney Maestre",
"Id": "740add2a-a703-4b8a-a670-1093919c2040"
},
"FolderId": "bf924975-7097-46f2-a143-1ecfbab3c8c3",
"Id": "efd77bfc-7018-4da1-b251-7aa2d438382c"
}'
put:
security:
- OAuth2: [files]
tags:
- Files
summary: Update a file
operationId: updateFile
description: Updates file properties of a single file
parameters:
- $ref: '#/components/parameters/idempotencyKey'
- name: FileId
x-snake: file_id
in: path
required: true
description: File id for single object
schema:
type: string
format: uuid
example: 4ff1e5cc-9835-40d5-bb18-09fdb118db9c
responses:
'200':
description: A successful request
content:
application/json:
schema:
$ref: '#/components/schemas/FileObject'
example: '{
"Name": "helo-heros.jpg",
"MimeType": "application/jpg",
"Size": 2878711,
"CreatedDateUtc": "2021-02-10T23:17:50.1930000",
"UpdatedDateUtc": "2021-02-10T23:58:54.1000000",
"User": {
"Name": "[email protected]",
"FirstName": "Sidney",
"LastName": "Maestre",
"FullName": "Sidney Maestre",
"Id": "740add2a-a703-4b8a-a670-1093919c2040"
},
"FolderId": "bf924975-7097-46f2-a143-1ecfbab3c8c3",
"Id": "efd77bfc-7018-4da1-b251-7aa2d438382c"
}'
'400':
description: invalid input, object invalid
content:
application/json:
example: '[
{
"type":"Rename",
"title":"Rename failed",
"detail":"Unable to rename efd77bfc-7018-4da1-b251-7aa2d438382c to FooBar"
}
]'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FileObject'
example: '{
"FolderId": "bf924975-7097-46f2-a143-1ecfbab3c8c3"
}'
delete:
security:
- OAuth2: [files]
tags:
- Files
summary: Deletes a specific file
operationId: deleteFile
description: Delete a specific file
parameters:
- name: FileId
x-snake: file_id
in: path
required: true
description: File id for single object
schema:
type: string
format: uuid
example: 4ff1e5cc-9835-40d5-bb18-09fdb118db9c
responses:
'204':
description: Successful deletion - return response 204 no content
x-isEmpty: true
/Files/{FolderId}:
parameters:
- $ref: '#/components/parameters/requiredHeader'
post:
security:
- OAuth2: [files]
tags:
- Files
summary: Uploads a File to a specific folder
operationId: uploadFileToFolder
parameters:
- $ref: '#/components/parameters/idempotencyKey'
- in: path
x-snake: folder_id
name: FolderId
required: true
description: pass required folder id to save file to specific folder
schema:
type: string
format: uuid
example: 4ff1e5cc-9835-40d5-bb18-09fdb118db9c
responses:
'201':
description: A successful request
content:
application/json:
schema:
$ref: '#/components/schemas/FileObject'
example: '{
"Name": "helo-heros.jpg",
"MimeType": "application/jpg",
"Size": 2878711,
"CreatedDateUtc": "2021-02-10T23:17:50.1930000",
"UpdatedDateUtc": "2021-02-10T23:17:50.1930000",
"User": {
"Name": "[email protected]",
"FirstName": "Sidney",
"LastName": "Maestre",
"FullName": "Sidney Maestre",
"Id": "740add2a-a703-4b8a-a670-1093919c2040"
},
"FolderId": "bf924975-7097-46f2-a143-1ecfbab3c8c3",
"Id": "22f87409-cdfd-4813-a868-559481bcb052"
}'
'400':
description: invalid input, object invalid
content:
application/json:
example: '[
{
"type":"Validation",
"title":"Validation failure",
"detail":"Extension: boo is not a valid File extension."
}
]'
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/UploadObject'
/Files/{FileId}/Content:
parameters:
- $ref: '#/components/parameters/requiredHeader'
get:
security:
- OAuth2: [files, files.read]
tags:
- Files
summary: Retrieves the content of a specific file
operationId: getFileContent
description: By passing in the appropriate options, retrieve data for specific file
parameters:
- name: FileId
x-snake: file_id
in: path
required: true
description: File id for single object
schema:
type: string
format: uuid
example: 4ff1e5cc-9835-40d5-bb18-09fdb118db9c
responses:
'200':
description: returns the byte array of the specific file based on id
content:
application/octet-stream:
schema:
type: string
format: binary
/Files/{FileId}/Associations:
parameters:
- $ref: '#/components/parameters/requiredHeader'
get:
security:
- OAuth2: [files, files.read]
tags:
- Files
summary: Retrieves a specific file associations
operationId: getFileAssociations
description: |
By passing in the appropriate options,
parameters:
- name: FileId
x-snake: file_id
in: path
required: true
description: File id for single object
schema:
type: string
format: uuid
example: 4ff1e5cc-9835-40d5-bb18-09fdb118db9c
responses:
'200':
description: search results matching criteria
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Association'
example: '[
{
"FileId":"6beccb4a-0d7d-4518-93f3-e0cd1dccb254",
"ObjectId":"1270bf7c-5d18-473a-9231-1e36c4bd33ed",
"ObjectType":"Business",
"ObjectGroup":"Contact"
}
]'
post:
security:
- OAuth2: [files]
tags:
- Files
summary: Creates a new file association
operationId: createFileAssociation
description: By passing in the appropriate options, you can create a new folder
parameters:
- $ref: '#/components/parameters/idempotencyKey'
- name: FileId
x-snake: file_id
in: path
required: true
description: File id for single object
schema:
type: string
format: uuid
example: 4ff1e5cc-9835-40d5-bb18-09fdb118db9c
responses:
'201':
description: A successful request
content:
application/json:
schema:
$ref: '#/components/schemas/Association'
example: '{
"FileId": "6beccb4a-0d7d-4518-93f3-e0cd1dccb254",
"ObjectId": "1270bf7c-5d18-473a-9231-1e36c4bd33ed",
"ObjectType": "Business",
"ObjectGroup": "Contact"
}'
'400':
description: invalid input, object invalid
content:
application/json:
example: '[
{
"type":"Validation",
"title":"Validation failure",
"detail":"Object is not a Account"
}
]'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Association'
example: '{
"ObjectId": "1270bf7c-5d18-473a-9231-1e36c4bd33ed",
"ObjectGroup": "Contact",
"ObjectType": "Business"
}'
/Files/{FileId}/Associations/{ObjectId}:
parameters:
- $ref: '#/components/parameters/requiredHeader'
delete:
security:
- OAuth2: [files]
tags:
- Files
summary: Deletes an existing file association
operationId: deleteFileAssociation
description: By passing in the appropriate options, you can create a new folder
parameters:
- name: FileId
x-snake: file_id
in: path
required: true
description: File id for single object
schema:
type: string
format: uuid
example: 4ff1e5cc-9835-40d5-bb18-09fdb118db9c
- name: ObjectId
x-snake: object_id
in: path
required: true
description: Object id for single object
schema:
type: string
format: uuid
example: 4ff1e5cc-9835-40d5-bb18-09fdb118db9c
responses:
'204':
description: Successful deletion - return response 204 no content
x-isEmpty: true
/Associations/{ObjectId}:
parameters:
- $ref: '#/components/parameters/requiredHeader'
get:
security:
- OAuth2: [files, files.read]
tags:
- Files
summary: Retrieves an association object using a unique object ID
operationId: getAssociationsByObject
description: By passing in the appropriate options, you can retrieve an association
parameters:
- name: ObjectId
x-snake: object_id
in: path
required: true
description: Object id for single object
schema:
type: string
format: uuid
example: 4ff1e5cc-9835-40d5-bb18-09fdb118db9c
- in: query
name: pagesize
description: pass an optional page size value
schema:
type: integer
maximum: 100
example: 50
- in: query
name: page
description: number of records to skip for pagination
schema:
type: integer
minimum: 1
example: 2
- in: query
name: sort
description: values to sort by
schema:
type: string
enum:
- Name
- CreatedDateUTC
example: "Associations/{ObjectId}?sort=CreatedDateUtc"
- in: query
name: direction
description: direction to sort by
schema:
type: string
enum:
- ASC
- DESC
example: "Associations/{ObjectId}?sort=CreatedDateUtc&direction=DESC"
responses:
'200':
description: search results matching criteria
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Association'
example: '[
{
"FileId":"6beccb4a-0d7d-4518-93f3-e0cd1dccb254",
"ObjectId":"1270bf7c-5d18-473a-9231-1e36c4bd33ed",
"ObjectType":"Business",
"ObjectGroup":"Contact"
}
]'
/Associations/Count:
parameters:
- $ref: '#/components/parameters/requiredHeader'
get:
security:
- OAuth2: [files, files.read]
tags:
- Files
summary: Retrieves a count of associations for a list of objects.
operationId: getAssociationsCount
description: By passing in the appropriate options, you can retrieve the association count for objects
parameters:
- name: ObjectIds
in: query
required: true
description: A comma-separated list of object ids
schema:
type: array
items:
type: string
format: uuid
example: 1270bf7c-5d18-473a-9231-1e36c4bd33ed
responses:
'200':
description: A dictionary of the object Ids and associations count
content:
application/json:
schema:
type: object
example: '{
"19d4fc59-e799-410f-912b-03d4ab294d73": 2,
"82195976-5175-45d4-926e-807ff10892e7": 1,
"a8547af2-2900-4879-98b8-f1a780c78feb": 0
}'
/Folders:
parameters:
- $ref: '#/components/parameters/requiredHeader'
get:
security:
- OAuth2: [files, files.read]
tags:
- Files
summary: Retrieves folders
operationId: getFolders
description: By passing in the appropriate options, you can search for
available folders
parameters:
- in: query
name: sort
description: values to sort by
schema:
type: string
enum:
- Name
- Size
- CreatedDateUTC
example: "CreatedDateUTC DESC"
responses:
'200':
description: search results matching criteria
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Folder'
example: '[
{
"Name":"Inbox",
"FileCount":14,
"Email":"[email protected]",
"IsInbox":true,
"Id":"bf924975-7097-46f2-a143-1ecfbab3c8c3"
},
{
"Name":"Contracts",
"FileCount":7,
"IsInbox":false,
"Id":"554ff1ad-4b94-4266-9b45-e29bcb75e6bf"
}
]'
post:
security:
- OAuth2: [files]
tags:
- Files
summary: Creates a new folder
parameters:
- $ref: '#/components/parameters/idempotencyKey'
operationId: createFolder
description: By passing in the appropriate properties, you can create a new folder
responses:
'200':
description: search results matching criteria
content:
application/json:
schema:
$ref: '#/components/schemas/Folder'
example: '{
"Name": "My Docs",
"FileCount": 0,
"IsInbox": false,
"Id": "913970ad-8c8e-4666-8294-35b9cac23206"
}'
'400':
description: invalid input, object invalid
content:
application/json:
example: '[
{
"type":"Validation",
"title":"Validation failure",
"detail":"Name contains one or more bad characters"
}
]'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Folder'
example: '{
"Name": "My Docs"
}'
/Folders/{FolderId}:
parameters:
- $ref: '#/components/parameters/requiredHeader'
get:
security:
- OAuth2: [files, files.read]
tags:
- Files
summary: Retrieves specific folder by using a unique folder ID
operationId: getFolder
description: By passing in the appropriate ID, you can search for specific folder
parameters:
- name: FolderId
x-snake: folder_id
in: path
required: true
description: Folder id for single object
schema:
type: string
format: uuid
example: 4ff1e5cc-9835-40d5-bb18-09fdb118db9c
responses:
'200':
description: search results matching criteria
content:
application/json:
schema:
$ref: '#/components/schemas/Folder'
example: '{
"Name": "My Docs",
"FileCount": 0,
"IsInbox": false,
"Id": "4c5f3fe4-2516-4863-ac88-3029351773bf"
}'
put:
security:
- OAuth2: [files]
tags:
- Files
summary: Updates an existing folder
operationId: updateFolder
description: By passing in the appropriate ID and properties, you can update a folder
parameters:
- $ref: '#/components/parameters/idempotencyKey'
- name: FolderId
x-snake: folder_id
in: path
required: true
description: Folder id for single object
schema:
type: string
format: uuid
example: 4ff1e5cc-9835-40d5-bb18-09fdb118db9c
responses:
'200':
description: return the updated object
content:
application/json:
schema:
$ref: '#/components/schemas/Folder'
example: '{
"Name": "Your Docs",
"FileCount": 0,
"IsInbox": false,
"Id": "4c5f3fe4-2516-4863-ac88-3029351773bf"
}'
'400':
description: invalid input, object invalid
content:
application/json:
example: '[
{
"type":"Validation",
"title":"Validation failure",
"detail":"Name contains one or more bad characters"
}
]'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Folder'
example: '{
"Name": "Your Docs"
}'
delete:
security:
- OAuth2: [files]
tags:
- Files
summary: Deletes a folder
operationId: deleteFolder
description: By passing in the appropriate ID, you can delete a folder
parameters:
- name: FolderId
x-snake: folder_id
in: path
required: true
description: Folder id for single object
schema:
type: string
format: uuid
example: 4ff1e5cc-9835-40d5-bb18-09fdb118db9c
responses:
'204':
description: Successful deletion - return response 204 no content
x-isEmpty: true
/Inbox:
parameters:
- $ref: '#/components/parameters/requiredHeader'
get:
security:
- OAuth2: [files, files.read]
tags:
- Files
summary: Retrieves inbox folder
operationId: getInbox
description: Search for the user inbox
responses:
'200':
description: search results matching criteria
content:
application/json:
schema:
$ref: '#/components/schemas/Folder'
example: '{
"Name": "Inbox",
"FileCount": 14,
"Email": "[email protected]",
"IsInbox": true,
"Id": "bf924975-7097-46f2-a143-1ecfbab3c8c3"
}'
components:
securitySchemes:
OAuth2:
type: oauth2
description: For more information
flows:
authorizationCode:
authorizationUrl: 'https://login.xero.com/identity/connect/authorize'
tokenUrl: 'https://identity.xero.com/connect/token'
scopes:
email: Grant read-only access to your email
openid: Grant read-only access to your open id
profile: your profile information
files: Grant read-write access to files and folders
files.read: Grant read-only access to files and folders
parameters:
requiredHeader:
in: header
name: xero-tenant-id
x-snake: xero_tenant_id
description: Xero identifier for Tenant
example: YOUR_XERO_TENANT_ID
schema:
type: string
required: true
idempotencyKey:
in: header
name: Idempotency-Key
x-snake: idempotency_key
description: This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
example: "KEY_VALUE"
schema:
type: string
schemas:
Files:
type: object
properties:
TotalCount:
type: integer
example: 2
Page:
type: integer
example: 1
PerPage:
type: integer
example: 50
Items:
type: array
items:
$ref: '#/components/schemas/FileObject'
FileObject:
type: object
required:
- id
- name
- manufacturer
- releaseDate
properties:
Name:
description: File Name
type: string
example: File2.jpg
MimeType:
description: MimeType of the file (image/png, image/jpeg, application/pdf, etc..)
type: string
example: image/jpeg
Size:
description: Numeric value in bytes
type: integer
example: 3615
CreatedDateUtc:
description: Created date in UTC
type: string
example: '2020-12-03T19:04:58.6970000'
UpdatedDateUtc:
description: Updated date in UTC
type: string
example: '2020-12-03T19:04:58.6970000'
User:
$ref: '#/components/schemas/User'
Id:
description: File object's UUID
type: string
format: uuid
example: d290f1ee-6c54-4b01-90e6-d701748f0851
FolderId:
description: Folder relation object's UUID
type: string
format: uuid
example: 0f8ccf21-7267-4268-9167-a1e2c40c84c8
UploadObject:
type: object
required:
- body
- name
- filename
properties:
body:
type: string
format: byte
name:
type: string
description: exact name of the file you are uploading
filename:
type: string
mimeType:
type: string
User:
required:
- Id
properties:
Id:
description: Xero identifier
type: string
format: uuid
example: 4ff1e5cc-9835-40d5-bb18-09fdb118db9c
Name:
description: Key is Name, but returns Email address of user who created the file
type: string
example: [email protected]
FirstName:
description: First name of user
type: string
example: John
LastName:
description: Last name of user
type: string
example: Smith
FullName:
description: Last name of user
type: string
example: Smith
type: object
Folders:
type: object
properties:
Folders:
type: array
items:
$ref: '#/components/schemas/Folder'
Folder:
required:
- name
properties:
Name:
description: The name of the folder
type: string
example: assets
FileCount:
description: The number of files in the folder
type: integer
example: 5
Email:
description: The email address used to email files to the inbox. Only the inbox will have this element.
type: string
example: [email protected]
IsInbox:
description: to indicate if the folder is the Inbox. The Inbox cannot be renamed or deleted.
type: boolean
example: true
Id:
description: Xero unique identifier for a folder Files
type: string
format: uuid
example: 4ff1e5cc-9835-40d5-bb18-09fdb118db9c
Association:
type: object
properties:
FileId:
description: The unique identifier of the file
type: string
format: uuid
ObjectId:
description: The identifier of the object that the file is being associated with (e.g. InvoiceID, BankTransactionID, ContactID)
type: string
format: uuid
ObjectGroup:
$ref: '#/components/schemas/ObjectGroup'
ObjectType:
$ref: '#/components/schemas/ObjectType'
ObjectGroup:
description: The Object Group that the object is in. These roughly correlate to the endpoints that can be used to retrieve the object via the core accounting API.
type: string
enum:
- Account
- BankTransaction
- Contact