Credit invoice

cURL

curl -X POST \
 /invoices/{id}/credit \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{
    "positions": [
        []
    ],
    "comment": "",
    "paymentMethod": "https:\/\/example.com\/",
    "customIntroduction": "",
    "customClosing": ""
}'

import requests

url = "https://coreapi.io/invoices/{id}/credit"

payload = {
    "positions": [
        {
            "id": "<string>",
            "quantity": 1,
            "unitPrice": {}
        }
    ],
    "comment": "<string>",
    "reason": "other",
    "paymentMethod": "https://example.com/",
    "customIntroduction": "<string>",
    "customClosing": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    positions: [{id: '<string>', quantity: 1, unitPrice: {}}],
    comment: '<string>',
    reason: 'other',
    paymentMethod: 'https://example.com/',
    customIntroduction: '<string>',
    customClosing: '<string>'
  })
};

fetch('https://coreapi.io/invoices/{id}/credit', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://coreapi.io/invoices/{id}/credit",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'positions' => [
        [
                'id' => '<string>',
                'quantity' => 1,
                'unitPrice' => [
                                
                ]
        ]
    ],
    'comment' => '<string>',
    'reason' => 'other',
    'paymentMethod' => 'https://example.com/',
    'customIntroduction' => '<string>',
    'customClosing' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "id": "00000000-0000-0000-0000-000000000000",
  "customer": {
    "id": "00000000-0000-0000-0000-000000000000",
    "customerNumber": "CUSTOMER-000",
    "timeZone": "Europe/Berlin",
    "firstName": "John",
    "lastName": "Doe",
    "currencyCode": "EUR",
    "companyName": "Acme Inc.",
    "datevId": "123456789",
    "status": "STATUS_ACTIVE"
  },
  "paymentMethod": {
    "id": "c1a2b3c4-d5e6-4f7a-8b9b-0c1d2e3f4a5b",
    "gatewayName": "wallet",
    "type": "sepa_debit",
    "referenceId": "<string>",
    "default": true,
    "status": "active",
    "source": "api",
    "enabled": true,
    "name": "Visa (4242)",
    "data": [
      "<string>"
    ],
    "creationDate": "2024-01-15T10:30:00+00:00",
    "expirationDate": "2026-12-31T23:59:59+00:00",
    "sepaMandate": {},
    "card": {
      "brand": "Visa",
      "last4": "4242",
      "expMonth": 12,
      "expYear": 2022,
      "cardHolder": "Max Mustermann"
    },
    "sepaDebit": {
      "iban": "DE8937*********3232",
      "bic": "COBADEFFXXX",
      "mandateReference": "MNDT-2021-123456",
      "signingDate": "2021-01-01T00:00:00+00:00"
    },
    "paypal": {
      "email": "max@mustermann.de",
      "billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
    }
  },
  "referencedInvoice": "<unknown>",
  "type": "TYPE_INVOICE",
  "currencyCode": "EUR",
  "number": "RE-0000000001",
  "status": "STATUS_DRAFT",
  "creationDate": "2023-11-07T05:31:56Z",
  "finalizationDate": "2023-11-07T05:31:56Z",
  "dueDate": "2023-11-07T05:31:56Z",
  "lastReminderDate": "2023-11-07T05:31:56Z",
  "lastSentAt": "2023-11-07T05:31:56Z",
  "dunningLevel": 123,
  "dunningStatus": "none",
  "payDate": "2023-11-07T05:31:56Z",
  "invoiceAddress": "<unknown>",
  "internalNote": "This invoice is with a special discount.",
  "title": "<string>",
  "introduction": "<string>",
  "closing": "<string>",
  "netAmount": {},
  "grossAmount": {},
  "taxAmount": {},
  "discountAmount": {},
  "file": {
    "id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
    "isPrivate": true,
    "mimeType": "image/jpeg",
    "fileExtension": "jpg",
    "fileName": "invoice.jpg",
    "storageFileName": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg",
    "createdAt": "2021-01-01T00:00:00+00:00"
  },
  "xmlFile": {
    "id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
    "isPrivate": true,
    "mimeType": "image/jpeg",
    "fileExtension": "jpg",
    "fileName": "invoice.jpg",
    "storageFileName": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg",
    "createdAt": "2021-01-01T00:00:00+00:00"
  },
  "positions": [
    {
      "id": {},
      "position": 123,
      "quantity": 1,
      "unit": {
        "id": {},
        "name": "Stück"
      },
      "unitPrice": {},
      "netAmount": {},
      "grossAmount": {},
      "taxAmount": {},
      "discountAmount": {},
      "discountPercentage": 10,
      "name": "My subscription product",
      "description": "* my subscription product",
      "taxGroup": {
        "internalDescription": "19%",
        "reverseChargeType": "REVERSE_CHARGE",
        "type": "standard",
        "id": "00000000-0000-0000-0000-000000000000"
      },
      "tax": {
        "code": "19",
        "rate": 19,
        "id": "00000000-0000-0000-0000-000000000000",
        "description": "19%"
      },
      "type": "product",
      "parent": "<unknown>",
      "group": {
        "id": "ad8a3b9e-5b0a-4e1a-9c1a-0b9b2b8b0b0b",
        "ranking": 1,
        "name": "Subscription #12345"
      },
      "createdAt": "2020-01-01T00:00:00+00:00",
      "product": {
        "type": "product",
        "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
        "name": "Basic",
        "description": "For small teams.",
        "invoiceVisibility": "always",
        "customFields": {
          "field1": "value1",
          "field2": "value2"
        }
      },
      "subscriptionItem": {
        "id": "01F9ZQZJZJQZJZJZJZJZJZJZJZ",
        "name": "Fitness M",
        "description": "Everything included",
        "furtherInformation": "Additional agreements: The contract includes a free drink flatrate.",
        "status": "active",
        "subscriptionId": "<string>"
      },
      "serviceDateFrom": "2020-01-01T00:00:00+00:00",
      "serviceDateTo": "2020-01-01T00:00:00+00:00"
    }
  ],
  "applicatedExchangeRates": [
    {
      "sourceCurrencyCode": "EUR",
      "destinationCurrencyCode": "CHF",
      "exchangeRate": "1.135",
      "exchangeRateDate": "2023-11-07T05:31:56Z"
    }
  ],
  "eInvoiceType": "zugferd211",
  "leitwegId": "1234567890123",
  "customFields": {
    "field1": "value1",
    "field2": "value2"
  },
  "serviceDateFrom": "2023-11-07T05:31:56Z",
  "serviceDateTo": "2023-11-07T05:31:56Z",
  "unpaidAmount": {},
  "usageBreakdownUrl": "<string>",
  "cancellationDocument": {
    "number": "R2021-0001",
    "id": "8d6b0f9e-5b9a-4e1a-9f0a-5e8e1a0b1b1e"
  },
  "dunningDisabled": true,
  "paymentProviderFeeCents": {},
  "sourceType": "<unknown>",
  "creditNotes": "<array>"
}

