v1

latestOpenAPI 3.0.02026-07-1315476656.4 KB

CreditNote

Retrieve CreditNote

There are a multitude of parameter which can be used to filter.

get/CreditNote

Query parameters

status'100' | '200' | '300' | '500' | '750' | '1000'

Status of the CreditNote

creditNoteNumberstring

Retrieve all CreditNotes with this creditNote number

startDateinteger

Retrieve all CreditNotes with a date equal or higher

endDateinteger

Retrieve all CreditNotes with a date equal or lower

contact[id]integer

Retrieve all CreditNotes with this contact. Must be provided with contact[objectName]

contact[objectName]string

Only required if contact[id] was provided. 'Contact' should be used as value.

Response

Successful operation

Example response

{
  "objects": [
    {
      "id": "1",
      "objectName": "CreditNote",
      "create": "2023-04-18T15:45:38+02:00",
      "update": "2023-04-18T15:45:38+02:00",
      "creditNoteNumber": "GU-1000",
      "contact": {
        "id": "1",
        "objectName": "Contact"
      },
      "creditNoteDate": "2023-04-18T15:45:38+02:00",
      "status": "100",
      "header": "My GU-1000",
      "addressCountry": {
        "id": "1",
        "objectName": "StaticCountry"
      },
      "createUser": {
        "id": "1",
        "objectName": "SevUser"
      },
      "sevClient": {
        "id": "1",
        "objectName": "SevClient"
      },
      "deliveryDate": "2023-04-18T15:45:38+02:00",
      "contactPerson": {
        "id": "1",
        "objectName": "SevUser"
      },
      "taxRate": "0",
      "taxSet": {
        "id": "1",
        "objectName": "TaxSet"
      },
      "taxText": "Umsatzsteuer 19%",
      "taxType": "default",
      "sendDate": "2023-04-18T15:45:38+02:00",
      "currency": "EUR",
      "sumNet": "0",
      "sumTax": "0",
      "sumGross": "0",
      "sumDiscounts": "0",
      "sumNetForeignCurrency": "0",
      "sumTaxForeignCurrency": "0",
      "sumGrossForeignCurrency": "0",
      "sumDiscountsForeignCurrency": "0"
    }
  ]
}