Credit notes

1

Hello

Could anyone help me out by letting me know the ‘correct’ way to create a
credit note and mark it against an invoice?
I’m not looking for code samples, just an understanding of how the API
handles it.

Thanks for your help

Ryan

2

Just following up with this - can anyone help?

3

Thanks for getting back to me.

The only thing that is unclear is the Credit Note Refund type - how do I
find that in the API and what bank_transaction_explanations field is it
used with?On Tuesday, 3 September 2013 11:04:42 UTC+1, Graeme Boyd wrote:

Hi Ryan,

The process is the same as it is in the app - there’s no “marking against
an invoice” as such:

http://www.freeagent.com/support/kb/invoicing/create-a-credit-note

http://www.freeagent.com/support/kb/invoicing/net-off-sales-invoice-and-credit-note

You can create a credit note by creating an invoice in the API with
negative invoice items. To reconcile the credit note, create bank
transaction explanations in the API following the details in the KB article.

Cheers,

Graeme

On 3 September 2013 09:05, Ryan Mitchell <ryanmi...@thoughtcollective.com<javascript:> wrote:

Hello

Could anyone help me out by letting me know the ‘correct’ way to create a
credit note and mark it against an invoice?
I’m not looking for code samples, just an understanding of how the API
handles it.

Thanks for your help

Ryan

–
You received this message because you are subscribed to the Google Groups
“FreeAgent API” group.
To unsubscribe from this group and stop receiving emails from it, send an
email to freeagent_ap...@googlegroups.com <javascript:>.
To post to this group, send email to freeag...@googlegroups.com<javascript:>
.
Visit this group at http://groups.google.com/group/freeagent_api.
For more options, visit https://groups.google.com/groups/opt_out.

–
Graeme Boyd
Senior Software Engineer

Web. freeagent.com http://www.freeagent.com/ Blog. The FreeAgent Blog - FreeAgent
Twitter. @freeagent https://twitter.com/#!/freeagent Facebook.
FreeAgent | Edinburgh

40 Torphichen Street, Edinburgh, EH3 8JB
FreeAgent Central Ltd. Registered in sunny Scotland SC316774

4

Hi there,

You’re right: the two don’t get related to each other. You’re recording
that a credit note has been paid, and so has the invoice, and that the net
effect is that the contact no longer owes payment against the invoice.

If you re-read the knowledgebase articles I posted on your other
threadhttps://groups.google.com/forum/#!topic/freeagent_api/hZN80BoDQ0M,
you’ll see this explained:

… there’s no “netting off” mechanism as such … Instead, you need to enter a

dummy receipt against the invoice and a dummy payment against the credit
note.

That’s the process being described here.

Hope this helps,

-J

5

Hi Ryan,

The process is the same as it is in the app - there’s no “marking against
an invoice” as such:

You can create a credit note by creating an invoice in the API with
negative invoice items. To reconcile the credit note, create bank
transaction explanations in the API following the details in the KB article.

Cheers,

GraemeOn 3 September 2013 09:05, Ryan Mitchell <ryanmitchell@thoughtcollective.com wrote:

Hello

Could anyone help me out by letting me know the ‘correct’ way to create a
credit note and mark it against an invoice?
I’m not looking for code samples, just an understanding of how the API
handles it.

Thanks for your help

Ryan

–
You received this message because you are subscribed to the Google Groups
“FreeAgent API” group.
To unsubscribe from this group and stop receiving emails from it, send an
email to freeagent_api+unsubscribe@googlegroups.com.
To post to this group, send email to freeagent_api@googlegroups.com.
Visit this group at http://groups.google.com/group/freeagent_api.
For more options, visit https://groups.google.com/groups/opt_out.

Graeme Boyd
Senior Software Engineer

Web. freeagent.com http://www.freeagent.com/ Blog. The FreeAgent Blog - FreeAgent
Twitter. @freeagent https://twitter.com/#!/freeagent Facebook.
FreeAgent | Edinburgh

