Credit Notes

List credit notes

List credit notes with optional filtering.

get/credit_notes

Request

Base URL
https://api.upflow.io/v1
Auth
API key in header X-Api-Key and API key in header X-Api-Secret

Query parameters

offsetinteger

The 0-based index of the first item to return.

pageinteger

Example:1

The page number to retrieve (1-based). If both page and offset are provided, offset takes priority.

limitinteger

Example:100

Maximum number of items to return per page.

customer.idstring

Example:00a70b35-2be3-4c43-aefb-397190134655

Filter credit notes by Customer ID.

customer.externalIdstring

Example:134

Filter credit notes by external Customer ID.

updatedAt.gtstring date-time

Minimum value to filter by (exclusive)

updatedAt.gtestring date-time

Minimum value to filter by (inclusive)

updatedAt.ltstring date-time

Maximum value to filter by (exclusive)

updatedAt.ltestring date-time

Maximum value to filter by (inclusive)

{
  "updatedAt.gt": "2015-05-05T12:30:00Z",
  "updatedAt.gte": "2015-05-05T12:30:00Z",
  "updatedAt.lt": "2015-05-05T12:30:00Z",
  "updatedAt.lte": "2015-05-05T12:30:00Z"
}

customIdstring

Example:CN123

Filter credit notes by custom ID.

Response

Paginated list of credit notes.

offsetinteger

0-based index of the first item returned. Returned when using offset-based pagination or by default.

pageinteger

Page number (1-based). Returned when using page-based pagination.

limitinteger required

Maximum number of items returned.

totalinteger required

Total items in the set.

Example response

{
  "page": 1,
  "limit": 50,
  "total": 100,
  "items": [
    {
      "customId": "CN123",
      "externalId": "92842AB37",
      "issuedAt": "2015-05-05T12:30:00Z",
      "dueDate": "2015-05-05T12:30:00Z",
      "name": "Credit Note for returned goods",
      "currency": "EUR",
      "grossAmount": 1700,
      "netAmount": 1500,
      "updatedAt": "2015-05-05T12:30:00Z",
      "id": "00a70b35-2be3-4c43-aefb-397190134655",
      "pdfUrl": "https://files.upflow.io/credit_note.pdf",
      "customer": {
        "id": "00a70b35-2be3-4c43-aefb-397190134655",
        "externalId": "1a2c3b",
        "companyName": "Upflow SAS",
        "accountingRef": "UPFL-SAS"
      },
      "linkedInvoices": [
        {
          "amountLinked": 2000,
          "invoice": {
            "id": "00a70b35-2be3-4c43-aefb-397190134655",
            "currency": "EUR",
            "amountOutstanding": 1500,
            "customId": "FAC123",
            "grossAmount": 2200,
            "netAmount": 2000,
            "name": "Facture couvrant les prestations de service de Decembre",
            "issuedAt": "2015-05-05T12:30:00Z",
            "dueDate": "2015-05-05T12:30:00Z",
            "paidDate": "2015-05-05T12:30:00Z",
            "externalId": "92842AB37"
          }
        }
      ],
      "createdAt": "2015-05-05T12:30:00Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.