Revise a draft invoice

PUT

invoices

{id}

curl --request PUT \
  --url https://api-sandbox.paygood.co/invoices/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotencyKey": "idem-inv-revise-01",
  "merchantId": "mer_01hxy8m1nqk9g3x3y3p0azq2bg",
  "currency": "usd",
  "lineItems": [
    {
      "kind": "manual_adjustment",
      "description": "Installation labor",
      "amount": 2500,
      "quantity": 3
    }
  ],
  "changeReason": "Labor hours increased"
}
'

import requests

url = "https://api-sandbox.paygood.co/invoices/{id}"

payload = {
    "idempotencyKey": "idem-inv-revise-01",
    "merchantId": "mer_01hxy8m1nqk9g3x3y3p0azq2bg",
    "currency": "usd",
    "lineItems": [
        {
            "kind": "manual_adjustment",
            "description": "Installation labor",
            "amount": 2500,
            "quantity": 3
        }
    ],
    "changeReason": "Labor hours increased"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    idempotencyKey: 'idem-inv-revise-01',
    merchantId: 'mer_01hxy8m1nqk9g3x3y3p0azq2bg',
    currency: 'usd',
    lineItems: [
      {
        kind: 'manual_adjustment',
        description: 'Installation labor',
        amount: 2500,
        quantity: 3
      }
    ],
    changeReason: 'Labor hours increased'
  })
};

fetch('https://api-sandbox.paygood.co/invoices/{id}', 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.paygood.co/invoices/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'idempotencyKey' => 'idem-inv-revise-01',
    'merchantId' => 'mer_01hxy8m1nqk9g3x3y3p0azq2bg',
    'currency' => 'usd',
    'lineItems' => [
        [
                'kind' => 'manual_adjustment',
                'description' => 'Installation labor',
                'amount' => 2500,
                'quantity' => 3
        ]
    ],
    'changeReason' => 'Labor hours increased'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.paygood.co/invoices/{id}"

	payload := strings.NewReader("{\n  \"idempotencyKey\": \"idem-inv-revise-01\",\n  \"merchantId\": \"mer_01hxy8m1nqk9g3x3y3p0azq2bg\",\n  \"currency\": \"usd\",\n  \"lineItems\": [\n    {\n      \"kind\": \"manual_adjustment\",\n      \"description\": \"Installation labor\",\n      \"amount\": 2500,\n      \"quantity\": 3\n    }\n  ],\n  \"changeReason\": \"Labor hours increased\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.put("https://api-sandbox.paygood.co/invoices/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"idempotencyKey\": \"idem-inv-revise-01\",\n  \"merchantId\": \"mer_01hxy8m1nqk9g3x3y3p0azq2bg\",\n  \"currency\": \"usd\",\n  \"lineItems\": [\n    {\n      \"kind\": \"manual_adjustment\",\n      \"description\": \"Installation labor\",\n      \"amount\": 2500,\n      \"quantity\": 3\n    }\n  ],\n  \"changeReason\": \"Labor hours increased\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.paygood.co/invoices/{id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"idempotencyKey\": \"idem-inv-revise-01\",\n  \"merchantId\": \"mer_01hxy8m1nqk9g3x3y3p0azq2bg\",\n  \"currency\": \"usd\",\n  \"lineItems\": [\n    {\n      \"kind\": \"manual_adjustment\",\n      \"description\": \"Installation labor\",\n      \"amount\": 2500,\n      \"quantity\": 3\n    }\n  ],\n  \"changeReason\": \"Labor hours increased\"\n}"

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

{
  "invoiceId": "<string>",
  "invoiceNumber": "<string>",
  "invoiceUrlSlug": "<string>",
  "idempotencyKey": "<string>",
  "merchantId": "<string>",
  "customerId": "<string>",
  "currentRevisionNumber": 4503599627370495,
  "currency": "<string>",
  "lineItems": [
    {
      "kind": "product_charge",
      "productId": "<string>",
      "description": "<string>",
      "quantity": 4503599627370495,
      "unitAmount": 4503599627370495,
      "lineTotal": 0,
      "priceId": "<string>"
    }
  ],
  "productTotal": {
    "amount": 4503599627370495,
    "currency": "<string>"
  },
  "total": {
    "amount": 4503599627370495,
    "currency": "<string>"
  },
  "amountPaid": {
    "amount": 4503599627370495,
    "currency": "<string>"
  },
  "amountRemaining": {
    "amount": 4503599627370495,
    "currency": "<string>"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "dueDate": "2023-11-07T05:31:56Z",
  "paidAt": "2023-11-07T05:31:56Z",
  "notes": "<string>",
  "metadata": {}
}

Authorizations

Authorization

string

header

required

Merchant API key bearer token. Legacy wire prefixes api_key_ and api_ are also accepted.

Path Parameters

string

required

Invoice TypeID (inv_...) to revise.

Example:

"inv_01hxy8m1nqk9g3x3y3p0azq2va"

Body

application/json

Revision payload with idempotency key, merchant scope, and full replacement line-item snapshot.

idempotencyKey

string

required

Minimum string length: 1

merchantId

string

required

currency

string

required

Supported currency code (USD, CAD)

Required string length: 3

lineItems

object[]

required

Minimum array length: 1

Option 1
Option 2

Show child attributes

dueDate

string<date-time>

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

notes

string

Maximum string length: 2000

metadata

object

Show child attributes

changeReason

string

Maximum string length: 1000

Response

Invoice revised successfully; response includes incremented currentRevisionNumber and unchanged invoiceUrlSlug.

invoiceId

string

required

invoiceNumber

string

required

Minimum string length: 1

invoiceUrlSlug

string

required

Secret pay-link token. Anyone holding this value can view and pay the invoice anonymously, so treat it like a credential: safe to send to the customer, never safe to log or expose publicly. Unguessable and unrelated to invoiceId, so it can be rotated without changing the invoice.

Minimum string length: 1

idempotencyKey

string

required

Minimum string length: 1

merchantId

string

required

customerId

string

required

currentRevisionNumber

integer

required

Required range: 0 < x <= 9007199254740991

status

enum<string>

required

Available options:

draft,

issued,

partially_paid,

paid,

void

currency

string

required

Supported currency code (USD, CAD)

Required string length: 3

lineItems

object[]

required

Option 1
Option 2

Show child attributes

productTotal

object

required

Show child attributes

total

object

required

Show child attributes

amountPaid

object

required

Sum of applied payment allocations, both processed and out-of-band.

Show child attributes

amountRemaining

object

required

Computed as total minus amountPaid. Zero when the invoice is fully paid.

Show child attributes

createdAt

string<date-time>

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

updatedAt

string<date-time>

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

dueDate

string<date-time>

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

paidAt

string<date-time>

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

notes

string

metadata

object

Show child attributes

Revise a draft invoice

curl --request PUT \
  --url https://api-sandbox.paygood.co/invoices/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotencyKey": "idem-inv-revise-01",
  "merchantId": "mer_01hxy8m1nqk9g3x3y3p0azq2bg",
  "currency": "usd",
  "lineItems": [
    {
      "kind": "manual_adjustment",
      "description": "Installation labor",
      "amount": 2500,
      "quantity": 3
    }
  ],
  "changeReason": "Labor hours increased"
}
'

import requests

url = "https://api-sandbox.paygood.co/invoices/{id}"

payload = {
    "idempotencyKey": "idem-inv-revise-01",
    "merchantId": "mer_01hxy8m1nqk9g3x3y3p0azq2bg",
    "currency": "usd",
    "lineItems": [
        {
            "kind": "manual_adjustment",
            "description": "Installation labor",
            "amount": 2500,
            "quantity": 3
        }
    ],
    "changeReason": "Labor hours increased"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    idempotencyKey: 'idem-inv-revise-01',
    merchantId: 'mer_01hxy8m1nqk9g3x3y3p0azq2bg',
    currency: 'usd',
    lineItems: [
      {
        kind: 'manual_adjustment',
        description: 'Installation labor',
        amount: 2500,
        quantity: 3
      }
    ],
    changeReason: 'Labor hours increased'
  })
};

