List invoices

List all the invoices created under a Moov account.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/invoices.read scope.

GET
/accounts/{accountID}/invoices
cURL Ruby Java TypeScript Python PHP
1
2
curl -X GET "https://api.moov.io/accounts/{accountID}/invoices" \
  -H "Authorization: Bearer {token}" \
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
require 'moov_ruby'

Models = ::Moov::Models
s = ::Moov::Client.new(
      x_moov_version: '<value>',
    )

req = Models::Operations::ListInvoicesRequest.new(
  skip: 60,
  count: 20,
  account_id: '114b02db-e4ca-47de-acc9-5624f4afccb5',
)

res = s.invoices.list_invoices(request: req)

unless res.invoices.nil?
  # handle response
end
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
package hello.world;

import java.lang.Exception;
import org.openapis.openapi.Moov;
import org.openapis.openapi.models.components.Security;
import org.openapis.openapi.models.errors.ListInvoicesValidationError;
import org.openapis.openapi.models.operations.ListInvoicesRequest;
import org.openapis.openapi.models.operations.ListInvoicesResponse;

public class Application {

    public static void main(String[] args) throws ListInvoicesValidationError, Exception {

        Moov sdk = Moov.builder()
                .xMoovVersion("<value>")
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        ListInvoicesRequest req = ListInvoicesRequest.builder()
                .accountID("114b02db-e4ca-47de-acc9-5624f4afccb5")
                .skip(60L)
                .count(20L)
                .build();

        ListInvoicesResponse res = sdk.invoices().listInvoices()
                .request(req)
                .call();

        if (res.invoices().isPresent()) {
            // handle response
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
import { Moov } from "@moovio/sdk";

const moov = new Moov({
  xMoovVersion: "<value>",
  security: {
    username: "",
    password: "",
  },
});

async function run() {
  const result = await moov.invoices.listInvoices({
    skip: 60,
    count: 20,
    accountID: "114b02db-e4ca-47de-acc9-5624f4afccb5",
  });

  console.log(result);
}

run();
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    x_moov_version="<value>",
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.invoices.list_invoices(account_id="114b02db-e4ca-47de-acc9-5624f4afccb5", skip=60, count=20)

    # Handle response
    print(res)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
using Moov.Sdk;
using Moov.Sdk.Models.Requests;

var sdk = new MoovClient(xMoovVersion: "<value>");

ListInvoicesRequest req = new ListInvoicesRequest() {
    Skip = 60,
    Count = 20,
    AccountID = "114b02db-e4ca-47de-acc9-5624f4afccb5",
};

var res = await sdk.Invoices.ListInvoicesAsync(req);

// handle response
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
declare(strict_types=1);

require 'vendor/autoload.php';

use Moov\MoovPhp;
use Moov\MoovPhp\Models\Components;
use Moov\MoovPhp\Models\Operations;

$sdk = MoovPhp\Moov::builder()
    ->setXMoovVersion('<value>')
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$request = new Operations\ListInvoicesRequest(
    skip: 60,
    count: 20,
    accountID: '114b02db-e4ca-47de-acc9-5624f4afccb5',
);

$response = $sdk->invoices->listInvoices(
    request: $request
);

if ($response->invoices !== null) {
    // handle response
}
200 401 403 422 429 500 504
The request completed successfully.
application/json
[
  {
    "createdOn": "2024-05-06T12:20:38.184Z",
    "customerAccountID": "3dfff852-927d-47e8-822c-2fffc57ff6b9",
    "description": "Professional services for Q1 2026",
    "disputedAmount": {
      "currency": "USD",
      "valueDecimal": "0.00"
    },
    "dueDate": "2026-02-15T00:00:00Z",
    "invoiceDate": "2026-01-15T00:00:00Z",
    "invoiceID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
    "invoiceNumber": "INV-1001",
    "lineItems": {
      "items": [
        {
          "basePrice": {
            "currency": "USD",
            "valueDecimal": "1000.00"
          },
          "name": "Professional Services",
          "quantity": 1
        }
      ]
    },
    "paidAmount": {
      "currency": "USD",
      "valueDecimal": "0.00"
    },
    "partnerAccountID": "5dfff852-927d-47e8-822c-2fffc57ff6b8",
    "pendingAmount": {
      "currency": "USD",
      "valueDecimal": "0.00"
    },
    "refundedAmount": {
      "currency": "USD",
      "valueDecimal": "0.00"
    },
    "status": "unpaid",
    "subtotalAmount": {
      "currency": "USD",
      "valueDecimal": "1000.00"
    },
    "taxAmount": {
      "currency": "USD",
      "valueDecimal": "80.00"
    },
    "totalAmount": {
      "currency": "USD",
      "valueDecimal": "1080.00"
    }
  },
  {
    "createdOn": "2024-05-06T12:20:38.184Z",
    "customerAccountID": "3dfff852-927d-47e8-822c-2fffc57ff6b9",
    "description": "Professional services for Q1 2026",
    "disputedAmount": {
      "currency": "USD",
      "valueDecimal": "0.00"
    },
    "dueDate": "2026-02-15T00:00:00Z",
    "invoiceDate": "2026-01-15T00:00:00Z",
    "invoiceID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
    "invoiceNumber": "INV-1001",
    "invoicePayments": [
      {
        "amount": {
          "currency": "USD",
          "valueDecimal": "1080.00"
        },
        "invoicePaymentID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "invoicePaymentType": "transfer",
        "transfer": {
          "transferID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43"
        }
      }
    ],
    "lineItems": {
      "items": [
        {
          "basePrice": {
            "currency": "USD",
            "valueDecimal": "1000.00"
          },
          "name": "Professional Services",
          "quantity": 1
        }
      ]
    },
    "paidAmount": {
      "currency": "USD",
      "valueDecimal": "1080.00"
    },
    "paidOn": "2026-01-20T14:45:00Z",
    "partnerAccountID": "5dfff852-927d-47e8-822c-2fffc57ff6b8",
    "pendingAmount": {
      "currency": "USD",
      "valueDecimal": "0.00"
    },
    "refundedAmount": {
      "currency": "USD",
      "valueDecimal": "0.00"
    },
    "sentOn": "2026-01-15T10:30:00Z",
    "status": "paid",
    "subtotalAmount": {
      "currency": "USD",
      "valueDecimal": "1000.00"
    },
    "taxAmount": {
      "currency": "USD",
      "valueDecimal": "80.00"
    },
    "totalAmount": {
      "currency": "USD",
      "valueDecimal": "1080.00"
    }
  }
]

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request contained missing or expired authentication.

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The user is not authorized to make the request.

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request was well-formed, but the contents failed validation. Check the request for missing or invalid fields.
application/json
{
  "status": "string",
  "customerAccountID": "string",
  "createdStartDateTime": "string",
  "createdEndDateTime": "string",
  "dueStartDateTime": "string",
  "dueEndDateTime": "string",
  "skip": "string",
  "count": "string"
}

x-request-id

string <uuid> required
A unique identifier used to trace requests.
Request was refused due to rate limiting.

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed due to an unexpected error.

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed because a downstream service failed to respond.

x-request-id

string <uuid> required
A unique identifier used to trace requests.

Headers

X-Moov-Version

string

Specify an API version.

API versioning follows the format vYYYY.QQ.BB, where

  • YYYY is the year
  • QQ is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
  • BB is the build number, starting at .01, for subsequent builds in the same quarter.
    • For example, v2024.01.00 is the initial release of the first quarter of 2024.

The latest version represents the most recent development state. It may include breaking changes and should be treated as a beta release. When no version is specified, the API defaults to v2024.01.00.

Path parameters

accountID

string <uuid> required

Query parameters

skip

integer <int64>

count

integer <int64>
Default: 200

status

string
Possible values: draft, unpaid, payment-pending, paid, overdue, canceled

customerAccountID

string

createdStartDateTime

string <date-time>

createdEndDateTime

string <date-time>

dueStartDateTime

string <date-time>

dueEndDateTime

string <date-time>

Response

application/json

canceledOn

string<date-time>

createdOn

string<date-time>

customerAccountID

string <=36 characters
A unique identifier for a Moov resource. Supports UUID format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) or typed format with base32-encoded UUID and type suffix (e.g., kuoaydiojf7uszaokc2ggnaaaa_xfer).

description

string

disputedAmount

object
Total amount of disputes initiated against transfers paid towards the invoice
Show child attributes

currency

string required Pattern
A 3-letter ISO 4217 currency code.

valueDecimal

string required Pattern

A decimal-formatted numerical string that represents up to 9 decimal place precision.

For example, $12.987654321 is '12.987654321'.

dueDate

string<date-time>

invoiceDate

string<date-time>

invoiceID

string <=36 characters
A unique identifier for a Moov resource. Supports UUID format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) or typed format with base32-encoded UUID and type suffix (e.g., kuoaydiojf7uszaokc2ggnaaaa_xfer).

invoiceNumber

string

invoicePayments

array<object>
Payment made towards an invoice, will be either a transfer or an external payment.
Show child attributes

amount

object
Show child attributes

currency

string required Pattern
A 3-letter ISO 4217 currency code.

valueDecimal

string required Pattern

A decimal-formatted numerical string that represents up to 9 decimal place precision.

For example, $12.987654321 is '12.987654321'.

external

object
Show child attributes

description

string

foreignID

string

paymentDate

string<date-time>

invoicePaymentID

string <=36 characters
A unique identifier for a Moov resource. Supports UUID format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) or typed format with base32-encoded UUID and type suffix (e.g., kuoaydiojf7uszaokc2ggnaaaa_xfer).

