Credit notes

Credit notes represent credit notes associated with an invoice. A credit note is an invoice with a different type.

The Credit note object

Properties

See the invoice object for the properties of a credit note.

POST/v2/invoices/:id/credit-note

Create a credit note

This endpoint allows you to create a credit note from an invoice.

Parameters

percentagenumber
The percentage of the invoice to credit.

Request

POST

/v2/invoices/:id/credit-note

curl https://api.lsp.expert/v2/invoices671f905a186d40de4869e273/credit-note \
  -u {key}: \
  -d percentage=100

Response

{
  "id": "671f934a186d40de4869ebba",
  "applyVATReverseCharge": false,
  "archive": false,
  "client": {
    "id": "6718a1350e27164043ce9e80",
    "name": "Microsoft",
    "address": {
      "name": "Microsoft"
    }
  },
  "currency": {
    "code": "EUR",
    "symbol": "€"
  },
  "discount": 0,
  "document": {
    "id": "6718a0b50e27164043ce915a",
    "name": "English"
  },
  "dueDate": "2024-11-27T13:23:38.676Z",
  "exchangeRates": {
    "showExchangeRateOnInvoice": false
  },
  "filename": "CN-001.pdf",
  "filenameFormat": "[number]",
  "internalNotes": [],
  "isConflictingNumber": false,
  "isPartiallyPaid": false,
  "issueDate": "2024-10-28T13:36:10.075Z",
  "labels": [],
  "lines": [
    {
      "job": {
        "id": "6718a1350e27164043ce9f2f",
        "name": "First job",
        "isFixedPrice": false,
        "percentageInvoiced": 1,
        "timeBasedInvoice": false,
        "minimumFeeApplied": false
      },
      "service": {
        "id": "6718a0f90e27164043ce95c0",
        "name": "Translation"
      },
      "additionalInfo": null,
      "unitCost": -0.14,
      "discount": 0,
      "extraCharge": {
        "type": "percentage",
        "percentage": 0,
        "amount": 0
      },
      "quantity": {
        "value": 1000,
        "quantityType": {
          "id": "6718a0f90e27164043ce96a7",
          "name": "Words"
        }
      },
      "lineTotal": -140,
      "totalDetails": {
        "extraCharge": {
          "amount": 0,
          "discount": 0,
          "total": 0
        },
        "subtotal": {
          "amount": -140,
          "discount": 0,
          "total": -140
        },
        "total": -140
      },
      "notIncludeInTaxes": false,
      "matches": [],
      "groupMatches": false,
      "group": {
        "isParent": false,
        "childLines": []
      },
      "id": "671f905a186d40de4869e278"
    }
  ],
  "number": "CN-001",
  "object": "invoice",
  "payments": [],
  "pinned": false,
  "rappenRounding": false,
  "relatedCreditNoteIds": [],
  "relatedToInvoiceId": "671f905a186d40de4869e273",
  "status": 1,
  "tax1": {
    "id": "6718a0fd0e27164043ce97ae",
    "name": "VAT",
    "value": 0.21
  },
  "total": {
    "discount": {
      "amount": 0,
      "value": 0
    },
    "subtotal": -140,
    "subtotalTaxable": -140,
    "subtotalWithoutTaxes": -140,
    "tax1": {
      "id": "6718a0fd0e27164043ce97ae",
      "name": "VAT",
      "amount": -29.4,
      "value": 0.21
    },
    "tax2": null,
    "total": -169.4
  },
  "type": 3,
  "user": {
    "id": "6718a0b50e27164043ce912e",
    "name": "Cédric Doe"
  },
  "createdAt": "2024-10-28T13:23:38.676Z",
  "updatedAt": "2024-10-28T13:36:10.084Z"
}