Billing

Partially updates a product charge. Send only the fields you want to change.

Every field is optional and a field left out keeps its value; Description clears with null, and Quantity, UnitPrice, UnitCost and BillableStatusId are not clearable. What it is charged to and the item cannot change - remove the charge and add another. Re-sending values the charge already holds changes nothing. Returns the charge in the GET /v1/product-charges/{productChargeId} shape.

Refused with 409, as the app hides Edit, while the ticket is closed, the task’s project is closed, or the charge is waiting to be invoiced or has been invoiced.

PATCH

product-charges

{productChargeId}

Partially updates a product charge. Send only the fields you want to change.

curl --request PATCH \
  --url https://api.usw.gorelo.io/v1/product-charges/{productChargeId} \
  --header 'Content-Type: application/json-patch+json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "Quantity": 3,
  "UnitPrice": 179,
  "UnitCost": 142.5,
  "Description": "<string>",
  "BillableStatusId": 2
}
'

import requests

url = "https://api.usw.gorelo.io/v1/product-charges/{productChargeId}"

payload = {
    "Quantity": 3,
    "UnitPrice": 179,
    "UnitCost": 142.5,
    "Description": "<string>",
    "BillableStatusId": 2
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    Quantity: 3,
    UnitPrice: 179,
    UnitCost: 142.5,
    Description: '<string>',
    BillableStatusId: 2
  })
};

fetch('https://api.usw.gorelo.io/v1/product-charges/{productChargeId}', 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.usw.gorelo.io/v1/product-charges/{productChargeId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'Quantity' => 3,
    'UnitPrice' => 179,
    'UnitCost' => 142.5,
    'Description' => '<string>',
    'BillableStatusId' => 2
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json-patch+json",
    "X-API-Key: <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.usw.gorelo.io/v1/product-charges/{productChargeId}"

	payload := strings.NewReader("{\n  \"Quantity\": 3,\n  \"UnitPrice\": 179,\n  \"UnitCost\": 142.5,\n  \"Description\": \"<string>\",\n  \"BillableStatusId\": 2\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.usw.gorelo.io/v1/product-charges/{productChargeId}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"Quantity\": 3,\n  \"UnitPrice\": 179,\n  \"UnitCost\": 142.5,\n  \"Description\": \"<string>\",\n  \"BillableStatusId\": 2\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usw.gorelo.io/v1/product-charges/{productChargeId}")

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

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"Quantity\": 3,\n  \"UnitPrice\": 179,\n  \"UnitCost\": 142.5,\n  \"Description\": \"<string>\",\n  \"BillableStatusId\": 2\n}"

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

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": {
    "Id": 91524,
    "TicketId": "08dd8170-f413-959c-82ae-152d5f340000",
    "TaskId": "08dd8170-f413-959c-82ae-152d5f340001",
    "ProjectId": "08dd8170-f413-959c-82ae-152d5f340002",
    "ItemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "Name": "USB-C Docking Station",
    "Description": "Replacement dock for the reception desk.",
    "Quantity": 2,
    "UnitPrice": 189,
    "UnitCost": 142.5,
    "Amount": 378,
    "BillableStatus": {
      "Id": 1,
      "Name": "<string>"
    },
    "ClientId": 4983,
    "InvoiceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "CreatedOn": "2023-11-07T05:31:56Z",
    "UpdatedOn": "2023-11-07T05:31:56Z"
  },
  "DataContext": null,
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

Autorizações

X-API-Key

string

header

obrigatório

Your Gorelo API key. See Generate API key. If your data is hosted in Australia, click the base URL at the top of this page and select https://api.aue.gorelo.io.

Parâmetros de caminho

productChargeId

integer<int64>

obrigatório

Product charge to update.

Corpo

Fields to change.

Partial update of a product charge. Every field is optional and a field left out keeps its value. What it is charged to and the item cannot change: a body carrying TicketId, TaskId or ItemId is rejected as malformed, like any unknown field.

Quantity

number<double> | null

Quantity to charge; greater than 0 and at most 99,999,999. Not clearable: null leaves it alone.

Exemplo:

3

UnitPrice

number<double> | null

Price of one unit, -99,999,999 to 99,999,999. Not clearable: null leaves it alone.

Exemplo:

179

UnitCost

number<double> | null

Cost of one unit, 0 to 99,999,999. Not clearable: null leaves it alone.

Exemplo:

142.5

Description

string | null

Description shown for the product. Send null to clear it; leave it out to keep it.

BillableStatusId

integer<int32> | null

1 Billable, 2 No charge, 3 Non-billable or 5 Void. Not clearable: null leaves it alone.

Exemplo:

2

Resposta

StatusCode

enum<integer>

Opções disponíveis:

100,

101,

102,

103,

200,

201,

202,

203,

204,

205,

206,

207,

208,

226,

300,

301,

302,

303,

304,

305,

306,

307,

308,

400,

401,

402,

403,

404,

405,

406,

407,

408,

409,

410,

411,

412,

413,

414,

415,

416,

417,

421,

422,

423,

424,

426,

428,

429,

431,

451,

500,

501,

502,

503,

504,

505,

506,

507,

508,

510,

511

IsSuccess

boolean

Data

object

A catalog item charged to a ticket or to a project task: a row on the ticket's or the task's Products tab, billed with that ticket's or project's other charges. The shape GET /v1/product-charges, GET /v1/product-charges/{productChargeId} and PATCH return. Exactly one of TicketId and TaskId is set.

Show child attributes

DataContext

object | null

Exemplo:

null

Notifications

object[]

Show child attributes

⌘I

Partially updates a product charge. Send only the fields you want to change.

curl --request PATCH \
  --url https://api.usw.gorelo.io/v1/product-charges/{productChargeId} \
  --header 'Content-Type: application/json-patch+json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "Quantity": 3,
  "UnitPrice": 179,
  "UnitCost": 142.5,
  "Description": "<string>",
  "BillableStatusId": 2
}
'

