MonetizeNow Credit API

openapi: 3.2.0
info:
  title: OpenAPI definition Credit API
  version: v0
  description: "# About MonetizeNow\n\nMonetizeNow provides a Quoting, Billing, and Usage platform built for the B2B SaaS enterprise. Our platform simplifies monetization for SMBs by uniting these functions in a single application.\n\n<img src=\"https://i.ibb.co/VDN53ZF/MNArch.png\">\n\n## Core Platform Features\n\nMonetizeNow provides:\n\n- Product catalog specifically built to handle enterprise-grade selling complexity of subscriptions, one-time, and usage.\n- A single system that supports all your sales channels natively: self-serve, CRM, Partners, In-Product, and Marketplaces.\n- Complex enterprise quoting, flexible rules and approval engine, E-sign, Clean order forms\n- Broad API support for integrating with existing and future systems.\n    \n\n# Getting Started with MonetizeNow APIs\n\nThe MonetizeNow APIs are RESTful libraries that enable developers to integrate with the MonetizeNow platform for the complete revenue life cycle.\n\n## Authentication\n\nThe preferred authentication method is a generated API key.\n\n### Getting an API Key\n\nYou can request your API Key from your MonetizeNow tenant:\n\n1. Navigate to the **Settings -> API Keys** page to generate an API key for your tenant.\n    \n\n<img src=\"https://i.ibb.co/QMvvLtL/MNAPIKey.png\">\n\n1. Click **New Api Key**.\n2. Enter a name for the key as an identifier.\n3. Click **Ok**.\n    \n\n<img src=\"https://i.ibb.co/7WQM27b/MNKey-Sample.png\">\n\n1. Copy and store your key in a safe place.  \n    For security reasons, this is the only time we display it.\n2. Click **Ok**.\n    \n\nYou can now use this API key to interact with all MonetizeNow APIs.\n\n## Pagination\n\nThe MonetizeNow API provides pagination attributes for methods that return multiple records.\n\n**pageSize**\\=n  \npageSize indicates the number of elements in the page.\n\n**currentPage**\\=n  \ncurrentPage indicates the page to start with.\n\nUse currentPage and pageSize to return a sublist from a list of sorted resources where the sort criteria is defaulted or set via API:\n\n`GET /api/accounts?currentPage=3&pageSize=20`\n\n## Error Handling\n\nThe MonetizeNow API follows standard RESTful error handling. It returns the following error types:\n\n| Title | Code | Description |\n| --- | --- | --- |\n| Bad request | 400 | The request submitted was not acceptable. Missing parameters or a malformed request body will produce this error |\n| Resource not found by ID | 404 | The request submitted an identifier that does not match a record for the target entity. |\n| Resource is not in the required state | 409 | The identified resource is not an eligible target. For example, attempting to restore an offering that has not been archived returns a 409. |\n| Internal server error | 500 | An unexpected error occurred. Contact MonetizeNow Support. |\n\n## Webhooks\n\nUse webhooks to integrate MonetizeNow with external services. The following events are supported.\n\n| Entity | Event | Occurs When |\n| --- | --- | --- |\n| Account | account.created | an account is created |\n|  | account.updated | an account is updated |\n| Contact | contact.created | a contact is created |\n|  | contact.updated | a contact is updated |\n| Quote | quote.created | a quote is created |\n|  | quote.updated | a quote is updated |\n|  | quote.accepted | a quote is accepted |\n|  | quote.processed | a quote is processed |\n|  | quote.cancelled | a quote is cancelled |\n|  | quote.offering.created | an offering is added to a quote |\n|  | quote.offering.updated | an offering on a quote is updated |\n|  | quote.offering.deleted | an offering is deleted from a quote |\n| Opportunity | opportunity.created | an opportunity is created |\n|  | opportunity.updated | an opportunity is updated |\n| Offering | offering.created | an offering is created |\n|  | offering.updated | an offering is updated |\n| Contract | contract.created | a contract is created |\n|  | contract.updated | a contract is updated |\n| Rate | rate.created | a rate is created |\n|  | rate.updated | a rate is updated |\n|  | rate.deleted | a rate is deleted |\n|  | price.deleted | a rate's price is deleted |\n| Bill Group | dunning.step.tiggered | a dunning step is triggered |\n\n# Concepts\n\n## Product Catalog\n\nThe core of the MonetizeNow platform is the product catalog.\n\nThe entities that make up the Product Catalog are:\n\n- Product\n- Usage Type\n- Price\n- Offering\n- Rate\n    \n\nThe **Product** is the starting point for any quote, the simplest line item. If that line item has a usage component, then a **Usage Type** is assigned. A single Product has a **Price**. However, a Product can be one of several included in an **Offering**, or bundle. Offerings are available at one \\*_Rate \\*_or more. A Rate is a different way to price products and model an offering. You can create multiple Rates of different currencies and billing frequencies.\n\nFor example, the Products in a product catalog might include software access, services, setup fees, and API calls. Your organization may allow a customer to order a single set of 200 API calls, or you may provide a package of support hours and API calls as an Offering. Prices might be directly related to set of API calls or calculated by means of an \"Get Started\" Offering and Rate for API access.\n\n## Accounts\n\nAccounts represent your existing and potential customers.\n\nThe entities related to account records include:\n\n- Contacts\n- Bill Groups\n- Subscriptions\n- Quotes\n- Contracts\n- Invoices\n- Credits\n- Payments\n    \n\nEach **Account** represents a current or potential customer. **Contacts** are people your organization has interacted with. **Bill Groups** represent departments, divisions, or other separate destinations for billing within that business. A **Subscription** represents a renewable request for an **Offering**. A **Quote** is a formal statement of what is being ordered and how much the items will cost. A **Contract** stores information on the Subscriptions that have been quoted and captures the result of Quote acceptance. An **Invoice** results from the agreement to make a purchase. It includes items and costs, as well as payment conditions. An Invoice might include **Credits** as adjustments to the Invoice, reducing the final amount due.\n\nFor example, you might have an Account with Acme, Inc. During the sales process, your team has interacted with John, Paul, and Janis, who are now Contacts. John and Paul are in the Construction Bill Group, while Janis is in the Demolition Bill Group, reflecting their organization's structure and different payment policies. Once Janis requests a Quote for Offering A, your team adds that Offering to her Subscription. A Contract is included to specify the parameters of customer support limitations for onboarding. When Janis agrees to the purchase, your team generates an Invoice, including Credits for participation in a webinar.\n\n### Bill Day and Invoices\n\nEach **Bill Group** has a **Bill Day** field. Bill Day specifies the day of the month on which **Invoices** will be generated. Bill Day defaults to the day on which the Bill Group was created unless you specify an alternate number in the Bill Day field.\n\n### Quotes and Future Start Dates\n\nYou might set the **Start Date** of a **Quote** to a future date, maybe to align with your customer's budgeting process. That date automatically applies to the associated **Contract**. In this case, both the Contract and the quoted **Subscriptions** remain in a Pending state until the Start Date.\n\n### Payment Methods\n\nThe **Payment Methods** available to a **Bill Group** represent the payment service providers you have integrated with your MonetizeNow tenant. Payments made through integrated gateways are reflected in **Payment** records credited to the Bill Group.\n\n# Sample Workflows\n\n## Sending Usage/Consumption Data\n\nSending Usage Events to the MonetizeNow Usage Service requires calls to both the CPQ/Billing API and the Usage API. Here's a basic workflow:\n\n| Task | Call |\n| --- | --- |\n| Get Subscriptions for Account | GET /api/accounts/{accountId}/subscriptions |\n| Determine which Usage Types apply to each Subscription |  |\n| Post usage Events by Subscription | POST /events |\n\n# Object Life Cycles\n\n## Quotes\n\nThe Quote life cycle depends on whether the request for a new quote is actually a renewal or amendment of an existing quote. Event for a customer who has ordered before, any difference in the underlying contract makes a the new quote route necessary. The following diagram outlines the differences in the life cycles of new quotes and renewals.\n\n<img src=\"https://i.ibb.co/YyFztCC/Quote-Life-Cycle.png\">\n\n<!-- stackedit_data:<br>eyJoaXN0b3J5IjpbLTE0ODQxMzYzMzksLTExMDMyOTg1MzEsMT<br>M2MTI2MDY3MywtMTUwMTM1NjU1NywzODU3MzI2OTAsMjA1NTI2<br>NDUzMywtMjE0Mjk1NDY3NCwtMzYzNzk4NzAyLC0xNTEyNzQ4OD<br>Q2XX0=<br> -->"
