Conga

Conga Credit Memos API

API controller for managing credit memo operations.

GitHub OpenAPI

Operations 3

POST /creditmemos/approve Approve one or more credit memos #
POST /creditmemos/cancel Cancels one or more credit memos #
GET /creditmemos/{id} Retrieve credit memo details #

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/authentication/conga-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/rate-limits/conga-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/openapi/conga-credit-memos-api-openapi.yml

Other Resources

🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/data-model/conga-data-model.yml
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/scopes/conga-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/conventions/conga-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/errors/conga-problem-types.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/lifecycle/conga-lifecycle.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/conformance/conga-conformance.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/sandbox/conga-sandbox.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/asyncapi/conga-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/conga-credit-memos-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

conga-credit-memos-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Invoice Management Credit Memos API
  version: 1.0.0
  description: API controller for managing credit memo operations.
servers:
- url: https://rls.congacloud.com/api/invoicing/v1
security:
- Bearer: []
tags:
- name: Credit Memos
  description: API controller for managing credit memo operations.
paths:
  /creditmemos/approve:
    post:
      tags:
      - Credit Memos
      summary: Approve one or more credit memos
      description: 'This endpoint allows bulk approval of credit memos. Each credit memo is processed independently,

        enabling partial success scenarios where some credit memos may be approved while others fail validation.


        **Conditions:**

        - Only credit memos with status ''Draft'' or ''Pending Approval'' can be approved.


        **Effects of approval:**

        - Credit memo status is updated to ''Approved''.

        - All related Credit Memo Line Items are approved.

        - Related Billing Schedule Records and Billing Schedule Details are marked as ''Invoiced''.

        - Billing Header Rollup - Total Invoice Amount and Total Pending Amount are updated.'
      requestBody:
        description: The request containing the list of credit memo IDs to approve.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreditMemoApprovalRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/CreditMemoApprovalRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/CreditMemoApprovalRequest'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ApprovalResponseBatchResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ApprovalResponseBatchResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ApprovalResponseBatchResponse'
        '207':
          description: Multi-Status
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ApprovalResponseBatchResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ApprovalResponseBatchResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ApprovalResponseBatchResponse'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ErrorApiResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorApiResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ErrorApiResponse'
      operationId: postCreditmemosApprove
      x-operation-id-source: derived
  /creditmemos/cancel:
    post:
      tags:
      - Credit Memos
      summary: Cancels one or more credit memos
      description: 'This endpoint allows bulk cancellation of credit memos. Each credit memo is processed independently,

        enabling partial success scenarios where some credit memos may be cancelled while others fail validation.


        **Conditions:**

        - Only credit memos with status ''Approved'' and payment status ''Uncredited'' can be cancelled.


        **Effects of Cancellation:**

        - Credit memo status is updated to ''Cancelled''.

        - All related Credit Memo Line Items are Cancelled.

        - Billing Header Rollup - Total Credit Memo Amount and Total Pending Amount are updated.'
      requestBody:
        description: The request containing the list of credit memo IDs to cancel.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreditMemoCancellationRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/CreditMemoCancellationRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/CreditMemoCancellationRequest'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CancellationResponseBatchResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/CancellationResponseBatchResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/CancellationResponseBatchResponse'
        '207':
          description: Multi-Status
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CancellationResponseBatchResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/CancellationResponseBatchResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/CancellationResponseBatchResponse'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ErrorApiResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorApiResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ErrorApiResponse'
      operationId: postCreditmemosCancel
      x-operation-id-source: derived
  /creditmemos/{id}:
    get:
      tags:
      - Credit Memos
      summary: Retrieve credit memo details
      description: 'This method fetches an existing credit memo from the data store and translates it

        to a response object that can be sent to clients. The method supports viewing the details

        of a previously created credit memo.'
      parameters:
      - name: id
        in: path
        description: The unique identifier of the credit memo to retrieve.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CreditMemoResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/CreditMemoResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/CreditMemoResponse'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ErrorApiResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorApiResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ErrorApiResponse'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ErrorApiResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorApiResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ErrorApiResponse'
      operationId: getCreditmemosById
      x-operation-id-source: derived
