Skip to content

[BillingRP] Adding additional fields to Invoicing and Agreement APIs #8418

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
erich-wang merged 20 commits into from
Feb 28, 2020
Merged

[BillingRP] Adding additional fields to Invoicing and Agreement APIs #8418

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
b7bb239
Added missing fields and corrected enum values as per actual implemen…
asarkar84 Jan 30, 2020
3c346ab
Merge remote-tracking branch 'upstream/master' into ansar/invoices
asarkar84 Feb 4, 2020
91bb453
Removing unsupported LineOfCredit API
asarkar84 Feb 4, 2020
fbe8275
Delete IncreaseLineOfCreditBySubscription.json
asarkar84 Feb 4, 2020
31e4715
Merge remote-tracking branch 'upstream/master' into ansar/invoices
asarkar84 Feb 16, 2020
89e20d7
Adding additional fields to Invoicing APIs
asarkar84 Feb 17, 2020
7383169
Adding additional feilds to Agreements
asarkar84 Feb 18, 2020
fee6bd7
Merge branch 'master' into ansar/invoices
asarkar84 Feb 18, 2020
d3cc48c
Update billing.json
asarkar84 Feb 18, 2020
9ad34a3
Updated descriptions
asarkar84 Feb 18, 2020
a52410f
Upodated the agreement category enum
asarkar84 Feb 18, 2020
a3b8d1f
Updated description as per review comments.
asarkar84 Feb 18, 2020
1a63b84
Correcting typo
asarkar84 Feb 20, 2020
dfe78ea
Updated the category enum values
asarkar84 Feb 21, 2020
a285b38
Updated enum names
asarkar84 Feb 21, 2020
d7aa83e
Updated
asarkar84 Feb 24, 2020
9c5c263
Added "isMonthlyInvoice"
asarkar84 Feb 24, 2020
71f6e8e
Updated description for IsMonthlyInvoice
asarkar84 Feb 24, 2020
eaa8044
Fixed the build error
asarkar84 Feb 26, 2020
68960e5
Updated with review comments
asarkar84 Feb 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 66 additions & 3 deletions ...cation/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/billing.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6249,12 +6249,42 @@
}
},
"amountDue": {
"description": "Amount due.",
"description": "The amount due as of now.",
"readOnly": true,
"$ref": "#/definitions/Amount"
},
"azurePrepaymentApplied": {
"description": "The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.",
"readOnly": true,
"$ref": "#/definitions/Amount"
},
"billedAmount": {
"description": "Amount billed.",
"description": "The total charges for the invoice billing period.",
"readOnly": true,
"$ref": "#/definitions/Amount"
},
"creditAmount": {
"description": "The total refund for returns and cancellations during the invoice billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.",
"readOnly": true,
"$ref": "#/definitions/Amount"
},
"freeAzureCreditApplied": {
"description": "The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.",
"readOnly": true,
"$ref": "#/definitions/Amount"
},
"subTotal": {
"description": "The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.",
"readOnly": true,
"$ref": "#/definitions/Amount"
},
"taxAmount": {
"description": "The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.",
"readOnly": true,
"$ref": "#/definitions/Amount"
},
"totalAmount": {
"description": "The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.",
"readOnly": true,
"$ref": "#/definitions/Amount"
},
Expand Down Expand Up @@ -6283,6 +6313,11 @@
"modelAsString": true
}
},
"isMonthlyInvoice": {
"description": "Specifies if the invoice is generated as part of monthly invoicing cycle or not. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.",
"type": "boolean",
"readOnly": true
},
"billingProfileId": {
"description": "The billing profile id this invoice belongs to.",
"type": "string",
Expand All @@ -6294,7 +6329,7 @@
"readOnly": true
},
"purchaseOrderNumber": {
"description": "The purchase identifier for the invoice.",
"description": "An optional purchase order number used for the invoice.",
"type": "string",
"readOnly": true
},
Expand Down Expand Up @@ -7453,6 +7488,34 @@
"type": "string",
"readOnly": true
},
"category": {
"type": "string",
"description": "Category of the agreement signed by customer.",
"readOnly": true,
"enum": [
"MicrosoftCustomerAgreement",
"AffiliatePurchaseTerms",
"Other"
],
"x-ms-enum": {
"name": "category",
"modelAsString": true
}
},
"acceptanceMode": {
"type": "string",
"description": "The mode of acceptance for an agreement.",
"readOnly": true,
"enum": [
"ClickToAccept",
"ESignEmbedded",
"ESignOffline"
],
"x-ms-enum": {
"name": "acceptanceMode",
"modelAsString": true
}
},
"effectiveDate": {
"description": "Effective date.",
"type": "string",
Expand Down
2 changes: 2 additions & 0 deletions ...source-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/AgreementByName.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
"type": "Microsoft.Billing/billingAccounts/agreements",
"properties": {
"agreementLink": "https://agreementuri1.com",
"category": "MicrosoftCustomerAgreement",
"acceptanceMode": "ClickToAccept",
"effectiveDate": "2018-12-05T00:00:00Z",
"expirationDate": "2018-12-05T00:00:00Z",
"participants": [
Expand Down
4 changes: 4 additions & 0 deletions ...Microsoft.Billing/preview/2019-10-01-preview/examples/AgreementsListByBillingAccount.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
"type": "Microsoft.Billing/billingAccounts/agreements",
"properties": {
"agreementLink": "https://agreementuri1.com",
"category": "MicrosoftCustomerAgreement",
"acceptanceMode": "ClickToAccept",
"effectiveDate": "2018-12-05T00:00:00Z",
"expirationDate": "2018-12-05T00:00:00Z",
"participants": [
Expand All @@ -36,6 +38,8 @@
"type": "Microsoft.Billing/billingAccounts/agreements",
"properties": {
"agreementLink": "https://agreementuri2.com",
"category": "MicrosoftCustomerAgreement",
"acceptanceMode": "ESignEmbedded",
"effectiveDate": "2018-12-05T00:00:00Z",
"expirationDate": "2018-12-05T00:00:00Z",
"participants": [
Expand Down
64 changes: 57 additions & 7 deletions ...ger/Microsoft.Billing/preview/2019-10-01-preview/examples/BillingAccountInvoicesList.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,39 @@
"status": "Due",
"amountDue": {
"currency": "USD",
"value": 2000.00
"value": 8.53
},
"billedAmount": {
"currency": "USD",
"value": 2000.00
"value": 33.99
},
"azurePrepaymentApplied": {
"currency": "USD",
"value": 25.46
},
"creditAmount": {
"currency": "USD",
"value": 1.00
},
"freeAzureCreditApplied": {
"currency": "USD",
"value": 0.00
},
"subTotal": {
"currency": "USD",
"value": 33.99
},
"taxAmount": {
"currency": "USD",
"value": 0.00
},
"totalAmount": {
"currency": "USD",
"value": 7.53
},
"invoicePeriodStartDate": "2018-01-01T17:32:28Z",
"invoicePeriodEndDate": "2018-01-15T17:32:28Z",
"isMonthlyInvoice": false,
"billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
"billingProfileDisplayName": "Contoso Operations Billing",
"purchaseOrderNumber": "123456",
Expand All @@ -43,7 +68,7 @@
"paymentType": "credited",
"amount": {
"currency": "USD",
"value": 2000.00
"value": 1.00
},
"paymentMethodFamily": "CreditCard",
"paymentMethodType": "visa"
Expand All @@ -61,14 +86,39 @@
"status": "PastDue",
"amountDue": {
"currency": "USD",
"value": 2000.00
"value": 16.53
},
"billedAmount": {
"currency": "USD",
"value": 2000.00
"value": 33.99
},
"azurePrepaymentApplied": {
"currency": "USD",
"value": 15.46
},
"creditAmount": {
"currency": "USD",
"value": 2.00
},
"freeAzureCreditApplied": {
"currency": "USD",
"value": 0.00
},
"subTotal": {
"currency": "USD",
"value": 33.99
},
"taxAmount": {
"currency": "USD",
"value": 0.00
},
"totalAmount": {
"currency": "USD",
"value": 16.53
},
"invoicePeriodStartDate": "2018-02-01T17:32:28Z",
"invoicePeriodEndDate": "2018-02-30T17:32:28Z",
"invoicePeriodEndDate": "2018-02-28T17:32:28Z",
"isMonthlyInvoice": true,
"billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000",
"billingProfileDisplayName": "Contoso Operations Billing",
"purchaseOrderNumber": "123456",
Expand All @@ -84,7 +134,7 @@
"paymentType": "credited",
"amount": {
"currency": "USD",
"value": 2000.00
"value": 2.00
},
"paymentMethodFamily": "CreditCard",
"paymentMethodType": "visa"
Expand Down
31 changes: 28 additions & 3 deletions ...lling/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/Invoice.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,39 @@
"status": "Due",
"amountDue": {
"currency": "USD",
"value": 2000.00
"value": 16.53
},
"billedAmount": {
"currency": "USD",
"value": 2000.00
"value": 33.99
},
"azurePrepaymentApplied": {
"currency": "USD",
"value": 15.46
},
"creditAmount": {
"currency": "USD",
"value": 2.00
},
"freeAzureCreditApplied": {
"currency": "USD",
"value": 0.00
},
"subTotal": {
"currency": "USD",
"value": 33.99
},
"taxAmount": {
"currency": "USD",
"value": 0.00
},
"totalAmount": {
"currency": "USD",
"value": 16.53
},
"invoicePeriodStartDate": "2018-01-01T17:32:28Z",
"invoicePeriodEndDate": "2018-01-15T17:32:28Z",
"isMonthlyInvoice": false,
"billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}",
"billingProfileDisplayName": "Contoso Operations Billing",
"purchaseOrderNumber": "123456",
Expand All @@ -48,7 +73,7 @@
"paymentType": "credited",
"amount": {
"currency": "USD",
"value": 2000.00
"value": 2.00
},
"paymentMethodFamily": "CreditCard",
"paymentMethodType": "visa"
Expand Down
64 changes: 57 additions & 7 deletions ...r/Microsoft.Billing/preview/2019-10-01-preview/examples/InvoicesListByBillingProfile.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,39 @@
"status": "Due",
"amountDue": {
"currency": "USD",
"value": 2000.00
"value": 8.53
},
"billedAmount": {
"currency": "USD",
"value": 2000.00
"value": 33.99
},
"azurePrepaymentApplied": {
"currency": "USD",
"value": 25.46
},
"creditAmount": {
"currency": "USD",
"value": 1.00
},
"freeAzureCreditApplied": {
"currency": "USD",
"value": 0.00
},
"subTotal": {
"currency": "USD",
"value": 33.99
},
"taxAmount": {
"currency": "USD",
"value": 0.00
},
"totalAmount": {
"currency": "USD",
"value": 7.53
},
"invoicePeriodStartDate": "2018-01-01T17:32:28Z",
"invoicePeriodEndDate": "2018-01-15T17:32:28Z",
"isMonthlyInvoice": false,
"billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}",
"billingProfileDisplayName": "Contoso Operations Billing",
"purchaseOrderNumber": "123456",
Expand All @@ -52,7 +77,7 @@
"paymentType": "credited",
"amount": {
"currency": "USD",
"value": 2000.00
"value": 1.00
},
"paymentMethodFamily": "CreditCard",
"paymentMethodType": "visa"
Expand All @@ -70,14 +95,39 @@
"status": "Due",
"amountDue": {
"currency": "USD",
"value": 2000.00
"value": 16.53
},
"billedAmount": {
"currency": "USD",
"value": 2000.00
"value": 33.99
},
"azurePrepaymentApplied": {
"currency": "USD",
"value": 15.46
},
"creditAmount": {
"currency": "USD",
"value": 2.00
},
"freeAzureCreditApplied": {
"currency": "USD",
"value": 0.00
},
"subTotal": {
"currency": "USD",
"value": 33.99
},
"taxAmount": {
"currency": "USD",
"value": 0.00
},
"totalAmount": {
"currency": "USD",
"value": 16.53
},
"invoicePeriodStartDate": "2018-02-01T17:32:28Z",
"invoicePeriodEndDate": "2018-02-30T17:32:28Z",
"invoicePeriodEndDate": "2018-02-28T17:32:28Z",
"isMonthlyInvoice": true,
"billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}",
"billingProfileDisplayName": "Contoso Operations Billing",
"purchaseOrderNumber": "123456",
Expand All @@ -101,7 +151,7 @@
"paymentType": "credited",
"amount": {
"currency": "USD",
"value": 2000.00
"value": 2.00
},
"paymentMethodFamily": "CreditCard",
"paymentMethodType": "visa"
Expand Down