Skip to content

Commit 4f14ed7

Browse files
vigneshk-twvigneshk-tw
authored
Merge pull request #628 from XeroAPI/consume-prism-server
PRISM Server Setup Changes
2 parents 7b219fe + 2e0acfe commit 4f14ed7

8 files changed

+1256
-1179
lines changed

‎xero-app-store.yaml

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,7 @@ paths:
3030
application/json:
3131
schema:
3232
$ref: "#/components/schemas/Subscription"
33-
example: '
34-
{
33+
example: {
3534
"currentPeriodEnd": "2021-07-20T03:13:48",
3635
"endDate": "2021-07-20T03:13:48",
3736
"id": "01b5a6f4-8936-4bfa-b703-830702312b87",
@@ -82,7 +81,6 @@ paths:
8281
"startDate": "2021-07-20T03:13:48",
8382
"status": "ACTIVE"
8483
}
85-
'
8684
"404":
8785
content:
8886
application/json:
@@ -108,7 +106,7 @@ paths:
108106
application/json:
109107
schema:
110108
$ref: "#/components/schemas/UsageRecord"
111-
example: '{
109+
example: {
112110
"usageRecordId": "2a90f7d9-4c10-4a23-9c34-b47225167a48",
113111
"subscriptionId": "391be708-878a-4741-acfb-c0bc9a165bdb",
114112
"subscriptionItemId": "b22b150f-a0db-447d-9117-d922110add64",
@@ -117,7 +115,7 @@ paths:
117115
"quantity": 22,
118116
"testMode": true,
119117
"recordedAt": "2022-09-13T02:11:22"
120-
}'
118+
}
121119
"404":
122120
content:
123121
application/json:
@@ -131,10 +129,10 @@ paths:
131129
application/json:
132130
schema:
133131
$ref: "#/components/schemas/CreateUsageRecord"
134-
example: '{
132+
example: {
135133
"timestamp": "2022-01-21T13:01:00",
136134
"quantity": 10
137-
}'
135+
}
138136
description: Contains the quantity for the usage record to create
139137
required: true
140138
"/subscriptions/{subscriptionId}/items/{subscriptionItemId}/usage-records/{usageRecordId}":
@@ -155,7 +153,7 @@ paths:
155153
application/json:
156154
schema:
157155
$ref: "#/components/schemas/UsageRecord"
158-
example: '{
156+
example: {
159157
"usageRecordId": "2a90f7d9-4c10-4a23-9c34-b47225167a48",
160158
"subscriptionId": "391be708-878a-4741-acfb-c0bc9a165bdb",
161159
"subscriptionItemId": "b22b150f-a0db-447d-9117-d922110add64",
@@ -164,7 +162,7 @@ paths:
164162
"quantity": 22,
165163
"testMode": true,
166164
"recordedAt": "2022-09-13T02:11:22"
167-
}'
165+
}
168166
"404":
169167
content:
170168
application/json:
@@ -178,9 +176,9 @@ paths:
178176
application/json:
179177
schema:
180178
$ref: "#/components/schemas/UpdateUsageRecord"
181-
example: '{
179+
example: {
182180
"quantity": 10
183-
}'
181+
}
184182
description: Contains the quantity for the usage record to update
185183
required: true
186184
"/subscriptions/{subscriptionId}/usage-records":
@@ -198,7 +196,7 @@ paths:
198196
application/json:
199197
schema:
200198
$ref: "#/components/schemas/UsageRecordsList"
201-
example: '{
199+
example: {
202200
"usageRecords": [
203201
{
204202
"usageRecordId": "206100d3-e18b-4c59-9372-e98e4367a73f",
@@ -221,7 +219,7 @@ paths:
221219
"recordedAt": "2022-01-01T00:00:00"
222220
}
223221
]
224-
}'
222+
}
225223
"404":
226224
content:
227225
application/json:
@@ -559,4 +557,4 @@ components:
559557
type: integer
560558
required:
561559
- quantity
562-
type: object
560+
type: object