invoicePaymentType

string<enum>
Possible values: transfer, external

transfer

object
Show child attributes

transferID

string <=36 characters required
A unique identifier for a Moov resource. Supports UUID format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) or typed format with base32-encoded UUID and type suffix (e.g., kuoaydiojf7uszaokc2ggnaaaa_xfer).

lineItems

object
A collection of line items for an invoice.
Show child attributes

items

array<object> required
The list of line items.
Show child attributes

basePrice

object required
The base price of the item before applying option modifiers.
Show child attributes

currency

string required Pattern
A 3-letter ISO 4217 currency code.

valueDecimal

string required Pattern

A decimal-formatted numerical string that represents up to 9 decimal place precision.

For example, $12.987654321 is '12.987654321'.

name

string [1 to 150] characters required
The name of the item.

quantity

integer<int32> required
The quantity of this item.

images

array<object>
Optional list of images associated with this line item.

options

array<object>
Optional list of modifiers applied to this item (e.g., toppings, upgrades, customizations).
Show child attributes

name

string [1 to 150] characters required
The name of the option or modifier.

quantity

integer<int32> required
The quantity of this option.

group

string <=100 characters
Optional group identifier to categorize related options (e.g., 'toppings').

images

array<object>
Optional list of images associated with this line item option.
Show child attributes

