Codat · Example Payload

Codat List Accounting Credit Notes Example

Unified_API

Codat List Accounting Credit Notes Example is an example object payload from Codat, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑
{
  "operationId": "list-accounting-credit-notes",
  "method": "GET",
  "path": "/companies/{companyId}/data/creditNotes",
  "summary": "List credit notes",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "Dynamics 365 Business Central",
      "example": {
        "results": [
          {
            "id": "e6e5ec0f-1c60-eb11-89fa-00224800a9c7",
            "creditNoteNumber": "104001",
            "customerRef": {
              "id": "8ddfa6bf-0c60-eb11-89fa-00224800af18",
              "companyName": "Abdi Company"
            },
            "withholdingTax": [],
            "totalAmount": 105,
            "totalDiscount": 0,
            "subTotal": 100,
            "additionalTaxAmount": 0,
            "additionalTaxPercentage": 0,
            "totalTaxAmount": 5,
            "discountPercentage": 0,
            "remainingCredit": 80,
            "status": "PartiallyPaid",
            "issueDate": "2021-01-25T00:00:00",
            "currency": "GBP",
            "lineItems": [
              {
                "description": "Invoice No. 103221:",
                "unitAmount": 0,
                "quantity": 1,
                "discountAmount": 0,
                "subTotal": 0,
                "taxAmount": 0,
                "totalAmount": 0,
                "accountRef": {
                  "id": "NullId"
                },
                "discountPercentage": 0,
                "taxRateRef": {
                  "id": "cc81fea8-2917-ed11-90eb-002248009df3",
                  "name": "",
                  "effectiveTaxRate": 0
                },
                "trackingCategoryRefs": [],
                "isDirectIncome": false
              },
              {
                "description": "Linda Martin",
                "unitAmount": 100,
                "quantity": 1,
                "discountAmount": 0,
                "subTotal": 100,
                "taxAmount": 5,
                "totalAmount": 105,
                "accountRef": {
                  "id": "161217b3-89d1-ea11-bbaa-000d3a2b9185",
                  "name": "Income, Services"
                },
                "discountPercentage": 0,
                "taxRateRef": {
                  "id": "61bc0fb9-89d1-ea11-bbaa-000d3a2b9185",
                  "name": "Setup for DOMESTIC / REDUCED",
                  "effectiveTaxRate": 5
                },
                "itemRef": {
                  "id": "RESC-331317b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC",
                  "name": "Linda Martin / General Business Posting Group: 'DOMESTIC' / VAT Business Posting Group: 'DOMESTIC'"
                },
                "trackingCategoryRefs": [],
                "isDirectIncome": false
              },
              {
                "description": "Credit memo for partially paid inv",
                "unitAmount": 0,
                "quantity": 1,
                "discountAmount": 0,
                "subTotal": 0,
                "taxAmount": 0,
                "totalAmount": 0,
                "accountRef": {
                  "id": "NullId"
                },
                "discountPercentage": 0,
                "taxRateRef": {
                  "id": "cc81fea8-2917-ed11-90eb-002248009df3",
                  "name": "",
                  "effectiveTaxRate": 0
                },
                "trackingCategoryRefs": [],
                "isDirectIncome": false
              }
            ],
            "paymentAllocations": [
              {
                "payment": {
                  "id": "62e5046d-1c60-eb11-89fa-00224800a9c7",
                  "note": "Credit Memo 1001",
                  "reference": "Document No: 104001",
                  "currency": "GBP",
                  "currencyRate": 1,
                  "paidOnDate": "2021-01-25T00:00:00",
                  "totalAmount": 0
                },
                "allocation": {
                  "currency": "GBP",
                  "currencyRate": 1,
                  "allocatedOnDate": "2021-01-25T00:00:00",
                  "totalAmount": 25
                }
              }
            ],
            "modifiedDate": "2023-03-27T14:21:25Z",
            "sourceModifiedDate": "2021-01-26T21:21:18Z",
            "metadata": {
              "isDeleted": false
            }
          },
          {
            "id": "d0d9b378-1d60-eb11-89fa-00224800a9c7",
            "creditNoteNumber": "104002",
            "customerRef": {
              "id": "8ddfa6bf-0c60-eb11-89fa-00224800af18",
              "companyName": "Abdi Company"
            },
            "withholdingTax": [],
            "totalAmount": 779.28,
            "totalDiscount": 0,
            "subTotal": 649.4,
            "additionalTaxAmount": 0,
            "additionalTaxPercentage": 0,
            "totalTaxAmount": 129.88,
            "discountPercentage": 0,
            "remainingCredit": 0,
            "status": "Paid",
            "issueDate": "2021-01-26T00:00:00",
            "currency": "GBP",
            "lineItems": [
              {
                "description": "Invoice No. 103222:",
                "unitAmount": 0,
                "quantity": 1,
                "discountAmount": 0,
                "subTotal": 0,
                "taxAmount": 0,
                "totalAmount": 0,
                "accountRef": {
                  "id": "NullId"
                },
                "discountPercentage": 0,
                "taxRateRef": {
                  "id": "cc81fea8-2917-ed11-90eb-002248009df3",
                  "name": "",
                  "effectiveTaxRate": 0
                },
                "trackingCategoryRefs": [],
                "isDirectIncome": false
              },
              {
                "description": "Inv. No. 103222 - Shpt. No. 102222:",
                "unitAmount": 0,
                "quantity": 1,
                "discountAmount": 0,
                "subTotal": 0,
                "taxAmount": 0,
                "totalAmount": 0,
                "accountRef": {
                  "id": "NullId"
                },
                "discountPercentage": 0,
                "taxRateRef": {
                  "id": "cc81fea8-2917-ed11-90eb-002248009df3",
                  "name": "",
                  "effectiveTaxRate": 0
                },
                "trackingCategoryRefs": [],
                "isDirectIncome": false
              },
              {
                "description": "ATHENS Desk -pay with CR",
                "unitAmount": 649.4,
                "quantity": 1,
                "discountAmount": 0,
                "subTotal": 649.4,
                "taxAmount": 129.88,
                "totalAmount": 779.28,
                "accountRef": {
                  "id": "181217b3-89d1-ea11-bbaa-000d3a2b9185",
                  "name": "Income, Product Sales"
                },
                "discountPercentage": 0,
                "taxRateRef": {
                  "id": "63bc0fb9-89d1-ea11-bbaa-000d3a2b9185",
                  "name": "Setup for DOMESTIC / STANDARD",
                  "effectiveTaxRate": 10
                },
                "itemRef": {
                  "id": "ITEM-c81217b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC",
                  "name": "ATHENS Desk / General Business Posting Group: 'DOMESTIC' / VAT Business Posting Group: 'DOMESTIC'"
                },
                "trackingCategoryRefs": [],
                "isDirectIncome": false
              },
              {
                "description": "",
                "unitAmount": 0,
                "quantity": 1,
                "discountAmount": 0,
                "subTotal": 0,
                "taxAmount": 0,
                "totalAmount": 0,
                "accountRef": {
                  "id": "NullId"
                },
                "discountPercentage": 0,
                "taxRateRef": {
                  "id": "cc81fea8-2917-ed11-90eb-002248009df3",
                  "name": "",
                  "effectiveTaxRate": 0
                },
                "trackingCategoryRefs": [],
                "isDirectIncome": false
              }
            ],
            "paymentAllocations": [
              {
                "payment": {
                  "id": "c2942210-1e60-eb11-89fa-00224800a9c7",
                  "note": "Credit Memo 1002",
                  "reference": "Document No: 104002",
                  "currency": "GBP",
                  "currencyRate": 1,
                  "paidOnDate": "2021-01-26T00:00:00",
                  "totalAmount": 0
                },
                "allocation": {
                  "currency": "GBP",
                  "currencyRate": 1,
                  "allocatedOnDate": "2021-01-26T00:00:00",
                  "totalAmount": 779.28
                }
              }
            ],
            "modifiedDate": "2023-03-27T14:21:25Z",
            "sourceModifiedDate": "2021-01-26T21:33:01Z",
            "metadata": {
              "isDeleted": false
            }
          }
        ],
        "pageNumber": 1,
        "pageSize": 2,
        "totalResults": 13,
        "_links": {
          "current": {
            "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/creditNotes?page=1&pageSize=2"
          },
          "self": {
            "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/creditNotes"
          },
          "next": {
            "href": "/companies/d6849caf-c146-41be-8335-b73346e3bd84/data/creditNotes?page=2&pageSize=2"
          }
        }
      }
    },
    {
      "status": "200",
      "contentType": "application/json",
      "name": "FreeAgent",
      "example": {
        "results": [
          {
            "id": "21952211",
            "creditNoteNumber": "004",
            "customerRef": {
              "id": "6162023",
              "companyName": "Alderley plc"
            },
            "withholdingTax": [],
            "totalAmount": 165,
            "totalDiscount": 0,
            "subTotal": 165,
            "additionalTaxAmount": 0,
            "additionalTaxPercentage": 0,
            "totalTaxAmount": 0,
            "discountPercentage": 0,
            "remainingCredit": 0,
            "status": "Paid",
            "issueDate": "2017-10-18T00:00:00",
            "currency": "GBP",
            "currencyRate": 1,
            "lineItems": [
              {
                "description": "Reverse 6546",
                "unitAmount": 110,
                "quantity": 1.5,
                "subTotal": 165,
                "taxAmount": 0,
                "totalAmount": 165,
                "trackingCategoryRefs": [],
                "isDirectIncome": false
              }
            ],
            "paymentAllocations": [
              {
                "payment": {
                  "id": "270764400",
                  "note": "\ufffd165.00 - Credit Note refund against 004",
                  "currency": "GBP",
                  "paidOnDate": "2020-12-23T00:00:00",
                  "totalAmount": -165
                },
                "allocation": {
                  "currency": "GBP",
                  "currencyRate": 1,
                  "totalAmount": 165
                }
              }
            ],
            "modifiedDate": "2023-04-25T14:19:09Z",
            "sourceModifiedDate": "2020-12-23T16:39:23Z",
            "metadata": {
              "isDeleted": false
            }
          },
          {
            "id": "53604300",
            "creditNoteNumber": "2367",
            "customerRef": {
              "id": "6162023",
              "companyName": "Alderley plc"
            },
            "withholdingTax": [],
            "totalAmount": 165,
            "totalDiscount": 0,
            "subTotal": 165,
            "additionalTaxAmount": 0,
            "additionalTaxPercentage": 0,
            "totalTaxAmount": 0,
            "discountPercentage": 0,
            "remainingCredit": 165,
            "status": "Draft",
            "issueDate": "2017-10-18T00:00:00",
            "currency": "GBP",
            "currencyRate": 1,
            "lineItems": [
              {
                "description": "Reverse 6546",
                "unitAmount": 110,
                "quantity": 1.5,
                "subTotal": 165,
                "taxAmount": 0,
                "totalAmount": 165,
                "trackingCategoryRefs": [],
                "isDirectIncome": false
              }
            ],
            "paymentAllocations": [],
            "modifiedDate": "2023-04-25T14:19:09Z",
            "sourceModifiedDate": "2022-09-29T13:00:09Z",
            "metadata": {
              "isDeleted": false
            }
          }
        ],
        "pageNumber": 1,
        "pageSize": 2,
        "totalResults": 281,
        "_links": {
          "current": {
            "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/creditNotes?page=1&pageSize=2"
          },
          "self": {
            "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/creditNotes"
          },
          "next": {
            "href": "/companies/071ad738-68f3-4561-afd0-69bab9df0803/data/creditNotes?page=2&pageSize=2"
          }
        }
      }
    },
    {
      "status": "200",
      "contentType": "application/json",
      "name": "FreshBooks",
      "example": {
        "results": [
          {
            "id": "33407",
            "creditNoteNumber": "0000065",
            "customerRef": {
              "id": "511657",
              "companyName": "Bob's Stationary"
            },
            "withholdingTax": [],
            "totalAmount": 150,
            "totalDiscount": 0,
            "subTotal": 150,
            "additionalTaxAmount": 0,
            "additionalTaxPercentage": 0,
            "totalTaxAmount": 0,
            "discountPercentage": 0,
            "remainingCredit": 0,
            "status": "Submitted",
            "issueDate": "2020-07-31T00:00:00",
            "currency": "GBP",
            "lineItems": [
              {
                "description": "Test Di",
                "unitAmount": 150,
                "quantity": 1,
                "subTotal": 150,
                "taxAmount": 0,
                "totalAmount": 150,
                "trackingCategoryRefs": [],
                "isDirectIncome": false
              }
            ],
            "paymentAllocations": [
              {
                "payment": {
                  "id": "2054019",
                  "note": "Free $150 voucher",
                  "currency": "GBP",
                  "paidOnDate": "2020-07-31T00:00:00",
                  "totalAmount": 0
                },
                "allocation": {
                  "currency": "GBP",
                  "currencyRate": 1,
                  "totalAmount": 150
                }
              }
            ],
            "modifiedDate": "2023-03-24T16:07:23Z",
            "note": "Free $150 voucher",
            "metadata": {
              "isDeleted": false
            }
          },
          {
            "id": "33409",
            "creditNoteNumber": "0000066",
            "customerRef": {
              "id": "511657",
              "companyName": "Bob's Stationary"
            },
            "withholdingTax": [],
            "totalAmount": 300,
            "totalDiscount": 0,
            "subTotal": 300,
            "additionalTaxAmount": 0,
            "additionalTaxPercentage": 0,
            "totalTaxAmount": 0,
            "discountPercentage": 0,
            "remainingCredit": 0,
            "status": "Draft",
            "issueDate": "2020-07-31T00:00:00",
            "currency": "GBP",
            "lineItems": [
              {
                "description": "Test Di",
                "unitAmount": 150,
                "quantity": 2,
                "subTotal": 300,
                "taxAmount": 0,
                "totalAmount": 300,
                "trackingCategoryRefs": [],
                "isDirectIncome": false
              }
            ],
            "paymentAllocations": [
              {
                "payment": {
                  "id": "2054021",
                  "note": "Free $150 voucher",
                  "currency": "GBP",
                  "paidOnDate": "2020-07-31T00:00:00",
                  "totalAmount": 0
                },
                "allocation": {
                  "currency": "GBP",
                  "currencyRate": 1,
                  "totalAmount": 300
                }
              }
            ],
            "modifiedDate": "2023-03-24T16:07:23Z",
            "note": "Free $150 voucher",
            "metadata": {
              "isDeleted": false
            }
          }
        ],
        "pageNumber": 1,
        "pageSize": 2,
        "totalResults": 53,
        "_links": {
          "current": {
            "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/creditNotes?page=1&pageSize=2"
          },
          "self": {
            "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/creditNotes"
          },
          "next": {
            "href": "/companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/creditNotes?page=2&pageSize=2"
          }
        }
      }
    },
    {
      "status": "200",
      "contentType": "application/json",
      "name": "KashFlow",
      "example": {
        "results": [
          {
            "id": "85322315",
            "creditNoteNumber": "4",
            "customerRef": {
              "id": "69946501",
              "companyName": "Peter Lord"
            },
            "withholdingTax": [],
            "totalAmount": 100,
            "totalDiscount": 0,
            "subTotal": 0,
            "additionalTaxAmount": 0,
            "additionalTaxPercentage": 0,
            "totalTaxAmount": 0,
            "discountPercentage": 0,
            "remainingCredit": 0,
            "status": "Paid",
            "issueDate": "2017-05-09T00:00:00",
            "currency": "GBP",
            "currencyRate": 1,
            "lineItems": [
              {
                "description": "youm",
                "unitAmount": 100,
                "quantity": -1,
                "subTotal": -100,
                "taxAmount": 0,
                "totalAmount": 100,
                "accountRef": {
                  "id": "21481817",
                  "name": "Sale of goods"
                },
                "itemRef": {
                  "id": "158667064"
                },
                "trackingCategoryRefs": [],
                "isDirectIncome": false
              }
            ],
            "paymentAllocations": [
              {
                "payment": {
                  "id": "86870120",
                  "note": "Applying Credit Note",
                  "currency": "GBP",
                  "paidOnDate": "2017-05-09T00:00:00",
                  "totalAmount": -100
                },
                "allocation": {
                  "currency": "GBP",
                  "currencyRate": 1,
                  "totalAmount": 100
                }
              }
            ],
            "modifiedDate": "2022-09-30T10:29:16Z"
          },
          {
            "id": "85326016",
            "creditNoteNumber": "5",
            "customerRef": {
              "id": "69952389",
              "companyName": "Things Limited"
            },
            "withholdingTax": [],
            "totalAmount": 1000,
            "totalDiscount": 0,
            "subTotal": 0,
            "additionalTaxAmount": 0,
            "additionalTaxPercentage": 0,
            "totalTaxAmount": 0,
            "discountPercentage": 0,
            "remainingCredit": 0,
            "status": "Paid",
            "issueDate": "2017-05-09T00:00:00",
            "currency": "GBP",
            "currencyRate": 1,
            "lineItems": [
              {
                "description": "158675173",
                "unitAmount": 1,
                "quantity": -1000,
                "subTotal": -1000,
                "taxAmount": 0,
                "totalAmount": 1000,
                "accountRef": {
                  "id": "21481817",
                  "name": "Sale of goods"
                },
                "itemRef": {
                  "id": "158675173"
                },
                "trackingCategoryRefs": [],
                "isDirectIncome": false
              }
            ],
            "paymentAllocations": [
              {
                "payment": {
                  "id": "86873915",
                  "note": "Applying Credit Note",
                  "currency": "GBP",
                  "paidOnDate": "2017-05-09T00:00:00",
                  "totalAmount": -400
                },
                "allocation": {
                  "currency": "GBP",
                  "currencyRate": 1,
                  "totalAmount": 400
                }
              },
              {
                "payment": {
                  "id": "86874181",
                  "note": "",
                  "currency": "GBP",
                  "paidOnDate": "2017-05-09T00:00:00",
                  "totalAmount": -100
                },
                "allocation": {
                  "currency": "GBP",
                  "currencyRate": 1,
                  "totalAmount": 100
                }
              },
              {
                "payment": {
                  "id": "86874199",
                  "note": "",
                  "currency": "GBP",
                  "paidOnDate": "2017-05-09T00:00:00",
                  "totalAmount": -50
                },
                "allocation": {
                  "currency": "GBP",
                  "currencyRate": 1,
                  "totalAmount": 50
                }
              },
              {
                "payment": {
                  "id": "86875655",
                  "note": "Credit Note",
                  "currency": "GBP",
                  "paidOnDate": "2017-05-09T00:00:00",
                  "totalAmount": -750
                },
                "allocation": {
                  "currency": "GBP",
                  "currencyRate": 1,
                  "totalAmount": 750
                }
              }
            ],
            "modifiedDate": "2022-09-30T10:29:16Z"
          }
        ],
        "pageNumber": 1,
        "pageSize": 2,
        "totalResults": 17,
        "_links": {
          "current": {
            "href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/creditNotes?page=1&pageSize=2"
          },
          "self": {
            "href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/creditNotes"
          },
          "next": {
            "href": "/companies/3a707a99-89da-4b16-a5d6-595333a16352/data/creditNotes?page=2&pageSize=2"
          }
        }
      }
    },
    {
      "status": "200",
      "contentType": "application/json",
      "name": "Oracle NetSuite",
      "example": {
        "results": [
          {
            "id": "8827",
            "creditNoteNumber": "CM27",
            "customerRef": {
              "id": "417",
              "companyName": "10 Breww Ltd"
            },
            "withholdingTax": [],
            "totalAmount": 26,
            "totalDiscount": 0,
            "subTotal": 26,
            "additionalTaxAmount": 0,
            "additionalTaxPercentage": 0,
            "totalTaxAmount": 0,
            "discountPercentage": 0,
            "remainingCredit": 26,
            "status": "Submitted",
            "issueDate": "2021-04-09T00:00:00",
            "currency": "GBP",
            "currencyRate": 1,
            "lineItems": [
              {
                "description": "Andy Test Item",
                "unitAmount": 2,
                "quantity": 3,
                "subTotal": 6,
                "totalAmount": 6,
                "accountRef": {
                  "id": "54",
                  "name": "Sales"
                },
                "itemRef": {
                  "id": "143",
                  "name": "Andy Test Item"
                },
                "trackingCategoryRefs": [
                  {
                    "id": "classification-2"
                  },
                  {
                    "id": "department-1"
                  },
                  {
                    "id": "location-1"
                  }
                ],
                "isDirectIncome": false
              },
              {
                "description": "Non-Recurring Services - EC",
                "unitAmount": 4,
                "quantity": 5,
                "subTotal": 20,
                "totalAmount": 20,
                "accountRef": {
                  "id": "54",
                  "name": "Sales"
                },
                "itemRef": {
                  "id": "28",
                  "name": "Non-Recurring Services - EC"
                },
                "trackingCategoryRefs": [
                  {
                    "id": "classification-2"
                  },
                  {
                    "id": "department-1"
                  },
                  {
                    "id": "location-1"
                  }
                ],
                "isDirectIncome": false
              }
            ],
            "paymentAllocations": [],
            "modifiedDate": "2022-09-20T08:15:31Z",
            "sourceModifiedDate": "2022-02-25T10:58:10"
          },
          {
            "id": "8828",
            "creditNoteNumber": "CM28",
            "customerRef": {
              "id": "417",
              "companyName": "10 Breww Ltd"
            },
            "withholdingTax": [],
            "totalAmount": 26,
            "totalDiscount": 0,
            "subTotal": 26,
            "additionalTaxAmount": 0,
            "additionalTaxPercentage": 0,
            "totalTaxAmount": 0,
            "discountPercentage": 0,
            "remainingCredit": 10,
            "status": "PartiallyPaid",
            "issueDate": "2021-04-09T00:00:00",
            "currency": "GBP",
            "currencyRate": 1,
            "lineItems": [
              {
                "description": "Andy Test Item",
                "unitAmount": 2,
                "quantity": 3,
                "subTotal": 6,
                "totalAmount": 6,
                "accountRef": {
                  "id": "54",
                  "name": "Sales"
                },
                "itemRef": {
                  "id": "143",
                  "name": "Andy Test Item"
                },
                "trackingCategoryRefs": [
                  {
                    "id": "classification-2"
                  },
                  {
                    "id": "department-1"
                  },
                  {
                    "id": "location-1"
                  }
                ],
                "isDirectIncome": false
              },
              {
                "description": "Non-Recurring Services - EC",
                "unitAmount": 4,
                "quantity": 5,
                "subTotal": 20,
                "totalAmount": 20,
                "accountRef": {
                  "id": "54",
                  "name": "Sales"
                },
                "itemRef": {
                  "id": "28",
                  "name": "Non-Recurring Services - EC"
                },
                "trackingCategoryRefs": [
                  {
                    "id": "classification-2"
                  },
                  {
                    "id": "department-1"
                  },
                  {
                    "id": "location-1"
                  }
                ],
                "isDirectIncome": false
              }
            ],
            "paymentAllocations": [
              {
                "payment": {
                  "id": "8828",
                  "reference": "Credit Memo #CM28",
                  "currency": "GBP",
                  "currencyRate": 1,
                  "paidOnDate": "2021-04-09T00:00:00",
                  "totalAmount": 0
                },
                "allocation": {
                  "currency": "GBP",
                  "currencyRate": 1,
                  "totalAmount": 16
                }
              }
            ],
            "modifiedDate": "2022-09-20T08:15:31Z",
            "sourceModifiedDate": "2022-02-25T10:58:37"
          }
        ],
        "pageNumber": 1,
        "pageSize": 2,
        "totalResults": 36,
        "_links": {
          "current": {
            "href": "/companies/973341cc-ca0a-4a88-88de-e5954157818b/data/creditNotes?page=1&pageSize=2"
          },
          "self": {
            "href": "/companies/973341cc-ca0a-4a88-88de-e5954157818b/data/creditNotes"
          },
          "next": {
            "href": "/companies/973341cc-ca0a-4a88-88de-e5954157818b/data/creditNotes?page=2&pageSize=2"
          }
        }
      }
    },
    {
      "status": "200",
      "contentType": "application/json",
      "name": "QuickBooks Desktop",
      "example": {
        "results": [
          {
            "id": "96C-933372931",
            "creditNoteNumber": "4002",
            "customerRef": {
              "id": "150000-933272658",
              "companyName": "Abercrombie, Kristy"
            },
            "withholdingTax": [],
            "totalAmount": 711.15,
            "totalDiscount": 0,
            "subTotal": 660,
            "additionalTaxAmount": 0,
            "additionalTaxPercentage": 0,
            "totalTaxAmount": 51.15,
            "discountPercentage": 0,
            "remainingCredit": 0,
            "status": "Paid",
            "issueDate": "2024-12-01T00:00:00",
            "currency": "GBP",
            "currencyRate": 1,
            "lineItems": [
              {
                "description": "Whirlpool tub\nBilled and paid for 2 tubs, should have been for only 1 tub",
                "unitAmount": 660,
                "quantity": 1,
                "subTotal": 660,
                "taxAmount": 0,
                "totalAmount": 660,
                "accountRef": {
                  "id": "40000-933270541",
                  "name": "Accounts Receivable"
                },
                "taxRateRef": {
                  "id": "10000-999022286",
                  "name": "Taxable Sales"
                },
                "itemRef": {
                  "id": "1E0000-933272656",
                  "name": "Plumb Fixtrs"
                },
                "trackingCategoryRefs": [
                  {
                    "id": "40000-933272658",
                    "name": "Remodel"
                  }
                ],
                "isDirectIncome": false
              }
            ],
            "paymentAllocations": [
              {
                "payment": {
                  "id": "969-933372844",
                  "accountRef": {
                    "id": "20000-933270541",
                    "name": "Checking"
                  },
                  "currency": "GBP",
                  "currencyRate": 1,
                  "paidOnDate": "2024-12-01T00:00:00",
                  "totalAmount": -711.15
                },
                "allocation": {
                  "currency": "GBP",
                  "currencyRate": 1,
                  "totalAmount": 711.15
                }
              }
            ],
            "modifiedDate": "2023-04-26T09:07:38Z",
            "sourceModifiedDate": "2023-12-16T05:04:05",
            "metadata": {
              "isDeleted": false
            }
          }
        ],
        "pageNumber": 1,
        "pageSize": 2,
        "totalResults": 1,
        "_links": {
          "current": {
            "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/creditNotes?page=1&pageSize=2"
          },
          "self": {
            "href": "/companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/creditNotes"
          }
        }
      }
    },
    {
      "status": "200",
      "contentType": "application/json",
      "name": "QuickBooks Online",
      "example": {
        "results": [
          {
            "id": "85",
            "creditNoteNumber": "3122019_6",
            "customerRef": {
              "id": "3",
              "companyName": "Information Sharing Technology"
            },
            "withholdingTax": [],
            "totalAmount": 13.53,
            "totalDiscount": 0,
            "subTotal": 13.53,
            "additionalTaxAmount": 0,
            "additionalTaxPercentage": 0,
            "totalTaxAmount": 0,
            "discountPercentage": 0,
            "remainingCredit": 0,
            "sta

# --- truncated at 32 KB (72 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/codat/refs/heads/main/examples/codat-list-accounting-credit-notes-example.json