Jump to

• Request
• Response

Retrieves all the credit memos with the organization of logged in profile

get

/ccstore/v1/selfservice/invoices/creditMemos

Request

Supported Media Types

• application/json

Query Parameters

• finder: array
  Filter response fields
• limit: integer
  Specifies the number of invoices to be retrieved starting from offset. Default value for the limit is 25 and max value is also 25. In case this is not present, complete list or max limit list (whichever is lower) of credit memos will be returned.
• offset: integer
  Starting index when paging through credit memo list.
• orderBy: string
  The sort order
• q: string
  The query to use
• totalResults: boolean
  Calculate total results count

  Default Value: false

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returned when operation succeeds.

Body ()

Root Schema : getCreditMemos_success_response

Example Response (application/json)

{
    "offset":0,
    "count":2,
    "hasMore":true,
    "limit":25,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstoreui/v1/selfservice/invoices/creditMemos"
        },
        {
            "rel":"next",
            "href":"http://localhost:8080/ccstoreui/v1/selfservice/invoices/creditMemos?offset=25&limit=25"
        }
    ],
    "items":[
        {
            "BillToCustomerName":"Computer Service and Rentals",
            "TransactionType":"WF_Credit Memo",
            "TransactionNumber":"510325",
            "TransactionSource":"LEGACY",
            "CreditMemoCurrency":"EUR",
            "CreditMemoStatus":"Complete",
            "CustomerTransactionId":"503632",
            "@context":{
                "headers":{
                    "ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                },
                "key":"503632"
            },
            "EnteredAmount":"-3190",
            "BillToSite":"Essen",
            "CrossReference":"631121010",
            "BillToContact":null,
            "CreditReason":null,
            "TransactionDate":"2006-06-15"
        },
        {
            "BillToCustomerName":"Computer Service and Rentals",
            "TransactionType":"WF_Credit Memo",
            "TransactionNumber":"510004",
            "TransactionSource":"LEGACY",
            "CreditMemoCurrency":"EUR",
            "CreditMemoStatus":"Complete",
            "CustomerTransactionId":"490504",
            "@context":{
                "headers":{
                    "ETag":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                },
                "key":"490504"
            },
            "EnteredAmount":"-5075",
            "BillToSite":"Essen",
            "CrossReference":"631120410",
            "BillToContact":null,
            "CreditReason":null,
            "TransactionDate":"2006-05-14"
        }
    ]
}

Default Response

Returned when operation fails.

Body ()

Root Schema : getCreditMemos_failure_response

Back to Top