fetch('https://api-sandbox.paygood.co/invoices/{id}', 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.paygood.co/invoices/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'idempotencyKey' => 'idem-inv-revise-01',
    'merchantId' => 'mer_01hxy8m1nqk9g3x3y3p0azq2bg',
    'currency' => 'usd',
    'lineItems' => [
        [
                'kind' => 'manual_adjustment',
                'description' => 'Installation labor',
                'amount' => 2500,
                'quantity' => 3
        ]
    ],
    'changeReason' => 'Labor hours increased'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.paygood.co/invoices/{id}"

	payload := strings.NewReader("{\n  \"idempotencyKey\": \"idem-inv-revise-01\",\n  \"merchantId\": \"mer_01hxy8m1nqk9g3x3y3p0azq2bg\",\n  \"currency\": \"usd\",\n  \"lineItems\": [\n    {\n      \"kind\": \"manual_adjustment\",\n      \"description\": \"Installation labor\",\n      \"amount\": 2500,\n      \"quantity\": 3\n    }\n  ],\n  \"changeReason\": \"Labor hours increased\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.put("https://api-sandbox.paygood.co/invoices/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"idempotencyKey\": \"idem-inv-revise-01\",\n  \"merchantId\": \"mer_01hxy8m1nqk9g3x3y3p0azq2bg\",\n  \"currency\": \"usd\",\n  \"lineItems\": [\n    {\n      \"kind\": \"manual_adjustment\",\n      \"description\": \"Installation labor\",\n      \"amount\": 2500,\n      \"quantity\": 3\n    }\n  ],\n  \"changeReason\": \"Labor hours increased\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.paygood.co/invoices/{id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"idempotencyKey\": \"idem-inv-revise-01\",\n  \"merchantId\": \"mer_01hxy8m1nqk9g3x3y3p0azq2bg\",\n  \"currency\": \"usd\",\n  \"lineItems\": [\n    {\n      \"kind\": \"manual_adjustment\",\n      \"description\": \"Installation labor\",\n      \"amount\": 2500,\n      \"quantity\": 3\n    }\n  ],\n  \"changeReason\": \"Labor hours increased\"\n}"

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

{
  "invoiceId": "<string>",
  "invoiceNumber": "<string>",
  "invoiceUrlSlug": "<string>",
  "idempotencyKey": "<string>",
  "merchantId": "<string>",
  "customerId": "<string>",
  "currentRevisionNumber": 4503599627370495,
  "currency": "<string>",
  "lineItems": [
    {
      "kind": "product_charge",
      "productId": "<string>",
      "description": "<string>",
      "quantity": 4503599627370495,
      "unitAmount": 4503599627370495,
      "lineTotal": 0,
      "priceId": "<string>"
    }
  ],
  "productTotal": {
    "amount": 4503599627370495,
    "currency": "<string>"
  },
  "total": {
    "amount": 4503599627370495,
    "currency": "<string>"
  },
  "amountPaid": {
    "amount": 4503599627370495,
    "currency": "<string>"
  },
  "amountRemaining": {
    "amount": 4503599627370495,
    "currency": "<string>"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "dueDate": "2023-11-07T05:31:56Z",
  "paidAt": "2023-11-07T05:31:56Z",
  "notes": "<string>",
  "metadata": {}
}