Skip to main content
POST
/
v1
/
contracts
/
scheduleProServicesInvoice
Schedule ProService invoice
curl --request POST \
  --url https://api.metronome.com/v1/contracts/scheduleProServicesInvoice \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contract_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "issued_at": "2023-11-07T05:31:56Z",
  "netsuite_invoice_header_start": "2023-11-07T05:31:56Z",
  "netsuite_invoice_header_end": "2023-11-07T05:31:56Z",
  "line_items": [
    {
      "professional_service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amendment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "unit_price": 123,
      "quantity": 123,
      "amount": 123,
      "netsuite_invoice_billing_start": "2023-11-07T05:31:56Z",
      "netsuite_invoice_billing_end": "2023-11-07T05:31:56Z",
      "metadata": "<string>"
    }
  ]
}'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_custom_fields": {},
      "net_payment_terms_days": 123,
      "credit_type": {
        "name": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "line_items": [
        {
          "name": "<string>",
          "quantity": 123,
          "total": 123,
          "unit_price": 123,
          "list_price": {
            "price": 123,
            "use_list_prices": true,
            "tiers": [
              {
                "size": 123,
                "price": 123
              }
            ],
            "pricing_group_values": {},
            "credit_type": {
              "name": "<string>",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          },
          "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "product_custom_fields": {},
          "product_tags": [
            "<string>"
          ],
          "product_type": "<string>",
          "type": "<string>",
          "is_prorated": true,
          "credit_type": {
            "name": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          },
          "starting_at": "2023-11-07T05:31:56Z",
          "ending_before": "2023-11-07T05:31:56Z",
          "commit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "applied_commit_or_credit": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "PREPAID"
          },
          "commit_custom_fields": {},
          "commit_segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "commit_type": "<string>",
          "postpaid_commit": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          },
          "custom_fields": {},
          "pricing_group_values": {},
          "presentation_group_values": {},
          "metadata": "<string>",
          "scheduled_charge_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "scheduled_charge_custom_fields": {},
          "subscription_custom_fields": {},
          "tier": {
            "size": "<string>",
            "level": 123,
            "starting_at": "<string>"
          },
          "discount_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "discount_custom_fields": {}
        }
      ],
      "start_timestamp": "2023-11-07T05:31:56Z",
      "end_timestamp": "2023-11-07T05:31:56Z",
      "issued_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "status": "DRAFT, VOID, or FINALIZED",
      "total": 123,
      "type": "SCHEDULED or USAGE",
      "external_invoice": {
        "billing_provider_type": "aws_marketplace",
        "invoice_id": "<string>",
        "issued_at_timestamp": "2023-11-07T05:31:56Z",
        "external_status": "DRAFT",
        "pdf_url": "<string>",
        "tax": {
          "total_tax_amount": 123,
          "total_taxable_amount": 123,
          "transaction_id": "<string>"
        },
        "invoiced_total": 123,
        "invoiced_sub_total": 123
      },
      "contract_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "contract_custom_fields": {},
      "amendment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

schedule an invoice for the specified Professional Services terms on a contract

​
customer_id
string<uuid>
required
​
contract_id
string<uuid>
required
​
issued_at
string<date-time>
required

The date the invoice is issued

​
line_items
object[]
required

Each line requires an amount or both unit_price and quantity.

​
netsuite_invoice_header_start
string<date-time>

The start date of the invoice header in Netsuite

​
netsuite_invoice_header_end
string<date-time>

The end date of the invoice header in Netsuite

Response

Success

​
data
object[]
required
⌘I