POST

invoices

{id}

credit

cURL

curl -X POST \
 /invoices/{id}/credit \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{
    "positions": [
        []
    ],
    "comment": "",
    "paymentMethod": "https:\/\/example.com\/",
    "customIntroduction": "",
    "customClosing": ""
}'

import requests

url = "https://coreapi.io/invoices/{id}/credit"

payload = {
    "positions": [
        {
            "id": "<string>",
            "quantity": 1,
            "unitPrice": {}
        }
    ],
    "comment": "<string>",
    "reason": "other",
    "paymentMethod": "https://example.com/",
    "customIntroduction": "<string>",
    "customClosing": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    positions: [{id: '<string>', quantity: 1, unitPrice: {}}],
    comment: '<string>',
    reason: 'other',
    paymentMethod: 'https://example.com/',
    customIntroduction: '<string>',
    customClosing: '<string>'
  })
};

fetch('https://coreapi.io/invoices/{id}/credit', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://coreapi.io/invoices/{id}/credit",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'positions' => [
        [
                'id' => '<string>',
                'quantity' => 1,
                'unitPrice' => [
                                
                ]
        ]
    ],
    'comment' => '<string>',
    'reason' => 'other',
    'paymentMethod' => 'https://example.com/',
    'customIntroduction' => '<string>',
    'customClosing' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "id": "00000000-0000-0000-0000-000000000000",
  "customer": {
    "id": "00000000-0000-0000-0000-000000000000",
    "customerNumber": "CUSTOMER-000",
    "timeZone": "Europe/Berlin",
    "firstName": "John",
    "lastName": "Doe",
    "currencyCode": "EUR",
    "companyName": "Acme Inc.",
    "datevId": "123456789",
    "status": "STATUS_ACTIVE"
  },
  "paymentMethod": {
    "id": "c1a2b3c4-d5e6-4f7a-8b9b-0c1d2e3f4a5b",
    "gatewayName": "wallet",
    "type": "sepa_debit",
    "referenceId": "<string>",
    "default": true,
    "status": "active",
    "source": "api",
    "enabled": true,
    "name": "Visa (4242)",
    "data": [
      "<string>"
    ],
    "creationDate": "2024-01-15T10:30:00+00:00",
    "expirationDate": "2026-12-31T23:59:59+00:00",
    "sepaMandate": {},
    "card": {
      "brand": "Visa",
      "last4": "4242",
      "expMonth": 12,
      "expYear": 2022,
      "cardHolder": "Max Mustermann"
    },
    "sepaDebit": {
      "iban": "DE8937*********3232",
      "bic": "COBADEFFXXX",
      "mandateReference": "MNDT-2021-123456",
      "signingDate": "2021-01-01T00:00:00+00:00"
    },
    "paypal": {
      "email": "max@mustermann.de",
      "billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
    }
  },
  "referencedInvoice": "<unknown>",
  "type": "TYPE_INVOICE",
  "currencyCode": "EUR",
  "number": "RE-0000000001",
  "status": "STATUS_DRAFT",
  "creationDate": "2023-11-07T05:31:56Z",
  "finalizationDate": "2023-11-07T05:31:56Z",
  "dueDate": "2023-11-07T05:31:56Z",
  "lastReminderDate": "2023-11-07T05:31:56Z",
  "lastSentAt": "2023-11-07T05:31:56Z",
  "dunningLevel": 123,
  "dunningStatus": "none",
  "payDate": "2023-11-07T05:31:56Z",
  "invoiceAddress": "<unknown>",
  "internalNote": "This invoice is with a special discount.",
  "title": "<string>",
  "introduction": "<string>",
  "closing": "<string>",
  "netAmount": {},
  "grossAmount": {},
  "taxAmount": {},
  "discountAmount": {},
  "file": {
    "id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
    "isPrivate": true,
    "mimeType": "image/jpeg",
    "fileExtension": "jpg",
    "fileName": "invoice.jpg",
    "storageFileName": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg",
    "createdAt": "2021-01-01T00:00:00+00:00"
  },
  "xmlFile": {
    "id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
    "isPrivate": true,
    "mimeType": "image/jpeg",
    "fileExtension": "jpg",
    "fileName": "invoice.jpg",
    "storageFileName": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg",
    "createdAt": "2021-01-01T00:00:00+00:00"
  },
  "positions": [
    {
      "id": {},
      "position": 123,
      "quantity": 1,
      "unit": {
        "id": {},
        "name": "Stück"
      },
      "unitPrice": {},
      "netAmount": {},
      "grossAmount": {},
      "taxAmount": {},
      "discountAmount": {},
      "discountPercentage": 10,
      "name": "My subscription product",
      "description": "* my subscription product",
      "taxGroup": {
        "internalDescription": "19%",
        "reverseChargeType": "REVERSE_CHARGE",
        "type": "standard",
        "id": "00000000-0000-0000-0000-000000000000"
      },
      "tax": {
        "code": "19",
        "rate": 19,
        "id": "00000000-0000-0000-0000-000000000000",
        "description": "19%"
      },
      "type": "product",
      "parent": "<unknown>",
      "group": {
        "id": "ad8a3b9e-5b0a-4e1a-9c1a-0b9b2b8b0b0b",
        "ranking": 1,
        "name": "Subscription #12345"
      },
      "createdAt": "2020-01-01T00:00:00+00:00",
      "product": {
        "type": "product",
        "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
        "name": "Basic",
        "description": "For small teams.",
        "invoiceVisibility": "always",
        "customFields": {
          "field1": "value1",
          "field2": "value2"
        }
      },
      "subscriptionItem": {
        "id": "01F9ZQZJZJQZJZJZJZJZJZJZJZ",
        "name": "Fitness M",
        "description": "Everything included",
        "furtherInformation": "Additional agreements: The contract includes a free drink flatrate.",
        "status": "active",
        "subscriptionId": "<string>"
      },
      "serviceDateFrom": "2020-01-01T00:00:00+00:00",
      "serviceDateTo": "2020-01-01T00:00:00+00:00"
    }
  ],
  "applicatedExchangeRates": [
    {
      "sourceCurrencyCode": "EUR",
      "destinationCurrencyCode": "CHF",
      "exchangeRate": "1.135",
      "exchangeRateDate": "2023-11-07T05:31:56Z"
    }
  ],
  "eInvoiceType": "zugferd211",
  "leitwegId": "1234567890123",
  "customFields": {
    "field1": "value1",
    "field2": "value2"
  },
  "serviceDateFrom": "2023-11-07T05:31:56Z",
  "serviceDateTo": "2023-11-07T05:31:56Z",
  "unpaidAmount": {},
  "usageBreakdownUrl": "<string>",
  "cancellationDocument": {
    "number": "R2021-0001",
    "id": "8d6b0f9e-5b9a-4e1a-9f0a-5e8e1a0b1b1e"
  },
  "dunningDisabled": true,
  "paymentProviderFeeCents": {},
  "sourceType": "<unknown>",
  "creditNotes": "<array>"
}