servers:
- url: https://api.monetizeplatform.com
tags:
- name: Credit
  description: Credits can be used to adjust account balances.
paths:
  /api/accounts/{accountId}/billGroups/{billGroupId}/credits:
    post:
      tags:
      - Credit
      summary: Create a credit
      description: Create a credit which can be used to adjust account balance
      operationId: createCredit
      parameters:
      - name: accountId
        in: path
        required: true
        schema:
          type: string
          example: acct_jgPH8G33rELY6LQa
        example: acct_jgPH8G33rELY6LQa
      - name: billGroupId
        in: path
        required: true
        schema:
          type: string
          example: billg_tDbC2FxuCwQoxcjm
        example: billg_tDbC2FxuCwQoxcjm
      - name: x-api-key
        in: header
        description: x-api-key is an authentication or authorization token used in API requests to verify the identity and permissions of the client
        required: true
        schema:
          type: string
          example: TYQ1YzM3NWItZjQzMi00NDYwLTlmOWYtN2UwNzI5YzM2ZmV0
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/com.monytyz.billing.credit.dto.credit.CreditSaveDto'
        required: true
      responses:
        '201':
          description: Credit saved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/com.monytyz.billing.credit.dto.credit.CreditDetailDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/com.monytyz.billing.common.dto.ResponseDto'
        '500':
          description: Internal server error. Please contact the support team.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/com.monytyz.billing.common.dto.ResponseDto'
  /api/accounts/{accountId}/billGroups/{billGroupId}/credits/{creditId}:
    put:
      tags:
      - Credit
      summary: Update a credit
      description: Update a credit which can be used to adjust account balance
      operationId: updateCredit
      parameters:
      - name: accountId
        in: path
        required: true
        schema:
          type: string
          example: acct_jgPH8G33rELY6LQa
        example: acct_jgPH8G33rELY6LQa
      - name: billGroupId
        in: path
        required: true
        schema:
          type: string
          example: billg_tDbC2FxuCwQoxcjm
        example: billg_tDbC2FxuCwQoxcjm
      - name: creditId
        in: path
        required: true
        schema:
          type: string
          example: crdt_3oUtURRnJJ8Afdw0
        example: crdt_3oUtURRnJJ8Afdw0
      - name: x-api-key
        in: header
        description: x-api-key is an authentication or authorization token used in API requests to verify the identity and permissions of the client
        required: true
        schema:
          type: string
          example: TYQ1YzM3NWItZjQzMi00NDYwLTlmOWYtN2UwNzI5YzM2ZmV0
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/com.monytyz.billing.credit.dto.credit.CreditSaveDto'
        required: true
      responses:
        '200':
          description: Update credit
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/com.monytyz.billing.credit.dto.credit.CreditDetailDto'
        '404':
          description: Credit not found
        '500':
          description: Internal server error. Please contact the support team.
  /api/credits/{creditId}:
    get:
      tags:
      - Credit
      summary: Get credit by id
      description: Get credit by credit id
      operationId: getCreditsById
      parameters:
      - name: creditId
        in: path
        required: true
        schema:
          type: string
          example: crdt_3oUtURRnJJ8Afdw0
        example: crdt_3oUtURRnJJ8Afdw0
      - name: x-api-key
        in: header
        description: x-api-key is an authentication or authorization token used in API requests to verify the identity and permissions of the client
        required: true
        schema:
          type: string
          example: TYQ1YzM3NWItZjQzMi00NDYwLTlmOWYtN2UwNzI5YzM2ZmV0
      responses:
        '200':
          description: Get credit by id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/com.monytyz.billing.credit.dto.credit.CreditDetailDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/com.monytyz.billing.common.dto.ResponseDto'
        '404':
          description: Resource not found by Id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/com.monytyz.billing.common.dto.ResponseDto'
        '500':
          description: Internal server error. Please contact the support team.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/com.monytyz.billing.common.dto.ResponseDto'
  /api/credits/{creditId}/customFields:
    put:
      tags:
      - Credit
      summary: Set Custom Fields For Credit
      description: Set Custom Fields For Credit by id
      operationId: setCustomFields_1
      parameters:
      - name: creditId
        in: path
        required: true
        schema:
          type: string
          example: crdt_3oUtURRnJJ8Afdw0
        example: crdt_3oUtURRnJJ8Afdw0
      - name: x-api-key
        in: header
        description: x-api-key is an authentication or authorization token used in API requests to verify the identity and permissions of the client
        required: true
        schema:
          type: string
          example: TYQ1YzM3NWItZjQzMi00NDYwLTlmOWYtN2UwNzI5YzM2ZmV0
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties:
                type: object
        required: true
      responses:
        '204':
          description: Custom fields updated
        '400':
          description: Bad Request
        '404':
          description: Quote not found
        '500':
          description: Internal server error. Please contact the support team.
  /api/credits/{creditId}/print:
    get:
      tags:
      - Credit
      summary: Get credit in pdf
      description: Get credit in pdf by credit id
      operationId: getCreditInPdf
      parameters:
      - name: Accept
        in: header
        required: false
        schema:
          type: string
          default: application/pdf
      - name: creditId
        in: path
        required: true
        schema:
          type: string
          example: crdt_3oUtURRnJJ8Afdw0
        example: crdt_3oUtURRnJJ8Afdw0
      - name: x-api-key
        in: header
        description: x-api-key is an authentication or authorization token used in API requests to verify the identity and permissions of the client
        required: true
        schema:
          type: string
          example: TYQ1YzM3NWItZjQzMi00NDYwLTlmOWYtN2UwNzI5YzM2ZmV0
      responses:
        '200':
          description: Credit PDF by ID
          content:
            application/pdf:
              schema:
                type: string
                format: binary
        '404':
          description: Resource not found by Id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/com.monytyz.billing.common.dto.ResponseDto'
        '500':
          description: Internal server error. Please contact the support team.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/com.monytyz.billing.common.dto.ResponseDto'
  /api/credits/{creditId}/void:
    post:
      tags:
      - Credit
      summary: Void a credit by credit id
      description: Void a credit
      operationId: voidCredit
      parameters:
      - name: creditId
        in: path
        required: true
        schema:
          type: string
          example: crdt_3oUtURRnJJ8Afdw0
        example: crdt_3oUtURRnJJ8Afdw0
      - name: x-api-key
        in: header
        description: x-api-key is an authentication or authorization token used in API requests to verify the identity and permissions of the client
        required: true
        schema:
          type: string
          example: TYQ1YzM3NWItZjQzMi00NDYwLTlmOWYtN2UwNzI5YzM2ZmV0
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/com.monytyz.billing.credit.dto.credit.CreditVoidRequest'
        required: true
      responses:
        '200':
          description: Credit voided
        '400':
          description: Bad Request
        '404':
          description: Credit not found
        '500':
          description: Internal server error. Please contact the support team.
