{
  "opencollection": "1.0.0",
  "info": {
    "name": "Xentral Account Credit Note API",
    "version": "v0.1"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Credit Note",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List credit notes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{xentralId}.xentral.biz/api/v1/creditNotes",
            "params": [
              {
                "name": "filter",
                "value": "",
                "type": "query"
              },
              {
                "name": "page",
                "value": "",
                "type": "query"
              },
              {
                "name": "order",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Returns a collection with all credit notes."
        },
        {
          "info": {
            "name": "Create credit note",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{xentralId}.xentral.biz/api/v1/creditNotes",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a credit note"
        },
        {
          "info": {
            "name": "View credit note",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{xentralId}.xentral.biz/api/v1/creditNotes/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The resource's identifier."
              }
            ]
          },
          "docs": "Returns details of a single credit note."
        },
        {
          "info": {
            "name": "Update credit note",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{xentralId}.xentral.biz/api/v1/creditNotes/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The resource's identifier."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a single credit note"
        },
        {
          "info": {
            "name": "Send credit note",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{xentralId}.xentral.biz/api/v1/creditNotes/:id/actions/send",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The resource's identifier."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Send credit note by email or to a printer. You can also mark the credit note as sent without actually sending it."
        },
        {
          "info": {
            "name": "View Credit Note Balance",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{xentralId}.xentral.biz/api/v1/creditNotes/:id/balance",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The resource's identifier."
              }
            ]
          },
          "docs": "Returns balance information (documents, payments) for a single credit note"
        },
        {
          "info": {
            "name": "View related documents for credit note",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{xentralId}.xentral.biz/api/v1/creditNotes/:id/documents",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The resource's identifier."
              }
            ]
          },
          "docs": "Returns details for related documents of a single credit note."
        }
      ]
    }
  ],
  "bundled": true
}