altText

string <=125 characters
Alternative text for the image.

imageID

string <=36 characters
A unique identifier for a Moov resource. Supports UUID format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) or typed format with base32-encoded UUID and type suffix (e.g., kuoaydiojf7uszaokc2ggnaaaa_xfer).

link

string<uri>
The image's public URL.

publicID

string Pattern
A unique identifier for an image, used in public image links.

priceModifier

object
Optional price modification applied by this option. Can be positive, negative, or zero.
Show child attributes

currency

string required Pattern
A 3-letter ISO 4217 currency code.

valueDecimal

string required Pattern

A decimal-formatted numerical string that represents up to 9 decimal place precision.

For example, $12.987654321 is '12.987654321'.

productID

string
Optional unique identifier associating the line item with a product.
A unique identifier for a Moov resource. Supports UUID format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) or typed format with base32-encoded UUID and type suffix (e.g., kuoaydiojf7uszaokc2ggnaaaa_xfer).

paidAmount

object
Total amount of completed transfers paid towards the invoice
Show child attributes

currency

string required Pattern
A 3-letter ISO 4217 currency code.

valueDecimal

string required Pattern

A decimal-formatted numerical string that represents up to 9 decimal place precision.

For example, $12.987654321 is '12.987654321'.

paidOn

string<date-time>

partnerAccountID

string <=36 characters
A unique identifier for a Moov resource. Supports UUID format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) or typed format with base32-encoded UUID and type suffix (e.g., kuoaydiojf7uszaokc2ggnaaaa_xfer).

paymentLinkCode

string

pendingAmount

object
Total amount of pending transfers paid towards the invoice
Show child attributes

currency

string required Pattern
A 3-letter ISO 4217 currency code.

valueDecimal

string required Pattern

A decimal-formatted numerical string that represents up to 9 decimal place precision.

For example, $12.987654321 is '12.987654321'.

refundedAmount

object
Total amount of refunds initiated against transfers paid towards the invoice
Show child attributes

currency

string required Pattern
A 3-letter ISO 4217 currency code.

valueDecimal

string required Pattern

A decimal-formatted numerical string that represents up to 9 decimal place precision.

For example, $12.987654321 is '12.987654321'.

sentOn

string<date-time>

status

string<enum>
Possible values: draft, unpaid, payment-pending, paid, overdue, canceled

subtotalAmount

object
Show child attributes

currency

string required Pattern
A 3-letter ISO 4217 currency code.

valueDecimal

string required Pattern

A decimal-formatted numerical string that represents up to 9 decimal place precision.

For example, $12.987654321 is '12.987654321'.

taxAmount

object
Show child attributes

currency

string required Pattern
A 3-letter ISO 4217 currency code.

valueDecimal

string required Pattern

A decimal-formatted numerical string that represents up to 9 decimal place precision.

For example, $12.987654321 is '12.987654321'.

totalAmount

object
Total amount of the invoice, sum of subTotalAmount and taxAmount
Show child attributes

currency

string required Pattern
A 3-letter ISO 4217 currency code.

valueDecimal

string required Pattern

A decimal-formatted numerical string that represents up to 9 decimal place precision.

For example, $12.987654321 is '12.987654321'.