POST /api/v3/clients/:client-id/regularization.json

Creates a new client’s regularization.

Example Request

curl

curl --request POST \
  --url 'https://account_name.app.invoicexpress.com/api/v3/clients/:client-id/regularization.json?api_key=YOUR%20API%20KEY%20HERE' \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data '{"regularization":{"value":123.45,"date":"2023-08-24"}}'

Ruby

require 'uri'
require 'net/http'

url = URI("https://account_name.app.invoicexpress.com/api/v3/clients/:client-id/regularization.json?api_key=YOUR%20API%20KEY%20HERE")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["accept"] = 'application/json'
request["content-type"] = 'application/json'
request.body = "{\"regularization\":{\"value\":123.45,\"date\":\"2023-08-24\"}}"

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

Node

var http = require("https");

var options = {
  "method": "POST",
  "hostname": "account_name.app.invoicexpress.com",
  "port": null,
  "path": "/api/v3/clients/:client-id/regularization.json?api_key=YOUR%20API%20KEY%20HERE",
  "headers": {
    "accept": "application/json",
    "content-type": "application/json"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({ regularization: { value: 123.45, date: '2023-08-24'} }));
req.end();

Python

import http.client

conn = http.client.HTTPSConnection("account_name.app.invoicexpress.com")

payload = "{\"regularization\":{\"value\":123.45,\"date\":\"2023-08-24\"}}"

headers = {
    'accept': "application/json",
    'content-type': "application/json"
    }

conn.request("POST", "/api/v3/clients/:client-id/regularization.json?api_key=YOUR%20API%20KEY%20HERE", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://account_name.app.invoicexpress.com/api/v3/clients/:client-id/regularization.json?api_key=YOUR%20API%20KEY%20HERE",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"regularization\":{\"value\":123.45,\"date\":\"2023-08-24\"}}",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json",
    "content-type: application/json"
  ),
));

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

curl_close($curl);

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

Go

package main

import (
    "fmt"
    "strings"
    "net/http"
    "io/ioutil"
)

func main() {

    url := "https://account_name.app.invoicexpress.com/api/v3/clients/:client-id/regularization.json?api_key=YOUR%20API%20KEY%20HERE"

    payload := strings.NewReader("{\"regularization\":{\"value\":123.45,\"date\":\"2023-08-24\"}}")

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

    req.Header.Add("accept", "application/json")
    req.Header.Add("content-type", "application/json")

    res, _ := http.DefaultClient.Do(req)

    defer res.Body.Close()
    body, _ := ioutil.ReadAll(res.Body)

    fmt.Println(res)
    fmt.Println(string(body))

}

Path Parameters

Name	Type	Required	Description	Example
client-id	Integer	Required	The ID of the client you want to create regularization.	42

Request Body

Name	Type	Required	Description
regularization	Object	Required	Account data to be created
value	Number	Required	Regularization value
date	String	Required	Regularization date
observation	String		So if necessary

Example Request Body

{
  "regularization": {
    "value": 123.45,
    "date": "2023-08-24"
  }
}

Responses

201	SUCCESS	Accounts Create response
401	ACCESS DENIED The API Key parameter is missing or is incorrectly entered.	(Empty Response)
404	NOT FOUND No client matches the supplied client-id.	(Empty Response)
422	UNPROCESSABLE ENTITY Some parameters were incorrect.	(Empty Response)

Example Success Body Response

{
    "regularization": [
        {
            "id": 1,
            "number": "NR00000001",
            "value": 123.45,
            "date": "2023-08-24",
            "observation": null
        }
    ],
    "pagination": {
        "total_entries": 1,
        "current_page": 1,
        "total_pages": 1,
        "per_page": 10
    }
}