40 Torphichen Street, Edinburgh, EH3 8JB
FreeAgent Central Ltd. Registered in sunny Scotland SC316774

6

Thanks for that - really helpful.
Thanks,
Ryan Mitchell

Thought Collective
(Goodbye ordinary)

B1.10 Portview
310 Newtownards Road
Belfast BT4 1HE
Northern Ireland

+44 (0)28 9045 9444

@thoughtcoOn 11 Sep 2013, at 18:24, Ben ben@freeagent.com wrote:

Hi Ryan,

You’re correct, you need to create two Bank Transaction Explanations: one for the invoice and one for the credit note.

Let’s say that you’ve created an invoice for £24 (which has ID 111) and you’ve created a matching credit note for -£24 (ID is 222). And let’s assume your bank account has ID 1234.

To explain the invoice, you’d POST the following JSON to https://api.freeagent.com/v2/bank_transaction_explanations:

{ “bank_transaction_explanation” :
{
“bank_account”:“https://api.freeagent.com/v2/bank_accounts/1234”,
“dated_on”:“2013-09-10”,
“gross_value”:“24.0”,
“paid_invoice”: “https://api.freeagent.com/v2/invoices/111”
}
}

For the credit note, you’d POST the following JSON to https://api.freeagent.com/v2/bank_transaction_explanations:

{ “bank_transaction_explanation” :
{
“bank_account”:“https://api.freeagent.com/v2/bank_accounts/1234”,
“dated_on”:“2013-09-10”,
“gross_value”:“-24.0”,
“paid_invoice”: “https://api.freeagent.com/v2/invoices/222”
}
}

(of course, you’ll want to make sure your Content-Type header is set appropriately. For my example, I’d set it to “application/json”).

If the amounts of the credit note and invoice don’t match up exactly, you can vary the gross_value. More details are here: http://www.freeagent.com/support/kb/invoicing/net-off-sales-invoice-and-credit-note

Does that help?

Ben

On Monday, 9 September 2013 03:18:54 UTC-7, Ryan Mitchell wrote:

Just following up with this - can anyone help?

–
You received this message because you are subscribed to a topic in the Google Groups “FreeAgent API” group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/freeagent_api/qx-D8JdAnHk/unsubscribe.
To unsubscribe from this group and all its topics, send an email to freeagent_api+unsubscribe@googlegroups.com.
To post to this group, send email to freeagent_api@googlegroups.com.
Visit this group at http://groups.google.com/group/freeagent_api.
For more options, visit https://groups.google.com/groups/opt_out.

7

But I didn’t get one thing here how credit note of ID 222 will directly
applied to Invoice 111 because I din’t see any relation of these items in
created bank_transaction_explanation here in example give by Ben, is it
applied becuse of same amount of 24?On Tuesday, 3 September 2013 13:35:16 UTC+5:30, Ryan Mitchell wrote:

Hello

Could anyone help me out by letting me know the ‘correct’ way to create a
credit note and mark it against an invoice?
I’m not looking for code samples, just an understanding of how the API
handles it.

Thanks for your help

Ryan

8

Hi Ryan,

You’re correct, you need to create two Bank Transaction Explanations: one
for the invoice and one for the credit note.

Let’s say that you’ve created an invoice for £24 (which has ID 111) and
you’ve created a matching credit note for -£24 (ID is 222). And let’s
assume your bank account has ID 1234.

To explain the invoice, you’d POST the following JSON to
https://api.freeagent.com/v2/bank_transaction_explanations:

{ “bank_transaction_explanation” :
{
“bank_account”:“https://api.freeagent.com/v2/bank_accounts/1234”,
“dated_on”:“2013-09-10”,
“gross_value”:“24.0”,
“paid_invoice”: “https://api.freeagent.com/v2/invoices/111”
}
}

For the credit note, you’d POST the following JSON to
https://api.freeagent.com/v2/bank_transaction_explanations:

