Account2

AccountControllerV25

AccountingTransaction1

AccountingTransactionControllerV21

Aging2

AgingControllerV22

Attachment2

AttachmentControllerV22

Bank6

BankControllerV213

Bill7

BillControllerV213

Budget1

Businesses12

BusinessValuation1

BusinessValuationControllerV21

Connection2

ConnectionControllerV22

ContactControllerV21

Credit2

CreditControllerV22

Customer3

CustomerControllerV27

Data3

DataControllerV26

Deposit2

DepositControllerV22

Dispute1

DisputeControllerV21

Estimate2

EstimateControllerV22

ExpenseControllerV22

File1

FinancialBenchmarking1

FinancialBenchmarkingControllerV21

FinancialForecast1

FinancialForecastControllerV21

FinancialFraudRisk1

FinancialFraudRiskControllerV21

FinancialRatio1

FinancialRatioControllerV21

FinancialStatement3

FinancialStatementControllerV26

Inventory3

InventoryControllerV23

Invoice6

InvoiceControllerV210

Journal3

JournalControllerV28

Order1

OrderControllerV21

PaymentMethodControllerV21

PayrollTransaction1

PortfolioMetrics1

PortfolioMetricsControllerV21

ProbabilityOfDefault1

ProbabilityOfDefaultControllerV21

Product1

ProductControllerV21

PurchaseOrder2

PurchaseOrderControllerV22

Refunds4

Reports10

Sandbox2

TaxBenchmarking1

TaxBenchmarkingControllerV21

TaxRate1

TaxRateControllerV23

TrackingCategory2

TrackingCategoryControllerV22

Transaction1

TransactionControllerV21

TrialBalance1

TrialBalanceControllerV21

Vendor3

VendorControllerV28

Visualizations16

Invoice

Invoice Credit Notes

GET /invoices/creditNotes

Changed on Sep 3, 2026

Gets the latest invoice (customer) credit notes for a business.

Request

Base URL
https://api.railz.ai
Auth
HTTP bearer

Query parameters

businessNamestring required

startDatestring

Transaction date greater than or equal to parameter in the format: YYYY-MM-DD.

endDatestring

Transaction date less than or equal to parameter in the format: YYYY-MM-DD.

offsetnumber

The offset is the position in the dataset of a particular record.

limitnumber

Example:100

This is the size of the results set you would like (default: 100).

orderBystring

totalAmountnumber float

Total amount of a credit note.

remainingCreditnumber float

Remaining credit on a credit note.

Response

countnumber required

Example response

{
  "count": 1,
  "meta": {
    "reportId": [
      "5fad8a342a88364234392fb5"
    ],
    "serviceName": "xero",
    "businessName": "Railz",
    "createdAt": "2020-11-25T01:02:03Z",
    "updatedAt": "2020-11-30T01:02:03Z",
    "startDate": "2020-11-25T01:02:03Z",
    "endDate": "2020-11-30T01:02:03Z"
  },
  "data": [
    {
      "customerRef": {
        "id": "1",
        "name": "Railz Financial"
      },
      "locationRef": {
        "id": "52",
        "name": "United States"
      },
      "lines": [
        {
          "description": "Services rendered.",
          "unitAmount": 100.5,
          "quantity": 3,
          "taxAmount": 20.5,
          "taxRateRef": {
            "id": "1",
            "name": "HST",
            "effectiveTaxRate": 13
          },
          "inventoryRef": {
            "id": "1",
            "name": "Digital Services"
          },
          "discountPercentage": 10.5,
          "accountRef": {
            "id": "145",
            "name": "Example account"
          },
          "totalAmount": 10.5,
          "subTotal": 301.5,
          "trackingCategoryRef": {
            "id": "4040",
            "name": "Region",
            "option": "East",
            "optionId": "40401"
          }
        }
      ]
    }
  ]
}

Changes

