createInvoice

MUTATION

Creates an invoice.

Arguments

inputRequired

InvoiceInput

The input object that contains all the information needed to create an invoice.

Response

Invoice

account_code

String| null

A custom value that will be passed on to the transaction when a payment is made through Pay Theory's hosted checkout.

created_date

AWSDateTime| null

The date the invoice was created.

currency

String| null

The currency of the payment that will be used to pay the invoice.

due_by

AWSDate| null

The date that the payor is expected to pay the invoice by.

fee_mode

FeeMode| null

The fee mode that will be used on that transaction when a payment is made through Pay Theory's hosted checkout. It can be one of the following: MERCHANT_FEE, SERVICE_FEE.

Values

CUSTOM_FEEINTERCHANGEMERCHANT_FEESERVICE_FEE

invoice_amount

Int| null

The total amount of the invoice.

invoice_date

AWSDate| null

The initial date for the Invoice.

invoice_description

String| null

A brief description of the invoice. This will show up on the hosted checkout page and any email communications about the Invoice.

invoice_id

String| null

The Pay Theory unique identifier for the invoice.

invoice_name

String| null

The name of the invoice. This will show up on the hosted checkout page and any email communications about the Invoice.

merchant_invoice_number

String| null

A custom value that can be used to tie the Pay Theory Invoice to a merchant's internal invoice number.

merchant_uid

String| null

The Pay Theory unique identifier for the merchant that the invoice belongs to.

metadata

AWSJSON| null

A JSON object that can be used to store custom data about the invoice.

offline_transactions

[OfflineTransaction]| null

A list of offline transactions that have been applied to the invoice. This is used to track payments that are made outside Pay Theory toward an Invoice.

payor

Payor| null

The payor object for the payor that the invoice belongs to. More information on the payor object can be found here.

reference

String| null

A custom value that will be passed on to the transaction when a payment is made through Pay Theory's hosted checkout.

settings

InvoiceSettings| null

The settings object to configure settings for the Pay Theory hosted checkout page.

status

InvoiceStatus| null

The status of the invoice. It can be one of the following: NOT_PAID, PAID, PARTIALLY_PAID For the time being this will not be used as we do not yet support partial payments for Invoices.

Values

NOT_PAIDPARTIALLY_PAIDPAID

total_paid_amount

Int| null

The total amount that has been paid toward the invoice.

Examples

Create an invoice with metadata

Creates a $25.00 invoice and a new payor in one call. Send metadata as a JSON string.

SUCCESS 200

GRAPHQL

mutation CreateInvoice($input: InvoiceInput!) {
  createInvoice(input: $input) {
    invoice_id
    merchant_uid
    invoice_name
    invoice_description
    invoice_amount
    total_paid_amount
    currency
    status
    fee_mode
    due_by
    invoice_date
    merchant_invoice_number
    account_code
    reference
    created_date
    settings {
      is_secure
      security_pin
      require_payor_address
      accepted_payment_methods { ach card cash }
    }
    payor {
      payor_id
      full_name
      email
      merchant_uid
    }
  }
}