Create Credit memo -> Credit memo amount' is required.

Hi,

I can create invoice by API, but when I want to create credit memo, it ends with error. Everything is exactly according to documentation. Even it ends with error, when I try it in Developer SKY API Console.

Error message is confusing as well → there is no “Credit memo amount” field in the documentation. Even, I've tried different combination of this name….

I've spent a lot of time with it, but without success…

Any recommendation?

Thanks a lot.

Petr

--------
{

"Error": "Failed to save credit memo",

"Details": [

"Credit memo amount' is required."

],

"ErrorPath": "capcreditmemo.-1.creditmemoamount"

}
--------


request:

{

"vendor_id": 2,

"date": "2019-03-20T12:00:00Z",

"amount": 100,

"balance": 0,

"credit_memo_number": "8439712005",

"description": "my description",

"post_status": "DoNotPost",

"post_date": "2019-03-20T12:00:00Z",

"distributions": [

{

"distribution_splits": [

{

"ui_project_id": "711150010",

"transaction_code_values": [],

"amount": 113.0,

"percent": 100.0,

"account_class": "Unrestricted Net Assets"

}

],

"amount": 113.0,

"percent": 100.0,

"description": "first line",

"account_number": "1011100-1",

"type_code": "Debit"

},

{

"distribution_splits": [

{

"ui_project_id": "711150099",

"transaction_code_values": [],

"amount": 113.0,

"account_class": "Unrestricted Net Assets"

}

],

"amount": 113.0,

"percent": 100.0,

"description": "first line",

"account_number": "2041320-1",

"type_code": "Credit",

"custom_fields": []

}

]

}

Comments

  • Alex Wong
    Alex Wong Community All-Star
    Ninth Anniversary Kudos 5 Facilitator 3 Raiser's Edge NXT Fall 2025 Product Update Briefing Badge

    @Petr Mohyla
    not sure if your sample JSON is what you used, but there appears to be a problem.

    the credit memo amount you specified is 100

    but you have 2 distributions, one for the amount of $113 and another for another $113

  • @Alex Wong
    Hi, thakns for asnwer, the JSON is combination of many variants, that I've tested, this is my last version, when some wrong amounts probably remain. :-) I've tried valid distribution summary as well..the same error.

  • Alex Wong
    Alex Wong Community All-Star
    Ninth Anniversary Kudos 5 Facilitator 3 Raiser's Edge NXT Fall 2025 Product Update Briefing Badge

    @Petr Mohyla
    I have no problem creating the credit memo using the API console on my test environment. Below is my JSON, you just have to be aware of your org's FE rule.

    • does vendor_id exists in your FE as an existing Vendor SYSTEM RECORD ID, not the ID your org gives to the vendor. If you open the vendor record in FE NXT, look at the URL for where it has /payables/vendor/####, the #### is the vendor system record id
    • make sure your account can create credit memo with do not post as the status, I don't remember if there's a security permission on credit memo status option
    • make sure your ui_project_id is an existing Project ID (user defined), not project system record id
    • make sure any required transaction_code_values are entered, and that the name and value are correct and existing entries
    • make sure your amount matches up with credit and debit. if your full amount of the credit memo is $200, there needs to be a total of $200 credit AND $200 debit
    • make sure your account_class is correct to your FE NXT instance
    • make sure your account_number is correct to your FE NXT instance

    {
    "vendor_id": 3239,
    "date": "2024-04-24",
    "amount": 200,
    "credit_memo_number": "test credit memo",
    "description": "a test credit memo from api",
    "post_status": "DoNotPost",
    "post_date": "2024-04-24",
    "distributions": [
    {
    "distribution_splits": [
    {
    "ui_project_id": "5398",
    "transaction_code_values": [
    {
    "name": "Event",
    "value": "DIN17TRILI"
    }
    ],
    "amount": 200,
    "account_class": "Unrestricted Net Assets"
    }
    ],
    "amount": 200,
    "account_number": "10-2000-100",
    "type_code": "Debit"
    },
    {
    "distribution_splits": [
    {
    "ui_project_id": "5398",
    "transaction_code_values": [
    {
    "name": "Event",
    "value": "DIN17TRILI"
    }
    ],
    "amount": 200,
    "account_class": "Unrestricted Net Assets"
    }
    ],
    "amount": 200,
    "account_number": "10-2150-100",
    "type_code": "Credit"
    }
    ]
    }

  • @Petr Mohyla
    Are you a Canadian Client? I am having the same issue and a while back I remember another client I worked with unable to send Credit memos via the API because they were Canadian