{ “bank_transaction_explanation” :
{
“bank_account”:“https://api.freeagent.com/v2/bank_accounts/1234”,
“dated_on”:“2013-09-10”,
“gross_value”:“-24.0”,
“paid_invoice”: “https://api.freeagent.com/v2/invoices/222”
}
}

(of course, you’ll want to make sure your Content-Type header is set
appropriately. For my example, I’d set it to “application/json”).

If the amounts of the credit note and invoice don’t match up exactly, you
can vary the gross_value. More details are
here: http://www.freeagent.com/support/kb/invoicing/net-off-sales-invoice-and-credit-note

Does that help?

BenOn Monday, 9 September 2013 03:18:54 UTC-7, Ryan Mitchell wrote:

Just following up with this - can anyone help?

9

Hi Ryan,

A credit note is just an invoice with a negative value. Invoice items can
be created with a type of “Credit” if you don’t want to specify exactly
what is being refunded. If you want to link a bank transaction explanation
to a credit note just use the paid_invoice field. Does that answer your
question?

Cheers,

GraemeOn 3 September 2013 12:21, Ryan Mitchell <ryanmitchell@thoughtcollective.com wrote:

Thanks for getting back to me.

The only thing that is unclear is the Credit Note Refund type - how do I
find that in the API and what bank_transaction_explanations field is it
used with?

On Tuesday, 3 September 2013 11:04:42 UTC+1, Graeme Boyd wrote:

Hi Ryan,

The process is the same as it is in the app - there’s no “marking against
an invoice” as such:

http://www.freeagent.com/**support/kb/invoicing/create-a-**credit-notehttp://www.freeagent.com/support/kb/invoicing/create-a-credit-note

http://www.freeagent.com/**support/kb/invoicing/net-off-**
sales-invoice-and-credit-notehttp://www.freeagent.com/support/kb/invoicing/net-off-sales-invoice-and-credit-note

You can create a credit note by creating an invoice in the API with
negative invoice items. To reconcile the credit note, create bank
transaction explanations in the API following the details in the KB article.

Cheers,

Graeme

On 3 September 2013 09:05, Ryan Mitchell <ryanmi…@** thoughtcollective.com> wrote:

Hello

Could anyone help me out by letting me know the ‘correct’ way to create
a credit note and mark it against an invoice?
I’m not looking for code samples, just an understanding of how the API
handles it.

Thanks for your help

Ryan

–
You received this message because you are subscribed to the Google
Groups “FreeAgent API” group.
To unsubscribe from this group and stop receiving emails from it, send
an email to freeagent_ap…@googlegroups.com.
To post to this group, send email to freeag...@googlegroups.com.

Visit this group at http://groups.google.com/**group/freeagent_apihttp://groups.google.com/group/freeagent_api
.
For more options, visit https://groups.google.com/**groups/opt_outhttps://groups.google.com/groups/opt_out
.

–
Graeme Boyd
Senior Software Engineer

Web. freeagent.com http://www.freeagent.com/ Blog. The FreeAgent Blog - FreeAgent
Twitter. @freeagent https://twitter.com/#!/freeagent Facebook.
Facebook http://facebook.com/freeagentapp

40 Torphichen Street, Edinburgh, EH3 8JB
FreeAgent Central Ltd. Registered in sunny Scotland SC316774

–
You received this message because you are subscribed to the Google Groups
“FreeAgent API” group.
To unsubscribe from this group and stop receiving emails from it, send an
email to freeagent_api+unsubscribe@googlegroups.com.
To post to this group, send email to freeagent_api@googlegroups.com.
Visit this group at http://groups.google.com/group/freeagent_api.
For more options, visit https://groups.google.com/groups/opt_out.

Graeme Boyd
Senior Software Engineer

Web. freeagent.com http://www.freeagent.com/ Blog. The FreeAgent Blog - FreeAgent
Twitter. @freeagent https://twitter.com/#!/freeagent Facebook.
FreeAgent | Edinburgh

40 Torphichen Street, Edinburgh, EH3 8JB
FreeAgent Central Ltd. Registered in sunny Scotland SC316774

