Billing

Charges a catalog item to a ticket or to a project task.

Required: exactly one of TicketId and TaskId, ItemId (a product or bundle from GET /v1/items) and Quantity.

Optional:UnitPrice, UnitCost and Description fall back to the item’s own; BillableStatusId defaults to 1 (Billable). The product is billed to the ticket’s client, or the task’s project’s client, and appears on the ticket’s or task’s timeline.

Refused with 409, as the app disables Add Product: on a ticket that is closed, has no client or whose client is on credit hold; on a task whose project is closed or has no client. Clear the condition and the same request succeeds. A ticket or task that does not exist, or belongs to another service provider, is a 404. An item that is not an active product or bundle of the service provider, catalog-wide or scoped to the charge’s client, is a 400 on ItemId.

The response is just the new charge’s Id, the shape Create Time Entry returns.

POST

product-charges

Charges a catalog item to a ticket or to a project task.

curl --request POST \
  --url https://api.usw.gorelo.io/v1/product-charges \
  --header 'Content-Type: application/json-patch+json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "TicketId": "08dd8170-f413-959c-82ae-152d5f340000",
  "TaskId": "08dd8170-f413-959c-82ae-152d5f340001",
  "ItemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "Quantity": 2,
  "UnitPrice": 189,
  "UnitCost": 142.5,
  "Description": "<string>",
  "BillableStatusId": 1
}
'

import requests

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

payload = {
    "TicketId": "08dd8170-f413-959c-82ae-152d5f340000",
    "TaskId": "08dd8170-f413-959c-82ae-152d5f340001",
    "ItemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "Quantity": 2,
    "UnitPrice": 189,
    "UnitCost": 142.5,
    "Description": "<string>",
    "BillableStatusId": 1
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    TicketId: '08dd8170-f413-959c-82ae-152d5f340000',
    TaskId: '08dd8170-f413-959c-82ae-152d5f340001',
    ItemId: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
    Quantity: 2,
    UnitPrice: 189,
    UnitCost: 142.5,
    Description: '<string>',
    BillableStatusId: 1
  })
};

fetch('https://api.usw.gorelo.io/v1/product-charges', 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",
  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([
    'TicketId' => '08dd8170-f413-959c-82ae-152d5f340000',
    'TaskId' => '08dd8170-f413-959c-82ae-152d5f340001',
    'ItemId' => '3fa85f64-5717-4562-b3fc-2c963f66afa6',
    'Quantity' => 2,
    'UnitPrice' => 189,
    'UnitCost' => 142.5,
    'Description' => '<string>',
    'BillableStatusId' => 1
  ]),
  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"

	payload := strings.NewReader("{\n  \"TicketId\": \"08dd8170-f413-959c-82ae-152d5f340000\",\n  \"TaskId\": \"08dd8170-f413-959c-82ae-152d5f340001\",\n  \"ItemId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"Quantity\": 2,\n  \"UnitPrice\": 189,\n  \"UnitCost\": 142.5,\n  \"Description\": \"<string>\",\n  \"BillableStatusId\": 1\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.usw.gorelo.io/v1/product-charges")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"TicketId\": \"08dd8170-f413-959c-82ae-152d5f340000\",\n  \"TaskId\": \"08dd8170-f413-959c-82ae-152d5f340001\",\n  \"ItemId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"Quantity\": 2,\n  \"UnitPrice\": 189,\n  \"UnitCost\": 142.5,\n  \"Description\": \"<string>\",\n  \"BillableStatusId\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"TicketId\": \"08dd8170-f413-959c-82ae-152d5f340000\",\n  \"TaskId\": \"08dd8170-f413-959c-82ae-152d5f340001\",\n  \"ItemId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"Quantity\": 2,\n  \"UnitPrice\": 189,\n  \"UnitCost\": 142.5,\n  \"Description\": \"<string>\",\n  \"BillableStatusId\": 1\n}"

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

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": {
    "Id": 123
  },
  "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>"
    }
  ]
}

التفويضات

X-API-Key

string

header

مطلوب

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.

الجسم

The product to charge.

A catalog item to charge to a ticket or to a project task.

TicketId

string<uuid> | null

The ticket to charge the product to. Send this or TaskId, not both.

مثال:

"08dd8170-f413-959c-82ae-152d5f340000"

