Credit Notes
Authorise Credit Note
Locks the credit note (status → AUTHORISED) and makes it available for allocation to invoices. Syncs to external accounting provider if connected.
POST
/
clients
/
{clientId}
/
credit-notes
/
{creditNoteId}
/
authorise
Authorise Credit Note
curl --request POST \
--url https://api.sandbox.flowpayroll.ai/v1/billing/clients/{clientId}/credit-notes/{creditNoteId}/authorise \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--data '{}'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/billing/clients/{clientId}/credit-notes/{creditNoteId}/authorise"
payload = {}
headers = {
"X-Auth-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Auth-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://api.sandbox.flowpayroll.ai/v1/billing/clients/{clientId}/credit-notes/{creditNoteId}/authorise', 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://api.sandbox.flowpayroll.ai/v1/billing/clients/{clientId}/credit-notes/{creditNoteId}/authorise",
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([
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Auth-Token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.flowpayroll.ai/v1/billing/clients/{clientId}/credit-notes/{creditNoteId}/authorise"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Auth-Token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.flowpayroll.ai/v1/billing/clients/{clientId}/credit-notes/{creditNoteId}/authorise")
.header("X-Auth-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/billing/clients/{clientId}/credit-notes/{creditNoteId}/authorise")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Auth-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_body{
"content": {
"data": {
"id": "<string>",
"creditNoteNumber": "<string>",
"clientId": "<string>",
"organisationId": "<string>",
"date": "<string>",
"subTotal": 123,
"totalTax": 123,
"amount": 123,
"balanceDue": 123,
"reference": "<string>",
"invoiceReference": "<string>",
"linkedInvoiceId": "<string>",
"groupingKey": "<string>",
"source": "<string>",
"currencyCode": "<string>",
"currencyRate": 123,
"subtotalGroups": [
{
"label": "<string>",
"amount": 123,
"taxAmount": 123,
"totalAmount": 123,
"sortOrder": 123
}
],
"attachments": [
{
"id": "<string>",
"fileName": "<string>",
"url": "<string>",
"description": "<string>",
"s3Key": "<string>",
"contentType": "<string>",
"fileSize": 123,
"uploadedDate": "<string>",
"uploadedBy": "<string>",
"downloadUrl": "<string>",
"downloadUrlExpiresAt": "<string>"
}
],
"linesWithoutAttachmentsCount": 123,
"linesWithoutPoNumberCount": 123,
"allocations": [
{
"allocationId": "<string>",
"creditNoteId": "<string>",
"invoiceId": "<string>",
"amount": 123,
"date": "<string>",
"invoice": {
"invoiceId": "<string>",
"invoiceNumber": "<string>"
}
}
],
"externalId": "<string>",
"externalProvider": "<string>",
"lastSyncedAt": "<string>",
"syncErrorMessage": "<string>",
"syncErrorCode": "<string>",
"externalProviderStatus": "<string>",
"emailSent": true,
"emailSentAt": "<string>",
"emailSentBy": "<string>",
"createdDate": "<string>",
"createdBy": "<string>",
"updatedDate": "<string>",
"updatedBy": "<string>"
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>"
}
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>"
},
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"message": {
"text": "<string>",
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
}{
"content": {
"data": "<string>",
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>"
}
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>"
},
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"message": {
"text": "<string>",
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
}{
"content": {
"data": "<string>",
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>"
}
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>"
},
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"message": {
"text": "<string>",
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
}{
"content": {
"data": "<string>",
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>"
}
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>"
},
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"message": {
"text": "<string>",
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
}Authorizations
Authentication token for API access
Body
application/json
The body is of type object.
Was this page helpful?
⌘I
Authorise Credit Note
curl --request POST \
--url https://api.sandbox.flowpayroll.ai/v1/billing/clients/{clientId}/credit-notes/{creditNoteId}/authorise \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--data '{}'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/billing/clients/{clientId}/credit-notes/{creditNoteId}/authorise"
payload = {}
headers = {
"X-Auth-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Auth-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://api.sandbox.flowpayroll.ai/v1/billing/clients/{clientId}/credit-notes/{creditNoteId}/authorise', 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://api.sandbox.flowpayroll.ai/v1/billing/clients/{clientId}/credit-notes/{creditNoteId}/authorise",
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([
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Auth-Token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.flowpayroll.ai/v1/billing/clients/{clientId}/credit-notes/{creditNoteId}/authorise"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Auth-Token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.flowpayroll.ai/v1/billing/clients/{clientId}/credit-notes/{creditNoteId}/authorise")
.header("X-Auth-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/billing/clients/{clientId}/credit-notes/{creditNoteId}/authorise")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Auth-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_body{
"content": {
"data": {
"id": "<string>",
"creditNoteNumber": "<string>",
"clientId": "<string>",
"organisationId": "<string>",
"date": "<string>",
"subTotal": 123,
"totalTax": 123,
"amount": 123,
"balanceDue": 123,
"reference": "<string>",
"invoiceReference": "<string>",
"linkedInvoiceId": "<string>",
"groupingKey": "<string>",
"source": "<string>",
"currencyCode": "<string>",
"currencyRate": 123,
"subtotalGroups": [
{
"label": "<string>",
"amount": 123,
"taxAmount": 123,
"totalAmount": 123,
"sortOrder": 123
}
],
"attachments": [
{
"id": "<string>",
"fileName": "<string>",
"url": "<string>",
"description": "<string>",
"s3Key": "<string>",
"contentType": "<string>",
"fileSize": 123,
"uploadedDate": "<string>",
"uploadedBy": "<string>",
"downloadUrl": "<string>",
"downloadUrlExpiresAt": "<string>"
}
],
"linesWithoutAttachmentsCount": 123,
"linesWithoutPoNumberCount": 123,
"allocations": [
{
"allocationId": "<string>",
"creditNoteId": "<string>",
"invoiceId": "<string>",
"amount": 123,
"date": "<string>",
"invoice": {
"invoiceId": "<string>",
"invoiceNumber": "<string>"
}
}
],
"externalId": "<string>",
"externalProvider": "<string>",
"lastSyncedAt": "<string>",
"syncErrorMessage": "<string>",
"syncErrorCode": "<string>",
"externalProviderStatus": "<string>",
"emailSent": true,
"emailSentAt": "<string>",
"emailSentBy": "<string>",
"createdDate": "<string>",
"createdBy": "<string>",
"updatedDate": "<string>",
"updatedBy": "<string>"
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>"
}
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>"
},
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"message": {
"text": "<string>",
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
}{
"content": {
"data": "<string>",
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>"
}
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>"
},
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"message": {
"text": "<string>",
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
}{
"content": {
"data": "<string>",
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>"
}
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>"
},
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"message": {
"text": "<string>",
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
}{
"content": {
"data": "<string>",
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>"
}
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>"
},
"errors": [
{
"field": "<string>",
"reasonText": "<string>",
"reasonId": "<string>",
"reasonParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"message": {
"text": "<string>",
"textId": "<string>",
"textParameters": [
{
"key": "<string>",
"value": "<string>"
}
]
}
}