Autorisierungen

Authorization

string

header

erforderlich

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Pfadparameter

string

erforderlich

Invoice identifier

Body

The new Invoice resource

positions

object[]

The positions to cancel.

Minimum array length: 1

Show child attributes

comment

string | null

Comment for the activity of crediting the invoice.

reason

enum<string>

Standard:other

The reason for crediting the invoice.

Verfügbare Optionen:

duplicate,

incorrect,

product_unsatisfactory,

order_change,

other

Beispiel:

"other"

paymentMethod

string<uuid>

The payment method for the credit note. The payment method must be valid and usable.

Beispiel:

"https://example.com/"

customIntroduction

string | null

The custom introduction for the credit note. It will be placed over the generic template.

customClosing

string | null

The custom closing for the credit note. It will be placed over the generic template.

Antwort

Invoice resource created

string<uuid>

read-only

The unique identifier of the invoice.

Beispiel:

"00000000-0000-0000-0000-000000000000"

customer

object

The customer of the invoice.

Show child attributes

paymentMethod

object | null

The payment method which should be used to fullfill the payment of the invoice.

Show child attributes

referencedInvoice

any | null

The referenced invoice of the invoice. This could be in case of a reminder, refund etc.

type

enum<string>

The type of the invoice.

Verfügbare Optionen:

