Skip to content

Commit 6ac9986

Browse files
SidneyAllenSidneyAllen
committed
Updates to Accounting, Assets and addition of BankFeeds
Add terms of service and contact Improve numeric data types. Add the format for numbers that are floats Use of integer instead of number where appropriate. Add descriptions for Assets and AssetTypes Update any numeric data types
1 parent 3abc35f commit 6ac9986

7 files changed

+1827
-200
lines changed

‎README.md

-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ OpenAPI spec 3.0
1010
* [Fixed Assets API - yaml](https://raw.githubusercontent.com/XeroAPI/Xero-OpenAPI/oas3/spec/v3/Xero_assets_1.0.0_swagger.yaml)
1111
* [Fixed Assets API - json](https://raw.githubusercontent.com/XeroAPI/Xero-OpenAPI/oas3/spec/v3/Xero_assets_1.0.0_swagger.json)
1212

13-
1413
OpenAPI spec 2.0 (Swagger)
1514
* [Accounting API - yaml](https://raw.githubusercontent.com/XeroAPI/Xero-OpenAPI/oas3/spec/v2/accounting2.yaml)
1615
* [Accounting API - json](https://raw.githubusercontent.com/XeroAPI/Xero-OpenAPI/oas3/spec/v2/accounting2.json)

‎spec/v3/Xero_accounting_2.0.0_swagger.json

+61-41
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,13 @@
55
} ],
66
"info" : {
77
"title" : "Accounting API",
8-
"version" : "2.0.0"
8+
"version" : "2.0.0",
9+
"termsOfService" : "https://developer.xero.com/xero-developer-platform-terms-conditions/",
10+
"contact" : {
11+
"name" : "Xero Platform Team",
12+
"email" : "[email protected]",
13+
"url" : "https://developer.xero.com"
14+
}
915
},
1016
"paths" : {
1117
"/Accounts" : {
@@ -685,7 +691,7 @@
685691
"name" : "page",
686692
"description" : "e.g. page=1 – Up to 100 bank transactions will be returned in a single API call with line items shown for each bank transaction",
687693
"schema" : {
688-
"type" : "number"
694+
"type" : "integer"
689695
}
690696
} ]
691697
},
@@ -1854,7 +1860,7 @@
18541860
"name" : "page",
18551861
"description" : "e.g. page=1 - Up to 100 contacts will be returned in a single API call.",
18561862
"schema" : {
1857-
"type" : "number"
1863+
"type" : "integer"
18581864
}
18591865
}, {
18601866
"in" : "query",
@@ -2678,7 +2684,7 @@
26782684
"name" : "page",
26792685
"description" : "e.g. page=1 – Up to 100 credit notes will be returned in a single API call with line items shown for each credit note",
26802686
"schema" : {
2681-
"type" : "number"
2687+
"type" : "integer"
26822688
}
26832689
} ]
26842690
},
@@ -3798,7 +3804,7 @@
37983804
"name" : "page",
37993805
"description" : "e.g. page=1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice",
38003806
"schema" : {
3801-
"type" : "number"
3807+
"type" : "integer"
38023808
}
38033809
}, {
38043810
"in" : "query",
@@ -4738,7 +4744,7 @@
47384744
"in" : "query",
47394745
"name" : "offset",
47404746
"schema" : {
4741-
"type" : "number"
4747+
"type" : "integer"
47424748
}
47434749
}, {
47444750
"in" : "query",
@@ -4811,7 +4817,7 @@
48114817
"name" : "page",
48124818
"description" : "Up to 100 linked transactions will be returned in a single API call. Use the page parameter to specify the page to be returned e.g. page=1.",
48134819
"schema" : {
4814-
"type" : "number"
4820+
"type" : "integer"
48154821
}
48164822
}, {
48174823
"in" : "query",
@@ -5040,7 +5046,7 @@
50405046
"name" : "page",
50415047
"description" : "e.g. page=1 – Up to 100 manual journals will be returned in a single API call with line items shown for each overpayment",
50425048
"schema" : {
5043-
"type" : "number"
5049+
"type" : "integer"
50445050
}
50455051
} ]
50465052
},
@@ -5547,7 +5553,7 @@
55475553
"name" : "page",
55485554
"description" : "e.g. page=1 – Up to 100 overpayments will be returned in a single API call with line items shown for each overpayment",
55495555
"schema" : {
5550-
"type" : "number"
5556+
"type" : "integer"
55515557
}
55525558
} ]
55535559
}
@@ -6056,7 +6062,7 @@
60566062
"name" : "page",
60576063
"description" : "e.g. page=1 – Up to 100 prepayments will be returned in a single API call with line items shown for each overpayment",
60586064
"schema" : {
6059-
"type" : "number"
6065+
"type" : "integer"
60606066
}
60616067
} ]
60626068
},
@@ -6239,7 +6245,7 @@
62396245
"name" : "page",
62406246
"description" : "To specify a page, append the page parameter to the URL e.g. ?page=1. If there are 100 records in the response you will need to check if there is any more data by fetching the next page e.g ?page=2 and continuing this process until no more results are returned.",
62416247
"schema" : {
6242-
"type" : "number"
6248+
"type" : "integer"
62436249
}
62446250
} ]
62456251
},
@@ -7561,14 +7567,14 @@
75617567
"in" : "query",
75627568
"name" : "periods",
75637569
"schema" : {
7564-
"type" : "number"
7570+
"type" : "integer"
75657571
}
75667572
}, {
75677573
"in" : "query",
75687574
"name" : "timeframe",
75697575
"description" : "The period size to compare to (1=month, 3=quarter, 12=year)",
75707576
"schema" : {
7571-
"type" : "number"
7577+
"type" : "integer"
75727578
}
75737579
}, {
75747580
"in" : "query",
@@ -7632,14 +7638,14 @@
76327638
"name" : "period",
76337639
"description" : "The number of periods to compare (integer between 1 and 12)",
76347640
"schema" : {
7635-
"type" : "number"
7641+
"type" : "integer"
76367642
}
76377643
}, {
76387644
"in" : "query",
76397645
"name" : "timeframe",
76407646
"description" : "The period size to compare to (1=month, 3=quarter, 12=year)",
76417647
"schema" : {
7642-
"type" : "number"
7648+
"type" : "integer"
76437649
}
76447650
} ]
76457651
}
@@ -7775,14 +7781,15 @@
77757781
"name" : "periods",
77767782
"description" : "The number of periods to compare (integer between 1 and 12)",
77777783
"schema" : {
7778-
"type" : "number"
7784+
"type" : "integer"
77797785
}
77807786
}, {
77817787
"in" : "query",
77827788
"name" : "timeframe",
77837789
"description" : "The period size to compare to (1=month, 3=quarter, 12=year)",
77847790
"schema" : {
7785-
"type" : "number"
7791+
"type" : "string",
7792+
"enum" : [ "MONTH", "QUARTER", "YEAR" ]
77867793
}
77877794
}, {
77887795
"in" : "query",
@@ -8643,7 +8650,8 @@
86438650
},
86448651
"CurrencyRate" : {
86458652
"description" : "Exchange rate to base currency when money is spent or received. e.g. 0.7500 Only used for bank transactions in non base currency. If this isn’t specified for non base currency accounts then either the user-defined rate (preference) or the XE.com day rate will be used. Setting currency is only supported on overpayments.",
8646-
"type" : "number"
8653+
"type" : "number",
8654+
"format" : "float"
86478655
},
86488656
"Url" : {
86498657
"description" : "URL link to a source document – shown as “Go to App Name”",
@@ -8660,15 +8668,18 @@
86608668
},
86618669
"SubTotal" : {
86628670
"description" : "Total of bank transaction excluding taxes",
8663-
"type" : "number"
8671+
"type" : "number",
8672+
"format" : "float"
86648673
},
86658674
"TotalTax" : {
86668675
"description" : "Total tax on bank transaction",
8667-
"type" : "number"
8676+
"type" : "number",
8677+
"format" : "float"
86688678
},
86698679
"Total" : {
86708680
"description" : "Total of bank transaction tax inclusive",
8671-
"type" : "number"
8681+
"type" : "number",
8682+
"format" : "float"
86728683
},
86738684
"BankTransactionID" : {
86748685
"description" : "Xero generated unique identifier for bank transaction",
@@ -8718,11 +8729,13 @@
87188729
},
87198730
"Quantity" : {
87208731
"description" : "LineItem Quantity",
8721-
"type" : "string"
8732+
"type" : "number",
8733+
"format" : "float"
87228734
},
87238735
"UnitAmount" : {
87248736
"description" : "LineItem Unit Amount",
8725-
"type" : "number"
8737+
"type" : "number",
8738+
"format" : "float"
87268739
},
87278740
"ItemCode" : {
87288741
"description" : "See Items",
@@ -8738,11 +8751,13 @@
87388751
},
87398752
"TaxAmount" : {
87408753
"description" : "The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate. This value can be overriden if the calculated <TaxAmount> is not correct.",
8741-
"type" : "number"
8754+
"type" : "number",
8755+
"format" : "float"
87428756
},
87438757
"LineAmount" : {
87448758
"description" : "If you wish to omit either of the <Quantity> or <UnitAmount> you can provide a LineAmount and Xero will calculate the missing amount for you. The line amount reflects the discounted price if a DiscountRate has been used . i.e LineAmount = Quantity * Unit Amount * ((100 – DiscountRate)/100)",
8745-
"type" : "number"
8759+
"type" : "number",
8760+
"format" : "float"
87468761
},
87478762
"Tracking" : {
87488763
"description" : "Optional Tracking Category – see Tracking. Any LineItem can have a maximum of 2 <TrackingCategory> elements.",
@@ -8926,7 +8941,8 @@
89268941
},
89278942
"Amount" : {
89288943
"description" : "The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00",
8929-
"type" : "number"
8944+
"type" : "number",
8945+
"format" : "float"
89308946
},
89318947
"Payments" : {
89328948
"type" : "array",
@@ -8989,8 +9005,7 @@
89899005
},
89909006
"SortOrder" : {
89919007
"description" : "Integer – ranked order of branding theme. The default branding theme has a value of 0",
8992-
"type" : "number",
8993-
"format" : "double"
9008+
"type" : "integer"
89949009
},
89959010
"CreatedDateUTC" : {
89969011
"description" : "UTC timestamp of creation date of branding theme",
@@ -9301,7 +9316,7 @@
93019316
},
93029317
"Rate" : {
93039318
"description" : "CIS Deduction rate for the contact if he is a subcontractor. If the contact is not CISEnabled, then the rate is not returned",
9304-
"type" : "number"
9319+
"type" : "integer"
93059320
}
93069321
}
93079322
},
@@ -9534,7 +9549,8 @@
95349549
},
95359550
"Amount" : {
95369551
"description" : "the amount being applied to the invoice",
9537-
"type" : "number"
9552+
"type" : "number",
9553+
"format" : "float"
95389554
},
95399555
"Date" : {
95409556
"description" : "the date the prepayment is applied YYYY-MM-DD (read-only). This will be the latter of the invoice date and the prepayment date.",
@@ -10058,7 +10074,8 @@
1005810074
"properties" : {
1005910075
"UnitPrice" : {
1006010076
"description" : "Unit Price of the item. By default UnitPrice is rounded to two decimal places. You can use 4 decimal places by adding the unitdp=4 querystring parameter to your request.",
10061-
"type" : "number"
10077+
"type" : "number",
10078+
"format" : "float"
1006210079
},
1006310080
"AccountCode" : {
1006410081
"description" : "Default account code to be used for purchased/sale. Not applicable to the purchase details of tracked items",
@@ -10684,11 +10701,13 @@
1068410701
},
1068510702
"CurrencyRate" : {
1068610703
"description" : "Exchange rate when payment is received. Only used for non base currency invoices and credit notes e.g. 0.7500",
10687-
"type" : "number"
10704+
"type" : "number",
10705+
"format" : "float"
1068810706
},
1068910707
"Amount" : {
1069010708
"description" : "The amount of the payment. Must be less than or equal to the outstanding amount owing on the invoice e.g. 200.00",
10691-
"type" : "number"
10709+
"type" : "number",
10710+
"format" : "float"
1069210711
},
1069310712
"Reference" : {
1069410713
"description" : "An optional description for the payment e.g. Direct Debit",
@@ -11449,17 +11468,15 @@
1144911468
"properties" : {
1145011469
"Period" : {
1145111470
"description" : "Integer used with the unit e.g. 1 (every 1 week), 2 (every 2 months)",
11452-
"type" : "number",
11453-
"format" : "double"
11471+
"type" : "integer"
1145411472
},
1145511473
"Unit" : {
1145611474
"description" : "One of the following : WEEKLY or MONTHLY",
1145711475
"type" : "string"
1145811476
},
1145911477
"DueDate" : {
1146011478
"description" : "Integer used with due date type e.g 20 (of following month), 31 (of current month)",
11461-
"type" : "number",
11462-
"format" : "double"
11479+
"type" : "integer"
1146311480
},
1146411481
"DueDateType" : {
1146511482
"allOf" : [ {
@@ -11556,12 +11573,14 @@
1155611573
"DisplayTaxRate" : {
1155711574
"description" : "Tax Rate (decimal to 4dp) e.g 12.5000",
1155811575
"readOnly" : true,
11559-
"type" : "number"
11576+
"type" : "number",
11577+
"format" : "float"
1156011578
},
1156111579
"EffectiveRate" : {
1156211580
"description" : "Effective Tax Rate (decimal to 4dp) e.g 12.5000",
1156311581
"readOnly" : true,
11564-
"type" : "number"
11582+
"type" : "number",
11583+
"format" : "float"
1156511584
}
1156611585
},
1156711586
"required" : [ "ReportTaxType" ],
@@ -11578,7 +11597,8 @@
1157811597
},
1157911598
"Rate" : {
1158011599
"description" : "Tax Rate (up to 4dp)",
11581-
"type" : "number"
11600+
"type" : "number",
11601+
"format" : "float"
1158211602
},
1158311603
"IsCompound" : {
1158411604
"description" : "Boolean to describe if Tax rate is compounded.",
@@ -11724,7 +11744,7 @@
1172411744
"properties" : {
1172511745
"ErrorNumber" : {
1172611746
"description" : "Exception number",
11727-
"type" : "number"
11747+
"type" : "integer"
1172811748
},
1172911749
"Type" : {
1173011750
"description" : "Exception type",

0 commit comments

Comments
 (0)