Skip to content

Credit notes

Credit invoice (full, once)

invoices:write
ParameterInTypeRequiredDescription
invoiceIdpathstringYes
Request exampleNo request body
curl -X POST https://api.rieckflow.com/v1/invoices/9b2f1c1e-…/credit \
-H "Authorization: Bearer $RIECK_API_KEY" \
-H "Idempotency-Key: order-2041"
201 Success envelopeapplication/json
Response fields 8
FieldTypeDescription
data.iduuidStable invoice id.
data.invoiceNumberinteger | nullSequential number. Null while the invoice is a draft.
data.statusdraft | issued | paid | overdue | collectionsStored lifecycle status.
data.grossOereintegerInvoice total including VAT.
data.paidOereintegerTotal registered payments.
data.balanceOereintegerAmount still owed now.
data.collectionsCaseIduuid | nullCollection case created from this invoice.
data.externalReferencestring | nullYour reconciliation reference.
Possible errors 8
HTTPCodeMeaning
400invalid_idempotency_keyIdempotency-Key is missing or malformed.
401invalid_api_keyThe API key is missing, invalid, expired or revoked.
403api_not_includedThe organisation’s plan does not include API access.
403insufficient_scopeThe key does not have the required scope.
404invoice_not_foundThe invoice does not exist or belongs to another organisation.
409idempotency_conflictThe same key was used with a different request.
409idempotency_in_progressThe same operation is currently being processed. Retry later.
429rate_limitedThe organisation’s rate budget is exhausted.

List credit notes

invoices:read
ParameterInTypeRequiredDescription
customerIdquerystringNoFilter by customer
limitqueryintegerNoPage size, 1-200 (default 50)
cursorquerystringNoOpaque cursor from meta.nextCursor
Request exampleNo request body
curl https://api.rieckflow.com/v1/creditnotes \
-H "Authorization: Bearer $RIECK_API_KEY"
200 Success envelopeapplication/json
Response fields 9
FieldTypeDescription
data[].iduuidStable invoice id.
data[].invoiceNumberinteger | nullSequential number. Null while the invoice is a draft.
data[].statusdraft | issued | paid | overdue | collectionsStored lifecycle status.
data[].grossOereintegerInvoice total including VAT.
data[].paidOereintegerTotal registered payments.
data[].balanceOereintegerAmount still owed now.
data[].collectionsCaseIduuid | nullCollection case created from this invoice.
data[].externalReferencestring | nullYour reconciliation reference.
meta.nextCursor`stringnull`
Possible errors 5
HTTPCodeMeaning
400invalid_cursorThe cursor is malformed, expired or belongs to another list shape.
401invalid_api_keyThe API key is missing, invalid, expired or revoked.
403api_not_includedThe organisation’s plan does not include API access.
403insufficient_scopeThe key does not have the required scope.
429rate_limitedThe organisation’s rate budget is exhausted.

Get credit note

invoices:read
ParameterInTypeRequiredDescription
creditNoteIdpathstringYes
Request exampleNo request body
curl https://api.rieckflow.com/v1/creditnotes/9b2f1c1e-… \
-H "Authorization: Bearer $RIECK_API_KEY"
200 Success envelopeapplication/json
Response fields 8
FieldTypeDescription
data.iduuidStable invoice id.
data.invoiceNumberinteger | nullSequential number. Null while the invoice is a draft.
data.statusdraft | issued | paid | overdue | collectionsStored lifecycle status.
data.grossOereintegerInvoice total including VAT.
data.paidOereintegerTotal registered payments.
data.balanceOereintegerAmount still owed now.
data.collectionsCaseIduuid | nullCollection case created from this invoice.
data.externalReferencestring | nullYour reconciliation reference.
Possible errors 4
HTTPCodeMeaning
401invalid_api_keyThe API key is missing, invalid, expired or revoked.
403api_not_includedThe organisation’s plan does not include API access.
403insufficient_scopeThe key does not have the required scope.
429rate_limitedThe organisation’s rate budget is exhausted.

Credit note PDF (WORM)

invoices:read
ParameterInTypeRequiredDescription
creditNoteIdpathstringYes
Request exampleNo request body
curl https://api.rieckflow.com/v1/creditnotes/9b2f1c1e-…/pdf \
-H "Authorization: Bearer $RIECK_API_KEY"
200 Success envelopeapplication/pdf
Possible errors 4
HTTPCodeMeaning
401invalid_api_keyThe API key is missing, invalid, expired or revoked.
403api_not_includedThe organisation’s plan does not include API access.
403insufficient_scopeThe key does not have the required scope.
429rate_limitedThe organisation’s rate budget is exhausted.