Creating a credit note via api Call

[Aashish]

Hi Team,

I am in need of creation of CREDIT NOTE vai API call on cancellation of my invoices.
In order to achieve this functionality, I followed the link as follows

Creating a Credit Note using the API

In QuickFile Credit Notes are essentially negative value invoices. They serve either to reduce the outstanding balance of an invoice (VOID), or to refund or hold on account the paid balance of a full or partially paid invoice (REFUND). So how is it done? Due to the common schemas that exist between Credit Notes and Invoices, the Invoice_Create API method is also used to generate credit notes. You’ll need to ensure your total invoice value is negative and some additional CreditNote meta data is…

Unfortunately, I am getting error, could you please help me with right steps to achieve the same.
Please suggest me right API and corresponding request string.

API:- https://api.quickfile.co.uk/1_2/invoice/create

Request String:-

{
  "payload": {
    "Header": {
      "MessageType": "Request",
      "SubmissionNumber": "EPTESTINGCREDITNOTE",
      "Authentication": {
        "AccNumber": "XXXXXXXXXXX",
        "MD5Value": "XXXXXXXXXXXXXXXXXXXXXX",
        "ApplicationID": "XXXXXXXXXXXXXXXXXXXXXXXXXXXX"
      }
    },
    "Body": {
      "InvoiceData": {
        "InvoiceType": "INVOICE",
        "ClientID": "XXXXXXX",
        "ClientAddress": {
          "Address": "123 Test Street<br/>Manchester<br/>MA1 5TH<br/>United Kingdom",
          "CountryISO": "GB"
        },
        "Currency": "GBP",
        "TermDays": "14",
        "Language": "en",
        "InvoiceLines": {
          "ItemLines": {
            "ItemLine": [
              {
                "ItemID": "0",
                "ItemName": "EMB1",
                "ItemDescription": "Embossing Stamp",
                "ItemNominalCode": "4000",
                "Tax1": {
                  "TaxName": "VAT",
                  "TaxPercentage": "00.00",
                  "TaxAmount": "00"
                },
                "UnitCost": "-276.74",
                "Qty": "1"
              }
            ]
          }
        },
        "Scheduling": {
          "SingleInvoiceData": {
            "IssueDate": "2017-05-23"
          }
        }
		},
        "CreditNote": {
          "CreditNoteType": "VOID",
          "ParentInvoiceID": "12050783"
        }
    }
  }
}

[ian_roberts]

One thing that jumps out at me immediately is that you can’t have line breaks within a JSON string literal. I would very very strongly recommend using a proper JSON serialization library to send your requests rather than trying to construct the JSON by hand with string manipulation, but for quick testing you can probably get away with replacing the line breaks within the address with \n, i.e.

"Address": "123 Test Street\nManchester\nMA1 5TH\nUnited Kingdom"

A proper serializer will handle this (and the other requirements of the JSON format like escaping of nested quotes) for you.

[ian_roberts]

Also, when you want to post blocks of JSON code like this on the forum, there’s a Markdown trick to make it much more readable - put three backticks before and after the content:

```
{ ... }
```

This then preserves any indentation, and stops it replacing normal " quotes with “curly quotes”.

[QFMathew]

Hi @Aashish

I’ve amended your post to format the JSON correctly (like @ian_roberts mentioned above).

Can you let us know the error you’re seeing please?

[ian_roberts]

Ah, ok, with @QFMathew’s formatting fix I see my original suggestion is irrelevant. Exactly what error message are you receiving? That 2017 IssueDate may be a problem, if you’ve run your year end and already locked that period.

[Aashish]

Thanks team for your quick suggestion, Its fixed now.
In addition would like to know when ETA for purchase ledger to be implemented in this API.

Creating a Credit Note using the API

In QuickFile Credit Notes are essentially negative value invoices. They serve either to reduce the outstanding balance of an invoice (VOID), or to refund or hold on account the paid balance of a full or partially paid invoice (REFUND). So how is it done? Due to the common schemas that exist between Credit Notes and Invoices, the Invoice_Create API method is also used to generate credit notes. You’ll need to ensure your total invoice value is negative and some additional CreditNote meta data is…

Thanks
Aashish