‎xero-finance.yaml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ paths:
126126
endDate: '2021-03-01'
127127
startBalance: 0
128128
endBalance: 0
129-
importedDateTimeUtc: '2021-03-09T05:22:14.3'
129+
importedDateTimeUtc: '2021-03-09T05:22:14.3Z'
130130
importSourceType: Manual
131131
cashAccount:
132132
unreconciledAmountPos: 1440
@@ -256,13 +256,13 @@ paths:
256256
lockDates:
257257
- hardLockDate: '2019-01-20'
258258
softLockDate: '2019-01-20'
259-
updatedDateUtc: '2019-01-20 10:50:03'
259+
updatedDateUtc: '2019-01-20T10:50:03Z'
260260
- hardLockDate: '2019-01-21'
261261
softLockDate: '2019-01-21'
262-
updatedDateUtc: '2019-01-21 10:59:33'
262+
updatedDateUtc: '2019-01-21T10:59:33Z'
263263
- hardLockDate: '2019-01-22'
264264
softLockDate: '2019-01-22'
265-
updatedDateUtc: '2019-01-22 10:24:12'
265+
updatedDateUtc: '2019-01-22T10:24:12Z'
266266
'400':
267267
description: BadRequest
268268
content:
@@ -353,8 +353,8 @@ paths:
353353
dataMonth: 2020-01
354354
users:
355355
- userId: bf3108f9-7449-4b2d-a1d1-41342dc1c991
356-
userCreatedDateUtc: '2016-04-15T04:01:42.8'
357-
lastLoginDateUtc: '2020-02-12T23:59:06.42'
356+
userCreatedDateUtc: '2016-04-15T04:01:42.8Z'
357+
lastLoginDateUtc: '2020-02-12T23:59:06.42Z'
358358
isExternalPartner: true
359359
hasAccountantRole: true
360360
monthPeriod: 2020-01
@@ -1089,14 +1089,14 @@ paths:
10891089
application/json:
10901090
schema:
10911091
$ref: '#/components/schemas/BankStatementAccountingResponse'
1092-
example: '{"bankAccountId":"1234eee9-47f0-4179-bd46-9adb4f21cc7f","bankAccountName":"ANZ BANK","bankAccountCurrencyCode":"NZD","statements":[{"statementId":"7c29eee9-47f0-4179-bd46-9adb4f21cc7f","startDate":"2021-01-01","endDate":"2021-01-02","importedDateTimeUtc":"2021-01-02T12:00:00Z","importSource":"STMTIMPORTSRC/MANUAL", "startBalance":10.0,"endBalance":200.0, "indicativeStartBalance":10.0, "indicativeEndBalance":200.0, "statementLines":[{"statementLineId":"1234eee9-47f0-4179-bd46-9adb4f21cc7f","postedDate":"2021-01-01", "payee":"ACME Thneeds ABC1234567890 SYDNEY", "reference":"Eft","notes":"payment to bank","chequeNo":"123","amount":100.0,"transactionDate":"2021-01-01","type":"Debit","isReconciled":true,"isDuplicate":false,"isDeleted":false,"payments":[{"paymentId":"47ec8431-23c2-4ef9-90e5-b440fe55d086","batchPaymentId":"ecc83387-ffaa-4023-b111-b3fd9e3e4a8e","date":"2021-01-01","amount":80.0,"bankAmount":80.0,"currencyRate":1.0,"invoice":{"invoiceId":"c01dd6ac-8835-4bf2-af8b-841db9534d7f","contact":{"contactId":"1234eee9-47f0-4179-bd46-9adb4f21cc7f","contactName":"Bob"},"total":80.0,"lineItems":[{"accountId":"f7fe1049-d1cf-4d10-9df1-67a6e363015f","reportingCode":"REV.OTH","lineAmount":80.0,"accountType":"REVENUE"}]}},{"paymentId":"54e8eee0-91a7-4a4d-bb9b-957302a2760a","batchPaymentId":"ecc83387-ffaa-4023-b111-b3fd9e3e4a8e","date":"2021-01-01","amount":15.0,"bankAmount":15.0,"currencyRate":1.0,"creditNote":{"creditNoteId":"c346d6a5-f013-4207-bc70-f2dd80a5f37f","contact":{"contactId":"1234eee9-47f0-4179-bd46-9adb4f21cc7f","contactName":"Bob"},"total":15.0,"lineItems":[{"accountId":"f7fe1049-d1cf-4d10-9df1-67a6e363015f","reportingCode":"REV.OTH","lineAmount":15.0,"accountType":"REVENUE"}]}},{"paymentId":"f94dad64-658c-491f-b901-05d38e9e8702","date":"2021-01-01","amount":5.0,"bankAmount":5.0,"currencyRate":1.0,"prepayment":{"prepaymentId":"995f81ae-0afd-4c84-bbe1-90bc7dfa4372","contact":{"contactId":"1234eee9-47f0-4179-bd46-9adb4f21cc7f","contactName":"Bob"},"total":5.0,"lineItems":[{"accountId":"f7fe1049-d1cf-4d10-9df1-67a6e363015f","reportingCode":"REV.OTH","lineAmount":5.0,"accountType":"REVENUE"}]}},{"paymentId":"6ffbe999-04c8-42d2-bf16-13947c5f1036","date":"2021-01-01","amount":5.0,"bankAmount":5.0,"currencyRate":1.0,"overpayment":{"overpaymentId":"06575718-5100-4e02-8fbf-c2731a112836","contact":{"contactId":"1234eee9-47f0-4179-bd46-9adb4f21cc7f","contactName":"Bob"},"total":5.0,"lineItems":[{"accountId":"f7fe1049-d1cf-4d10-9df1-67a6e363015f","reportingCode":"REV.OTH","lineAmount":5.0,"accountType":"REVENUE"}]}}],"bankTransactions":[{"bankTransactionId":"55edf88c-6bf6-459a-bd9b-7f250df62eb2","batchPaymentId":"2dce9b39-0427-41af-9739-9510e3b68211","contact":{"contactId":"1234eee9-47f0-4179-bd46-9adb4f21cc7f","contactName":"Bob"},"date":"2021-01-01","amount":20.0,"lineItems":[{"accountId":"f7fe1049-d1cf-4d10-9df1-67a6e363015f","reportingCode":"REV.OTH","lineAmount":20.0,"accountType":"REVENUE"}]}]}]}]}'
1092+
example: {"bankAccountId":"1234eee9-47f0-4179-bd46-9adb4f21cc7f","bankAccountName":"ANZ BANK","bankAccountCurrencyCode":"NZD","statements":[{"statementId":"7c29eee9-47f0-4179-bd46-9adb4f21cc7f","startDate":"2021-01-01","endDate":"2021-01-02","importedDateTimeUtc":"2021-01-02T12:00:00Z","importSource":"STMTIMPORTSRC/MANUAL", "startBalance":10.0,"endBalance":200.0, "indicativeStartBalance":10.0, "indicativeEndBalance":200.0, "statementLines":[{"statementLineId":"1234eee9-47f0-4179-bd46-9adb4f21cc7f","postedDate":"2021-01-01", "payee":"ACME Thneeds ABC1234567890 SYDNEY", "reference":"Eft","notes":"payment to bank","chequeNo":"123","amount":100.0,"transactionDate":"2021-01-01","type":"Debit","isReconciled":true,"isDuplicate":false,"isDeleted":false,"payments":[{"paymentId":"47ec8431-23c2-4ef9-90e5-b440fe55d086","batchPaymentId":"ecc83387-ffaa-4023-b111-b3fd9e3e4a8e","date":"2021-01-01","amount":80.0,"bankAmount":80.0,"currencyRate":1.0,"invoice":{"invoiceId":"c01dd6ac-8835-4bf2-af8b-841db9534d7f","contact":{"contactId":"1234eee9-47f0-4179-bd46-9adb4f21cc7f","contactName":"Bob"},"total":80.0,"lineItems":[{"accountId":"f7fe1049-d1cf-4d10-9df1-67a6e363015f","reportingCode":"REV.OTH","lineAmount":80.0,"accountType":"REVENUE"}]}},{"paymentId":"54e8eee0-91a7-4a4d-bb9b-957302a2760a","batchPaymentId":"ecc83387-ffaa-4023-b111-b3fd9e3e4a8e","date":"2021-01-01","amount":15.0,"bankAmount":15.0,"currencyRate":1.0,"creditNote":{"creditNoteId":"c346d6a5-f013-4207-bc70-f2dd80a5f37f","contact":{"contactId":"1234eee9-47f0-4179-bd46-9adb4f21cc7f","contactName":"Bob"},"total":15.0,"lineItems":[{"accountId":"f7fe1049-d1cf-4d10-9df1-67a6e363015f","reportingCode":"REV.OTH","lineAmount":15.0,"accountType":"REVENUE"}]}},{"paymentId":"f94dad64-658c-491f-b901-05d38e9e8702","date":"2021-01-01","amount":5.0,"bankAmount":5.0,"currencyRate":1.0,"prepayment":{"prepaymentId":"995f81ae-0afd-4c84-bbe1-90bc7dfa4372","contact":{"contactId":"1234eee9-47f0-4179-bd46-9adb4f21cc7f","contactName":"Bob"},"total":5.0,"lineItems":[{"accountId":"f7fe1049-d1cf-4d10-9df1-67a6e363015f","reportingCode":"REV.OTH","lineAmount":5.0,"accountType":"REVENUE"}]}},{"paymentId":"6ffbe999-04c8-42d2-bf16-13947c5f1036","date":"2021-01-01","amount":5.0,"bankAmount":5.0,"currencyRate":1.0,"overpayment":{"overpaymentId":"06575718-5100-4e02-8fbf-c2731a112836","contact":{"contactId":"1234eee9-47f0-4179-bd46-9adb4f21cc7f","contactName":"Bob"},"total":5.0,"lineItems":[{"accountId":"f7fe1049-d1cf-4d10-9df1-67a6e363015f","reportingCode":"REV.OTH","lineAmount":5.0,"accountType":"REVENUE"}]}}],"bankTransactions":[{"bankTransactionId":"55edf88c-6bf6-459a-bd9b-7f250df62eb2","batchPaymentId":"2dce9b39-0427-41af-9739-9510e3b68211","contact":{"contactId":"1234eee9-47f0-4179-bd46-9adb4f21cc7f","contactName":"Bob"},"date":"2021-01-01","amount":20.0,"lineItems":[{"accountId":"f7fe1049-d1cf-4d10-9df1-67a6e363015f","reportingCode":"REV.OTH","lineAmount":20.0,"accountType":"REVENUE"}]}]}]}]}
10931093
'400':
10941094
description: BadRequest
10951095
content:
10961096
application/json:
10971097
schema:
10981098
$ref: '#/components/schemas/Problem'
1099-
example: '{"type":"invalid-request","title":"InvalidRequest","status":400,"detail":"AccountId was not supplied"}'
1099+
example: {"type":"invalid-request","title":"InvalidRequest","status":400,"detail":"AccountId was not supplied"}
11001100
components:
11011101
securitySchemes:
11021102
OAuth2:
@@ -2467,4 +2467,4 @@ components:
24672467
items:
24682468
$ref: '#/components/schemas/StatementLineResponse'
24692469
description: List of statement lines
2470-
additionalProperties: false
2470+
additionalProperties: false

0 commit comments

Comments
 (0)