components:
  schemas:
    LookupObject:
      type: object
      properties:
        Id:
          type:
          - string
          - 'null'
        Name:
          type:
          - string
          - 'null'
      additionalProperties: false
    ApprovalResponse:
      type: object
      properties:
        Id:
          type:
          - string
          - 'null'
        RecordIndex:
          type: integer
          format: int32
        IsSuccess:
          type: boolean
        Errors:
          type:
          - array
          - 'null'
          items:
            type: string
        ErrorMessage:
          type:
          - string
          - 'null'
          deprecated: true
      additionalProperties: false
      description: 'Represents the result of approving a single entity (e.g., invoice or credit memo) within a batch approval operation.

        Inherits from Conga.MAF.Entities.Responses.BaseResponse to support standardized batch response handling.'
    CurrencyField:
      type: object
      properties:
        Value:
          type: number
          format: double
        DisplayValue:
          type: number
          format: double
          readOnly: true
        CurrencyCode:
          type:
          - string
          - 'null'
          readOnly: true
        CurrencySymbol:
          type:
          - string
          - 'null'
          readOnly: true
      additionalProperties: false
    CreditMemo:
      type: object
      properties:
        Id:
          type:
          - string
          - 'null'
        Name:
          type:
          - string
          - 'null'
        CreatedBy:
          $ref: '#/components/schemas/LookupObject'
        CreatedDate:
          type: string
          format: date-time
        ModifiedBy:
          $ref: '#/components/schemas/LookupObject'
        ModifiedDate:
          type: string
          format: date-time
        ExternalId:
          type:
          - string
          - 'null'
        ETag:
          type:
          - string
          - 'null'
        CMNumber:
          type:
          - string
          - 'null'
        InvoiceRequestResult:
          $ref: '#/components/schemas/LookupObject'
        BillTo:
          $ref: '#/components/schemas/LookupObject'
        BillToLocation:
          $ref: '#/components/schemas/LookupObject'
        ShipTo:
          $ref: '#/components/schemas/LookupObject'
        ApprovalStatus:
          type:
          - string
          - 'null'
        BusinessReason:
          type:
          - string
          - 'null'
        Currency:
          type:
          - string
          - 'null'
        CreditMemoDate:
          type: string
          format: date-time
        TotalCreditForOneTimeProducts:
          $ref: '#/components/schemas/CurrencyField'
        TotalCreditForRecurringProducts:
          $ref: '#/components/schemas/CurrencyField'
        TotalCreditForEvergreenProducts:
          $ref: '#/components/schemas/CurrencyField'
        TotalCreditForUsageProducts:
          $ref: '#/components/schemas/CurrencyField'
        SubTotal:
          $ref: '#/components/schemas/CurrencyField'
        TaxAmount:
          $ref: '#/components/schemas/CurrencyField'
        CreditMemoTotal:
          $ref: '#/components/schemas/CurrencyField'
        AppliedAmount:
          $ref: '#/components/schemas/CurrencyField'
        RecordType:
          type:
          - string
          - 'null'
        SoldTo:
          $ref: '#/components/schemas/LookupObject'
        ShipToLocation:
          $ref: '#/components/schemas/LookupObject'
        SoldToLocation:
          $ref: '#/components/schemas/LookupObject'
        Description:
          type:
          - string
          - 'null'
        ErrorStatus:
          type:
          - string
          - 'null'
        ErrorMessage:
          type:
          - string
          - 'null'
        CreditMemoDocumentTemplate:
          $ref: '#/components/schemas/LookupObject'
        CreditMemoEmailTemplate:
          $ref: '#/components/schemas/LookupObject'
        PaymentStatus:
          type:
          - string
          - 'null'
        Invoice:
          $ref: '#/components/schemas/LookupObject'
        Key:
          type:
          - string
          - 'null'
      additionalProperties: {}
    ApiError:
      type: object
      properties:
        Source:
          type:
          - string
          - 'null'
        Title:
          type:
          - string
          - 'null'
        Detail: {}
        Help:
          type:
          - string
          - 'null'
      additionalProperties: false
    CreditMemoResponse:
      type: object
      properties:
        CreditMemo:
          $ref: '#/components/schemas/CreditMemo'
        CreditMemoLineItems:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CreditMemoLineItem'
          description: Gets or sets the list of credit memo line items.
        ARTransactions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RelatedARTransaction'
          description: Gets or sets the list of related accounts receivable transactions.
      additionalProperties: false
      description: Represents the response for a credit memo, containing the credit memo details, associated line items, and accounts receivable transactions.
    CreditMemoLineItem:
      type: object
      properties:
        Id:
          type:
          - string
          - 'null'
        Name:
          type:
          - string
          - 'null'
        CreatedBy:
          $ref: '#/components/schemas/LookupObject'
        CreatedDate:
          type: string
          format: date-time
        ModifiedBy:
          $ref: '#/components/schemas/LookupObject'
        ModifiedDate:
          type: string
          format: date-time
        ExternalId:
          type:
          - string
          - 'null'
        ETag:
          type:
          - string
          - 'null'
        CreditMemoLineItemName:
          type:
          - string
          - 'null'
        Category:
          type:
          - string
          - 'null'
        PriceType:
          type:
          - string
          - 'null'
        CreditMemo:
          $ref: '#/components/schemas/LookupObject'
        BillingScheduleRecord:
          $ref: '#/components/schemas/LookupObject'
        AppliedInvoiceLineItem:
          $ref: '#/components/schemas/LookupObject'
        BillTo:
          $ref: '#/components/schemas/LookupObject'
        ShipTo:
          $ref: '#/components/schemas/LookupObject'
        SoldTo:
          $ref: '#/components/schemas/LookupObject'
        BillToLocation:
          $ref: '#/components/schemas/LookupObject'
        ShipToLocation:
          $ref: '#/components/schemas/LookupObject'
        SoldToLocation:
          $ref: '#/components/schemas/LookupObject'
        AssetLineItem:
          $ref: '#/components/schemas/LookupObject'
        OrderLineItem:
          $ref: '#/components/schemas/LookupObject'
        Contracted:
          type: boolean
        CreditedQuantity:
          type: number
          format: double
        Product:
          $ref: '#/components/schemas/LookupObject'
        StartDate:
          type: string
          format: date-time
        EndDate:
          type: string
          format: date-time
        CreditAmount:
          $ref: '#/components/schemas/CurrencyField'
        SubTotal:
          $ref: '#/components/schemas/CurrencyField'
        Tax:
          $ref: '#/components/schemas/CurrencyField'
        TotalAmount:
          $ref: '#/components/schemas/CurrencyField'
        ApprovalStatus:
          type:
          - string
          - 'null'
        Currency:
          type:
          - string
          - 'null'
      additionalProperties: {}
    CreditMemoApprovalRequest:
      type: object
      properties:
        Ids:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Gets or sets the list of invoice IDs to approve.
      additionalProperties: false
      description: Represents a request to approve one or more credit memos.
    CreditMemoCancellationRequest:
      type: object
      properties:
        Ids:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Gets or sets the list of credit memo IDs to cancel.
      additionalProperties: false
      description: Represents a request to cancel one or more credit memos.
    CancellationResponseBatchResponse:
      type: object
      properties:
        Summary:
          type:
          - string
          - 'null'
        Results:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CancellationResponse'
      additionalProperties: false
    RelatedARTransaction:
      type: object
      properties:
        Id:
          type:
          - string
          - 'null'
        Name:
          type:
          - string
          - 'null'
        CreatedBy:
          $ref: '#/components/schemas/LookupObject'
        CreatedDate:
          type: string
          format: date-time
        ModifiedBy:
          $ref: '#/components/schemas/LookupObject'
        ModifiedDate:
          type: string
          format: date-time
        ExternalId:
          type:
          - string
          - 'null'
        ETag:
          type:
          - string
          - 'null'
        TransactionDate:
          type: string
          format: date-time
        SystemGenerated:
          type: boolean
        TransactionType:
          type:
          - string
          - 'null'
        Description:
          type:
          - string
          - 'null'
        Invoice:
          $ref: '#/components/schemas/LookupObject'
        CreditMemo:
          $ref: '#/components/schemas/LookupObject'
        SourceCreditMemo:
          $ref: '#/components/schemas/LookupObject'
        SourceInvoice:
          $ref: '#/components/schemas/LookupObject'
        StartingBalance:
          $ref: '#/components/schemas/CurrencyField'
        ARAmount:
          $ref: '#/components/schemas/CurrencyField'
        EndingBalance:
          $ref: '#/components/schemas/CurrencyField'
        Currency:
          type:
          - string
          - 'null'
        ARTransactionAutoNumber:
          type:
          - string
          - 'null'
      additionalProperties: {}
    CancellationResponse:
      type: object
      properties:
        Id:
          type:
          - string
          - 'null'
        RecordIndex:
          type: integer
          format: int32
        IsSuccess:
          type: boolean
        Errors:
          type:
          - array
          - 'null'
          items:
            type: string
        ErrorMessage:
          type:
          - string
          - 'null'
          deprecated: true
      additionalProperties: false
      description: 'Represents the result of cancelling a single entity (e.g., invoice or credit memo).

        Inherits from Conga.MAF.Entities.Responses.BaseResponse to support standardized batch response handling.'
    ApprovalResponseBatchResponse:
      type: object
      properties:
        Summary:
          type:
          - string
          - 'null'
        Results:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ApprovalResponse'
      additionalProperties: false
    ErrorApiResponse:
      type: object
      properties:
        Errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ApiError'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header