10

Not really. Let me try to explain from the top.

The system I’m integrating from creates invoices, which then have credit
notes applied to them.

In order to push to FreeAgent I’m creating the invoices through the API
method.

Im then creating credit notes which are really negative invoices through
the API method.

What I need to do is apply the credit note balance to the initial invoice,
and it seems I also need to mark a payment against the negative invoice
(credit note).

I’m assuming I do both these through bank_transaction_explanations ?

If so, could you let me know what form values I need to post for each part
in the process?On Tuesday, 3 September 2013 12:34:33 UTC+1, Graeme Boyd wrote:

Hi Ryan,

A credit note is just an invoice with a negative value. Invoice items can
be created with a type of “Credit” if you don’t want to specify exactly
what is being refunded. If you want to link a bank transaction explanation
to a credit note just use the paid_invoice field. Does that answer your
question?

Cheers,

Graeme

On 3 September 2013 12:21, Ryan Mitchell <ryanmi...@thoughtcollective.com<javascript:> wrote:

Thanks for getting back to me.

The only thing that is unclear is the Credit Note Refund type - how do I
find that in the API and what bank_transaction_explanations field is it
used with?

On Tuesday, 3 September 2013 11:04:42 UTC+1, Graeme Boyd wrote:

Hi Ryan,

The process is the same as it is in the app - there’s no “marking
against an invoice” as such:

http://www.freeagent.com/**support/kb/invoicing/create-a-**credit-notehttp://www.freeagent.com/support/kb/invoicing/create-a-credit-note

http://www.freeagent.com/**support/kb/invoicing/net-off-**
sales-invoice-and-credit-notehttp://www.freeagent.com/support/kb/invoicing/net-off-sales-invoice-and-credit-note

You can create a credit note by creating an invoice in the API with
negative invoice items. To reconcile the credit note, create bank
transaction explanations in the API following the details in the KB article.

Cheers,

Graeme

On 3 September 2013 09:05, Ryan Mitchell <ryanmi…@** thoughtcollective.com> wrote:

Hello

Could anyone help me out by letting me know the ‘correct’ way to create
a credit note and mark it against an invoice?
I’m not looking for code samples, just an understanding of how the API
handles it.

Thanks for your help

Ryan

–
You received this message because you are subscribed to the Google
Groups “FreeAgent API” group.
To unsubscribe from this group and stop receiving emails from it, send
an email to freeagent_ap…@googlegroups.com.
To post to this group, send email to freeag...@googlegroups.com.

Visit this group at http://groups.google.com/**group/freeagent_apihttp://groups.google.com/group/freeagent_api
.
For more options, visit https://groups.google.com/**groups/opt_outhttps://groups.google.com/groups/opt_out
.

–
Graeme Boyd
Senior Software Engineer

Web. freeagent.com http://www.freeagent.com/ Blog.
The FreeAgent Blog - FreeAgent
Twitter. @freeagent https://twitter.com/#!/freeagent Facebook.
Facebook http://facebook.com/freeagentapp

40 Torphichen Street, Edinburgh, EH3 8JB
FreeAgent Central Ltd. Registered in sunny Scotland SC316774

–
You received this message because you are subscribed to the Google Groups
“FreeAgent API” group.
To unsubscribe from this group and stop receiving emails from it, send an
email to freeagent_ap...@googlegroups.com <javascript:>.
To post to this group, send email to freeag...@googlegroups.com<javascript:>
.
Visit this group at http://groups.google.com/group/freeagent_api.
For more options, visit https://groups.google.com/groups/opt_out.

–
Graeme Boyd
Senior Software Engineer

Web. freeagent.com http://www.freeagent.com/ Blog. The FreeAgent Blog - FreeAgent
Twitter. @freeagent https://twitter.com/#!/freeagent Facebook.
FreeAgent | Edinburgh

40 Torphichen Street, Edinburgh, EH3 8JB
FreeAgent Central Ltd. Registered in sunny Scotland SC316774