TYPE_INVOICE,

TYPE_CREDIT,

TYPE_REFUND,

TYPE_REMINDER,

TYPE_CANCEL,

TYPE_DUNNING

Beispiel:

"TYPE_INVOICE"

currencyCode

string

The currency code of the invoice. If multiple currency codes will be used in the positions, they will be converted to that base currency.

Beispiel:

"EUR"

number

string

read-only

The document id of the invoice. This will be generated, when the invoice will be finalized.

Beispiel:

"RE-0000000001"

status

enum<string>

read-only

Verfügbare Optionen:

STATUS_DRAFT,

STATUS_PAID,

STATUS_CANCELLED,

STATUS_CLOSED,

STATUS_REFUNDED,

STATUS_REMINDED,

STATUS_UNPAID,

STATUS_NEW,

STATUS_FINALIZING

creationDate

string<date-time>

read-only

finalizationDate

string<date-time> | null

read-only

dueDate

string<date-time> | null

lastReminderDate

string<date-time> | null

read-only

lastSentAt

string<date-time> | null

read-only

dunningLevel

integer

read-only

dunningStatus

enum<string>

Standard:none

read-only

Verfügbare Optionen:

reminder,

dunning,

none

Beispiel:

"none"

payDate

string<date-time> | null

read-only

invoiceAddress

