Skip to content

Commit

Permalink
[BillingRP] Adding additional fields to Invoicing and Agreement APIs (#…
Browse files Browse the repository at this point in the history
…8418)

* Added missing fields and corrected enum values as per actual implementation

* Removing unsupported LineOfCredit API

Removing unsupported LineOfCredit API

* Delete IncreaseLineOfCreditBySubscription.json

* Adding additional fields to Invoicing APIs

Adding additional fields to Invoicing APIs

* Adding additional feilds to Agreements

Adding additional feilds to Agreements

* Update billing.json

* Updated descriptions

* Upodated the agreement category enum

* Updated description as per review comments.

* Correcting typo

* Updated the category enum values

* Updated enum names

* Updated

* Added "isMonthlyInvoice"

* Updated description for IsMonthlyInvoice

Updated description for IsMonthlyInvoice

* Fixed the build error

* Updated with review comments
  • Loading branch information
asarkar84 authored Feb 28, 2020
1 parent 60325f2 commit 95559c6
Show file tree
Hide file tree
Showing 6 changed files with 214 additions and 20 deletions.
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
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
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
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
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
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

0 comments on commit 95559c6

Please sign in to comment.