Sep 3, 20261383b9a47ac9 Revision changes
- info
  api tag Invoice added
Aug 10, 20265cdfae3fa1fa Revision changes
- breaking
  removed the enum value myob from the query request parameter serviceName
- breaking
  removed the enum value plaid from the query request parameter serviceName
- breaking
  removed the enum value shopify from the query request parameter serviceName
- breaking
  removed the enum value square from the query request parameter serviceName
- breaking
  removed the enum value wave from the query request parameter serviceName
- breaking
  the response property //// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the //// response's property format changed from integer to float for status
- breaking
  the //// response's property format changed from integer to float for status
- breaking
  the //// response's property type changed from object to no type for status
- breaking
  the //// response's property type changed from object to no type for status
- breaking
  removed the required property // from the response with the status
- breaking
  removed the required property // from the response with the status
- breaking
  removed the required property ///// from the response with the status
- breaking
  removed the required property ///// from the response with the status
- breaking
  removed the required property // from the response with the status
- breaking
  removed the required property // from the response with the status
- breaking
  removed the required property // from the response with the status
- breaking
  removed the required property // from the response with the status
- breaking
  removed the required property // from the response with the status
- breaking
  removed the required property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property ///// from the response with the status
- warning
  removed the optional property ///// from the response with the status
- warning
  removed the optional property ///// from the response with the status
- warning
  removed the optional property ///// from the response with the status
- warning
  removed the optional property ///// from the response with the status
- warning
  removed the optional property ///// from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  added the new byod enum value to the ///// response property for the response status
- warning
  added the new byod enum value to the ///// response property for the response status
- warning
  added the new dynamics365Finance enum value to the ///// response property for the response status
- warning
  added the new dynamics365Finance enum value to the ///// response property for the response status
- warning
  added the new dynamicsBusinessCentral enum value to the ///// response property for the response status
- warning
  added the new dynamicsBusinessCentral enum value to the ///// response property for the response status
- warning
  added the new freshbooks enum value to the ///// response property for the response status
- warning
  added the new freshbooks enum value to the ///// response property for the response status
- warning
  added the new myob enum value to the ///// response property for the response status
- warning
  added the new myob enum value to the ///// response property for the response status
- warning
  added the new oracleNetsuite enum value to the ///// response property for the response status
- warning
  added the new oracleNetsuite enum value to the ///// response property for the response status
- warning
  added the new quickbooks enum value to the ///// response property for the response status
- warning
  added the new quickbooks enum value to the ///// response property for the response status
- warning
  added the new quickbooksDesktop enum value to the ///// response property for the response status
- warning
  added the new quickbooksDesktop enum value to the ///// response property for the response status
- warning
  added the new sageBusinessCloud enum value to the ///// response property for the response status
- warning
  added the new sageBusinessCloud enum value to the ///// response property for the response status
- warning
  added the new sageIntacct enum value to the ///// response property for the response status
- warning
  added the new sageIntacct enum value to the ///// response property for the response status
- warning
  added the new wave enum value to the ///// response property for the response status
- warning
  added the new wave enum value to the ///// response property for the response status
- warning
  added the new xero enum value to the ///// response property for the response status
- warning
  added the new xero enum value to the ///// response property for the response status
- warning
  added the new zohoBooks enum value to the ///// response property for the response status
- warning
  added the new zohoBooks enum value to the ///// response property for the response status
- info
  added the new enum value zohoBooks to the query request parameter serviceName
- info
  added to the //// response property allOf list for the response status
- info
  added to the //// response property allOf list for the response status
- info
  response property data/items/lines/items/subTotal deprecated
- info
  response property data/items/lines/items/subTotal deprecated
- info
  response property data/items/lines/items/totalAmount deprecated
- info
  response property data/items/lines/items/totalAmount deprecated
- info
  response property data/items/lines/items/trackingCategoryRef deprecated
- info
  response property data/items/lines/items/trackingCategoryRef deprecated

Operation history