components:
  schemas:
    com.monytyz.billing.common.dto.ResponseDto:
      type: object
      properties:
        status:
          type: integer
          format: int32
        message:
          type: string
    com.monytyz.billing.credit.dto.credit.CreditVoidRequest:
      required:
      - reason
      type: object
      properties:
        reason:
          type: string
    com.monytyz.billing.transactable.TargetId:
      required:
      - value
      type: object
      properties:
        value:
          type: string
    com.monytyz.billing.transactable.model.enums.TargetType:
      type: object
    com.monytyz.billing.credit.dto.credit.CreditDetailDto:
      type: object
      properties:
        createdBy:
          type: string
          description: Identifier for the user who created the record
          example: usr_X0XZ05bvkrB1RpLS
        createDate:
          type: string
          description: Timestamp of when the record was created
          format: date-time
        lastModifiedBy:
          type: string
          description: Identifier for the user who last modified the record
          example: usr_X0XZ05bvkrB1RpLS
        modifyDate:
          type: string
          description: Timestamp of when the record was last modified
          format: date-time
        id:
          type: string
          description: Unique identifier for the Credit
          example: crdt_CMxSdjFUrzCLqFil
        accountId:
          type: string
          description: Account id associated with Credit
          example: acct_m0CB9LflojZxytfC
        accountSummary:
          $ref: '#/components/schemas/com.monytyz.billing.customer.dto.account.AccountSummary'
        billGroupId:
          type: string
          description: Billgroup id associated with Credit
          example: billg_tDbC2FxuCwQoxcjm
        creditNoteId:
          type: string
          description: ID for the Note of this credit
          example: crdnt_mluwn46VyWhERErW
        prepaidInvoiceItemId:
          type: string
          description: Invoice item id for prepaid invoice
          example: invce_q0xESEWovN7JvfAe
        status:
          type: string
          description: Status of the credit. Describes if it can be ACTIVE,INACTIVE,CANCELED or APPLIED
          enum:
          - ACTIVE
          - INACTIVE
          - VOID
          - EXPIRED
          - APPLIED
        type:
          type: string
          description: Type of the credit. Can be  CREDIT_NOTE,SERVICE,PREPAID
          enum:
          - CREDIT_NOTE
          - SERVICE
          - PREPAID
        currency:
          type: string
          description: Currency for the credit amount
          enum:
          - AUD
          - BYN
          - CAD
          - CNY
          - DKK
          - EUR
          - GBP
          - INR
          - ISK
          - MYR
          - NOK
          - SEK
          - SGD
          - TWD
          - USD
        amount:
          type: number
          description: Amount which can be applied
          example: 200
        amountApplied:
          type: number
          description: Amount which was applied
          example: 10
        amountRemaining:
          type: number
          description: Remaining amount which isn't applied yet
          example: 190
        expirationDate:
          type: string
          description: Expiration date for this credit
          format: date
        reason:
          type: string
          description: Reason why this credit exists/created
          example: Created from Credit Note (crdnt_D2D8l6KW6Qky6rIz)
        name:
          type: string
          description: Name of the credit
        appliedDate:
          type: string
          description: Date when this credit was applied
          format: date
        creditApplications:
          type: array
          description: Application(s) of this credit on invoice(s)
          items:
            $ref: '#/components/schemas/com.monytyz.billing.credit.dto.creditnote.CreditApplicationDto'
        applications:
          type: array
          description: Application(s) of this credit
          items:
            $ref: '#/components/schemas/com.monytyz.billing.transactable.dto.SourceApplicationSummary'
        aggregatedApplications:
          type: array
          description: Aggregated application(s) of this credit
          items:
            $ref: '#/components/schemas/com.monytyz.billing.transactable.dto.AggregatedSourceApplicationSummary'
        customFields:
          type: object
          additionalProperties:
            type: object
            description: User configured custom fields for the credit
          description: User configured custom fields for the credit
        voidReason:
          type: string
          description: Reason why this credit was voided.
    com.monytyz.billing.customer.dto.account.AccountSummary:
      required:
      - accountType
      - id
      - isTestAccount
      - status
      type: object
      properties:
        id:
          type: string
        customId:
          type: string
        isTestAccount:
          type: boolean
        locale:
          type: string
        accountName:
          type: string
        defaultCurrency:
          type: string
          enum:
          - AUD
          - BYN
          - CAD
          - CNY
          - DKK
          - EUR
          - GBP
          - INR
          - ISK
          - MYR
          - NOK
          - SEK
          - SGD
          - TWD
          - USD
        status:
          type: string
          enum:
          - ACTIVE
          - CANCELED
          - SUSPENDED
          - INACTIVE
        accountType:
          type: string
          enum:
          - CUSTOMER
          - PARTNER
        defaultLegalEntityId:
          type: string
    com.monytyz.billing.credit.dto.credit.CreditSaveDto:
      type: object
      properties:
        creditNoteId:
          type: string
          description: ID for the Note of this credit
          example: ctnt_QEPqCDqeaVte5WzM
        prepaidInvoiceItemId:
          type: string
          description: Invoice item id for prepaid invoice
          example: ivitm_DHlWk4mIICkQabl0
        prepaidProductId:
          type: string
          description: Id for prepaid product
          example: prod_nStU73ZJahgBSxnh
        status:
          type: string
          description: Status of the credit. Describes if it can be ACTIVE,INACTIVE,CANCELED or APPLIED
          enum:
          - ACTIVE
          - INACTIVE
          - VOID
          - EXPIRED
          - APPLIED
        type:
          type: string
          description: Type of the credit. Can be  CREDIT_NOTE,SERVICE,PREPAID
          enum:
          - CREDIT_NOTE
          - SERVICE
          - PREPAID
        currency:
          type: string
          description: Currency for the credit amount
          enum:
          - AUD
          - BYN
          - CAD
          - CNY
          - DKK
          - EUR
          - GBP
          - INR
          - ISK
          - MYR
          - NOK
          - SEK
          - SGD
          - TWD
          - USD
        amount:
          type: number
          description: Amount which can be applied
        expirationDate:
          type: string
          description: Expiration date for this credit
          format: date
        reason:
          maxLength: 255
          minLength: 0
          type: string
          description: Reason why this credit exists/created
          example: Billing
        name:
          type: string
          description: Name of the credit
        customFields:
          type: object
          additionalProperties:
            type: object
            description: User configured custom fields for the credit
          description: User configured custom fields for the credit
    com.monytyz.billing.transactable.dto.AggregatedSourceApplicationSummary:
      required:
      - amount
      - targetId
      - targetType
      type: object
      properties:
        targetId:
          $ref: '#/components/schemas/com.monytyz.billing.transactable.TargetId'
        targetType:
          $ref: '#/components/schemas/com.monytyz.billing.transactable.model.enums.TargetType'
        amount:
          type: number
      description: Aggregated application(s) of the credit note
    com.monytyz.billing.credit.dto.creditnote.CreditApplicationDto:
      required:
      - amountApplied
      - creditId
      - invoiceId
      type: object
      properties:
        invoiceId:
          type: string
          description: Unique identifier for the invoice to which credit was fully or partially applied
          example: invce_q0xESEWovN7JvfAe
        creditId:
          type: string
          description: Unique identifier for the applied credit
          example: crdt_CMxSdjFUrzCLqFil
        amountApplied:
          type: number
          description: Amount of the credit applied to the invoice
          example: 100
      description: Application(s) of this credit on invoice(s)
    com.monytyz.billing.transactable.dto.SourceApplicationSummary:
      required:
      - amount
      - applicationDate
      - targetId
      - targetType
      - type
      type: object
      properties:
        targetId:
          $ref: '#/components/schemas/com.monytyz.billing.transactable.TargetId'
        targetType:
          $ref: '#/components/schemas/com.monytyz.billing.transactable.model.enums.TargetType'
        amount:
          type: number
        type:
          type: string
          enum:
          - APPLICATION
          - UNAPPLICATION
        applicationDate:
          type: string
          format: date-time
      description: All application(s) of the credit note