import requests

url = "https://api.usw.gorelo.io/v1/product-charges/{productChargeId}"

payload = {
    "Quantity": 3,
    "UnitPrice": 179,
    "UnitCost": 142.5,
    "Description": "<string>",
    "BillableStatusId": 2
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    Quantity: 3,
    UnitPrice: 179,
    UnitCost: 142.5,
    Description: '<string>',
    BillableStatusId: 2
  })
};

fetch('https://api.usw.gorelo.io/v1/product-charges/{productChargeId}', 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.usw.gorelo.io/v1/product-charges/{productChargeId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'Quantity' => 3,
    'UnitPrice' => 179,
    'UnitCost' => 142.5,
    'Description' => '<string>',
    'BillableStatusId' => 2
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json-patch+json",
    "X-API-Key: <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.usw.gorelo.io/v1/product-charges/{productChargeId}"

	payload := strings.NewReader("{\n  \"Quantity\": 3,\n  \"UnitPrice\": 179,\n  \"UnitCost\": 142.5,\n  \"Description\": \"<string>\",\n  \"BillableStatusId\": 2\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.usw.gorelo.io/v1/product-charges/{productChargeId}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"Quantity\": 3,\n  \"UnitPrice\": 179,\n  \"UnitCost\": 142.5,\n  \"Description\": \"<string>\",\n  \"BillableStatusId\": 2\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usw.gorelo.io/v1/product-charges/{productChargeId}")

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

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"Quantity\": 3,\n  \"UnitPrice\": 179,\n  \"UnitCost\": 142.5,\n  \"Description\": \"<string>\",\n  \"BillableStatusId\": 2\n}"

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

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": {
    "Id": 91524,
    "TicketId": "08dd8170-f413-959c-82ae-152d5f340000",
    "TaskId": "08dd8170-f413-959c-82ae-152d5f340001",
    "ProjectId": "08dd8170-f413-959c-82ae-152d5f340002",
    "ItemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "Name": "USB-C Docking Station",
    "Description": "Replacement dock for the reception desk.",
    "Quantity": 2,
    "UnitPrice": 189,
    "UnitCost": 142.5,
    "Amount": 378,
    "BillableStatus": {
      "Id": 1,
      "Name": "<string>"
    },
    "ClientId": 4983,
    "InvoiceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "CreatedOn": "2023-11-07T05:31:56Z",
    "UpdatedOn": "2023-11-07T05:31:56Z"
  },
  "DataContext": null,
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}