TaskId

string<uuid> | null

The project task to charge the product to. Send this or TicketId, not both.

مثال:

"08dd8170-f413-959c-82ae-152d5f340001"

ItemId

string<uuid>

The catalog item to add - an active product or bundle from GET /v1/items that is catalog-wide or scoped to the charge's client. Required.

مثال:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Quantity

number<double> | null

Quantity to charge. Required; greater than 0 and at most 99,999,999, with up to 4 decimal places.

مثال:

2

UnitPrice

number<double> | null

Price of one unit, -99,999,999 to 99,999,999. Defaults to the item's price.

مثال:

189

UnitCost

number<double> | null

Cost of one unit to the service provider, 0 to 99,999,999. Defaults to the item's current cost.

مثال:

142.5

Description

string | null

Description shown for the product on the ticket or task and the invoice. Defaults to the item's description.

BillableStatusId

integer<int32> | null

1 Billable (default), 2 No charge, 3 Non-billable or 5 Void.

مثال:

1

الاستجابة

StatusCode

enum<integer>

الخيارات المتاحة:

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

Show child attributes

DataContext

object | null

مثال:

null

Notifications

object[]

Show child attributes

⌘I

Charges a catalog item to a ticket or to a project task.

curl --request POST \
  --url https://api.usw.gorelo.io/v1/product-charges \
  --header 'Content-Type: application/json-patch+json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "TicketId": "08dd8170-f413-959c-82ae-152d5f340000",
  "TaskId": "08dd8170-f413-959c-82ae-152d5f340001",
  "ItemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "Quantity": 2,
  "UnitPrice": 189,
  "UnitCost": 142.5,
  "Description": "<string>",
  "BillableStatusId": 1
}
'

import requests

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

payload = {
    "TicketId": "08dd8170-f413-959c-82ae-152d5f340000",
    "TaskId": "08dd8170-f413-959c-82ae-152d5f340001",
    "ItemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "Quantity": 2,
    "UnitPrice": 189,
    "UnitCost": 142.5,
    "Description": "<string>",
    "BillableStatusId": 1
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    TicketId: '08dd8170-f413-959c-82ae-152d5f340000',
    TaskId: '08dd8170-f413-959c-82ae-152d5f340001',
    ItemId: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
    Quantity: 2,
    UnitPrice: 189,
    UnitCost: 142.5,
    Description: '<string>',
    BillableStatusId: 1
  })
};

fetch('https://api.usw.gorelo.io/v1/product-charges', 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",
  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([
    'TicketId' => '08dd8170-f413-959c-82ae-152d5f340000',
    'TaskId' => '08dd8170-f413-959c-82ae-152d5f340001',
    'ItemId' => '3fa85f64-5717-4562-b3fc-2c963f66afa6',
    'Quantity' => 2,
    'UnitPrice' => 189,
    'UnitCost' => 142.5,
    'Description' => '<string>',
    'BillableStatusId' => 1
  ]),
  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"

	payload := strings.NewReader("{\n  \"TicketId\": \"08dd8170-f413-959c-82ae-152d5f340000\",\n  \"TaskId\": \"08dd8170-f413-959c-82ae-152d5f340001\",\n  \"ItemId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"Quantity\": 2,\n  \"UnitPrice\": 189,\n  \"UnitCost\": 142.5,\n  \"Description\": \"<string>\",\n  \"BillableStatusId\": 1\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.usw.gorelo.io/v1/product-charges")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"TicketId\": \"08dd8170-f413-959c-82ae-152d5f340000\",\n  \"TaskId\": \"08dd8170-f413-959c-82ae-152d5f340001\",\n  \"ItemId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"Quantity\": 2,\n  \"UnitPrice\": 189,\n  \"UnitCost\": 142.5,\n  \"Description\": \"<string>\",\n  \"BillableStatusId\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"TicketId\": \"08dd8170-f413-959c-82ae-152d5f340000\",\n  \"TaskId\": \"08dd8170-f413-959c-82ae-152d5f340001\",\n  \"ItemId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"Quantity\": 2,\n  \"UnitPrice\": 189,\n  \"UnitCost\": 142.5,\n  \"Description\": \"<string>\",\n  \"BillableStatusId\": 1\n}"

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

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": {
    "Id": 123
  },
  "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>"
    }
  ]
}