Credit Note Reconciliations

Minimum access level: Estimates and Invoices, unless stated otherwise.

Credit Note Reconciliation Attributes

Attribute Description Kind
url The unique identifier for the credit note reconciliation URI
gross_value The amount reconciled between the credit note and invoice Decimal
dated_on Date the reconciliation takes effect in YYYY-MM-DD format Date
exchange_rate Rate at which invoice amount is converted into company's native currency Decimal
currency

Credit note reconciliation's currency

String
Invoice Invoice being reconciled URI
Credit note Credit note being reconciled URI

List all credit note reconciliations

GET https://api.freeagent.com/v2/credit_note_reconciliations

Input

Date Filters

GET https://api.freeagent.com/v2/credit_note_reconciliations?updated_since=2017-05-22T09:00:00.000Z
GET https://api.freeagent.com/v2/credit_note_reconciliations?from_date=2017-05-22
GET https://api.freeagent.com/v2/credit_note_reconciliations?to_date=2017-05-22
  • updated_since
  • from_date
  • to_date

Response

Status: 200 OK
{
  "credit_note_reconciliations": [
    {
      "url":"https://api.freeagent.com/v2/credit_note_reconciliations/1",
      "gross_value":"100.0",
      "dated_on":"2020-06-29",
      "currency":"GBP",
      "exchange_rate":"1.0",
      "invoice": "https://api.freeagent.com/v2/invoices/1",
      "credit_note": "https://api.freeagent.com/v2/credit_notes/1",
    }
  ]
}
Show as XML
<?xml version="1.0" encoding="UTF-8"?>
<freeagent>
  <credit-notes type="array">
    <credit-note>
      <url>https://api.freeagent.com/v2/credit_note_reconciliations/1</url>
      <gross-value type="decimal">100.0</gross-value>
      <dated-on type="datetime">2020-06-29</dated-on>
      <currency>GBP</currency>
      <exchange-rate type="decimal">1.0</exchange-rate>
      <invoice>https://api.freeagent.com/v2/invoices/1</bank-account>
      <credit-note>https://api.freeagent.com/v2/credit_notes/1</credit-note>
    </credit-note>
  </credit-notes>
</freeagent>
Show as JSON

Get a single credit note reconciliation

GET https://api.freeagent.com/v2/credit_note_reconciliations/:id

Response

Status: 200 OK
{
  "credit_note_reconciliations": {
    "url":"https://api.freeagent.com/v2/credit_note_reconciliations/1",
    "gross_value":"100.0",
    "dated_on":"2020-06-29",
    "currency":"GBP",
    "exchange_rate":"1.0",
    "invoice": "https://api.freeagent.com/v2/invoices/1",
    "credit_note": "https://api.freeagent.com/v2/credit_notes/1",
  }
}
Show as XML
<?xml version="1.0" encoding="UTF-8"?>
<freeagent>
  <credit-note-reconciliation>
    <url>https://api.freeagent.com/v2/credit_note_reconciliations/1</url>
    <gross-value type="decimal">100.0</gross-value>
    <dated-on type="datetime">2020-06-29</dated-on>
    <currency>GBP</currency>
    <exchange-rate type="decimal">1.0</exchange-rate>
    <invoice>https://api.freeagent.com/v2/invoices/1</bank-account>
    <credit-note>https://api.freeagent.com/v2/credit_notes/1</credit-note>
  </credit-note-reconciliation>
</freeagent>
Show as JSON