any | null

read-only

The invoice address of the invoice.

internalNote

string | null

veraltet

The notice of the invoice.

Beispiel:

"This invoice is with a special discount."

title

string | null

read-only

introduction

string | null

read-only

closing

string | null

read-only

netAmount

object

read-only

The net amount of the invoice.

grossAmount

object

read-only

taxAmount

object

read-only

discountAmount

object

read-only

The total net discount amount of the invoice.

file

object | null

Show child attributes

xmlFile

object | null

The xml representation of the invoice in EN16931 or x-Rechnung format.

Show child attributes

positions

object[]

read-only

The positions of the invoice.

Show child attributes

applicatedExchangeRates

object[]

read-only

The applicated exchange rates of the invoice, fetched from the european central bank.

Show child attributes

eInvoiceType

any

Standard:zugferd211

The einvoice generated xml file format.

Verfügbare Optionen:

factorx,zugferd211

Beispiel:

"zugferd211"

leitwegId

string | null

The leitwegid used for einvoice. This is only set, when the eInvoiceType is not null.

Beispiel:

"1234567890123"

customFields

object | null

Custom fields for the entity. The keys are the field names and the values are the field values. They need to be configured under "/custom-fields" in the API documentation. The input is validated against the configuration. For more details see Custom Fields Guide

Show child attributes

Beispiel:

{ "field1": "value1", "field2": "value2" }

serviceDateFrom

string<date-time> | null

read-only

The earliest service date of all positions.

serviceDateTo

string<date-time> | null

read-only

The latest service date of all positions.

unpaidAmount

object

read-only

usageBreakdownUrl

string | null

read-only

Public url to view the detailed usage breakdown of this invoice.

cancellationDocument

object | null

read-only

The referenced cancellation document.

Show child attributes

Beispiel:

{
  "number": "R2021-0001",
  "id": "8d6b0f9e-5b9a-4e1a-9f0a-5e8e1a0b1b1e"
}

dunningDisabled

boolean

read-only

Dunning is disabled for this invoice.

paymentProviderFeeCents

object

read-only

The total amount of fees for each payment provider, which charges fees.

Show child attributes

sourceType

any

read-only

Where the invoice was created from.

Possible values:

cart: The invoice was created from a cart.
subscription: The invoice was created from a subscription billing run.
manual: The invoice was created by a user.

creditNotes

array

read-only

The referenced credit notes.

API documentation

User

Tenant

Customer

Catalogue

Subscription

Invoice

Payment

Dunning

Offer

Checkout

Feature & Entitlement

Analytics

Accounting

Settings

Autorisierungen

Pfadparameter

Body

Antwort