• Products
  • Offerings
  • PricingPlans
  • Invoices
  • InvoiceGroups
  • Orders
  • Quotes
  • Entitlements
Platform
Commerce / Reference / REST API

InvoiceGroups

Postman Collection
OpenAPI

An invoice group is a container that allows you to manage invoices.

GET

Get invoice group by ID

Retrieve invoice group by id

Rate limit: 3000 requests per minute.

Request

Path parameters

id

string

Required

Header parameters

X-transaction-account

string

Required

Responses

OK

application/json

InvoiceGroupPublicDto
GET/v2/invoice-groups/{id}
1 2 3 curl --request GET \ --url 'https://api.atlassian.com/commerce/api/v2/invoice-groups/{id}' \ --header 'Accept: application/json'
200Response
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 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 { "id": "<string>", "version": 2154, "name": "<string>", "slug": "<string>", "currency": "USD", "shipToParty": { "id": "<string>", "version": 2154, "name": "<string>", "postalAddress": { "line1": "<string>", "line2": "<string>", "city": "<string>", "country": "<string>", "state": "<string>", "phone": "<string>", "postcode": "<string>" }, "priceEligibility": {}, "taxId": "<string>", "taxIds": [ { "id": "<string>", "label": "<string>", "taxIdLabel": "<string>", "taxIdDescription": "<string>", "metadata": {} } ], "createdAt": 31, "updatedAt": 31 }, "billToParty": { "name": "<string>", "taxId": "<string>", "taxIds": [ { "id": "<string>", "label": "<string>", "taxIdLabel": "<string>", "taxIdDescription": "<string>", "metadata": {} } ], "postalAddress": { "line1": "<string>", "line2": "<string>", "city": "<string>", "country": "<string>", "state": "<string>", "phone": "<string>", "postcode": "<string>" }, "priceEligibility": {} }, "defaultPaymentMethod": "<string>", "purchaseOrder": { "number": "<string>", "oneTimeUse": true }, "active": true, "memo": "<string>", "createdAt": 31, "updatedAt": 31, "recipients": [ "<string>" ] }
GET

Get invoice groups for a transaction account ID

Get the n invoice groups of the transaction account

Rate limit: 600 requests per minute.

Request

Query parameters

page-size

integer

start-id

string

Header parameters

X-transaction-account

string

Required

Responses

OK

application/json

PagedListV2InvoiceGroupPublicDto
GET/v2/invoice-groups
1 2 3 curl --request GET \ --url 'https://api.atlassian.com/commerce/api/v2/invoice-groups' \ --header 'Accept: application/json'
200Response
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 37 38 39 40 41 42 43 44 45 46 47 48 49 50 { "data": [ { "id": "<string>", "version": 2154, "name": "<string>", "slug": "<string>", "currency": "USD", "shipToParty": { "id": "<string>", "version": 2154, "name": "<string>", "postalAddress": { "country": "<string>" }, "priceEligibility": {}, "taxId": "<string>", "taxIds": [ {} ], "createdAt": 31, "updatedAt": 31 }, "billToParty": { "name": "<string>", "taxId": "<string>", "taxIds": [ {} ], "postalAddress": { "country": "<string>" }, "priceEligibility": {} }, "defaultPaymentMethod": "<string>", "purchaseOrder": { "number": "<string>", "oneTimeUse": true }, "active": true, "memo": "<string>", "createdAt": 31, "updatedAt": 31, "recipients": [ "<string>" ] } ], "nextId": "<string>" }

Rate this page: