Email Invoice

curl --request POST \
  --url https://api.sandbox.flowpayroll.ai/v1/billing/invoices/{clientId}/{invoiceId}/email \
  --header 'X-Auth-Token: <api-key>'

import requests

url = "https://api.sandbox.flowpayroll.ai/v1/billing/invoices/{clientId}/{invoiceId}/email"

headers = {"X-Auth-Token": "<api-key>"}

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

print(response.text)

const options = {method: 'POST', headers: {'X-Auth-Token': '<api-key>'}};

fetch('https://api.sandbox.flowpayroll.ai/v1/billing/invoices/{clientId}/{invoiceId}/email', 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/invoices/{clientId}/{invoiceId}/email",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.flowpayroll.ai/v1/billing/invoices/{clientId}/{invoiceId}/email"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("X-Auth-Token", "<api-key>")

	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/invoices/{clientId}/{invoiceId}/email")
  .header("X-Auth-Token", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.flowpayroll.ai/v1/billing/invoices/{clientId}/{invoiceId}/email")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Auth-Token"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "message": {
    "token": "<string>",
    "text": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": null
      }
    ],
    "textId": "<string>",
    "textParameters": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ]
  },
  "content": {
    "data": {
      "id": "<string>",
      "organisationId": "<string>",
      "clientId": "<string>",
      "amount": 123,
      "lineAmountTypes": "<string>",
      "subTotal": 123,
      "totalTax": 123,
      "totalCreditAmount": 123,
      "balanceDue": 123,
      "currencyCode": "<string>",
      "appliedCredits": [
        {
          "creditNoteId": "<string>",
          "amountApplied": 123,
          "appliedDate": "<string>"
        }
      ],
      "status": "Draft",
      "invoiceFormat": "None",
      "groupingKey": "<string>",
      "invoiceFormatTagGroup": "<string>",
      "invoiceFormatTagName": "<string>",
      "date": "<string>",
      "dueDate": "<string>",
      "invoiceNumber": "<string>",
      "reference": "<string>",
      "invoiceType": "Sales",
      "attachments": [
        {
          "id": "<string>",
          "fileName": "<string>",
          "url": "<string>",
          "description": "<string>",
          "s3Key": "<string>",
          "contentType": "<string>",
          "fileSize": 123,
          "uploadedDate": "<string>",
          "uploadedBy": "<string>",
          "downloadUrl": "<string>",
          "downloadUrlExpiresAt": "<string>"
        }
      ],
      "lineItemAttachmentCount": 123,
      "linesWithoutAttachmentsCount": 123,
      "linesWithoutPoNumberCount": 123,
      "lineItems": [
        {
          "id": "<string>",
          "invoiceId": "<string>",
          "organisationId": "<string>",
          "clientId": "<string>",
          "employeeId": "<string>",
          "employeeName": "<string>",
          "description": "<string>",
          "amount": 123,
          "payElementId": "<string>",
          "units": 123,
          "chargeRate": 123,
          "chargeUnits": 123,
          "chargeValue": 123,
          "date": "<string>",
          "tags": [
            {
              "name": "<string>",
              "group": "<string>",
              "value": "<string>"
            }
          ],
          "createdDate": "<string>",
          "createdBy": "<string>",
          "attachments": [
            {
              "id": "<string>",
              "lineItemId": "<string>",
              "filename": "<string>",
              "contentType": "<string>",
              "fileSize": 123,
              "uploadedDate": "<string>",
              "uploadedBy": "<string>",
              "s3Key": "<string>",
              "source": "<string>",
              "downloadUrl": "<string>",
              "downloadUrlExpiresAt": "<string>"
            }
          ],
          "payElementDescription": "<string>",
          "accountCode": "<string>",
          "taxType": "<string>",
          "quantity": 123,
          "unitAmount": 123,
          "lineAmount": 123,
          "taxAmount": 123,
          "poNumber": "<string>"
        }
      ],
      "subtotalGroups": [
        {
          "label": "<string>",
          "amount": 123,
          "taxAmount": 123,
          "totalAmount": 123,
          "sortOrder": 123
        }
      ],
      "tags": [
        {
          "name": "<string>",
          "group": "<string>",
          "value": "<string>"
        }
      ],
      "externalId": "<string>",
      "externalProvider": "<string>",
      "lastSyncedAt": "<string>",
      "syncStatus": "NotSynced",
      "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>",
      "paginationToken": "<string>"
    }
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": null
        }
      ]
    }
  ],
  "errors": [
    {
      "field": "<string>",
      "reasonText": "<string>",
      "reasonId": "<string>",
      "reasonParameters": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "metadata": {
    "dateFormat": "<string>",
    "dateTimeFormat": "<string>",
    "paginationToken": "<string>"
  }
}

{
  "message": {
    "token": "<string>",
    "text": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": null
      }
    ],
    "textId": "<string>",
    "textParameters": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ]
  },
  "content": {
    "data": "<string>",
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    }
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": null
        }
      ]
    }
  ],
  "errors": [
    {
      "field": "<string>",
      "reasonText": "<string>",
      "reasonId": "<string>",
      "reasonParameters": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "metadata": {
    "dateFormat": "<string>",
    "dateTimeFormat": "<string>",
    "paginationToken": "<string>"
  }
}

{
  "message": {
    "token": "<string>",
    "text": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": null
      }
    ],
    "textId": "<string>",
    "textParameters": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ]
  },
  "content": {
    "data": null,
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    }
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": null
        }
      ]
    }
  ],
  "errors": [
    {
      "field": "<string>",
      "reasonText": "<string>",
      "reasonId": "<string>",
      "reasonParameters": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "metadata": {
    "dateFormat": "<string>",
    "dateTimeFormat": "<string>",
    "paginationToken": "<string>"
  }
}

{
  "message": {
    "token": "<string>",
    "text": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": null
      }
    ],
    "textId": "<string>",
    "textParameters": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ]
  },
  "content": {
    "data": "<string>",
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    }
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": null
        }
      ]
    }
  ],
  "errors": [
    {
      "field": "<string>",
      "reasonText": "<string>",
      "reasonId": "<string>",
      "reasonParameters": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "metadata": {
    "dateFormat": "<string>",
    "dateTimeFormat": "<string>",
    "paginationToken": "<string>"
  }
}

{
  "message": {
    "token": "<string>",
    "text": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": null
      }
    ],
    "textId": "<string>",
    "textParameters": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ]
  },
  "content": {
    "data": null,
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    }
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": null
        }
      ]
    }
  ],
  "errors": [
    {
      "field": "<string>",
      "reasonText": "<string>",
      "reasonId": "<string>",
      "reasonParameters": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "metadata": {
    "dateFormat": "<string>",
    "dateTimeFormat": "<string>",
    "paginationToken": "<string>"
  }
}