Invoices Try Now

Create Invoice

Request Information

URI Parameters

Name	Description	Type	Additional information

Body Parameters

The request.

AddInvoiceRequest

Name	Description	Type	Additional information
ShipFromAddressId	ship from identifier.	string	Required
ShipToContactId	ship to identifier.	string	Required
BillToContactId	bill to identifier.	string	None.
ExternalOrderNumber		string	Optional - External MarketPlace Order Number
InvoiceDate	the sale date.	date	None.
Currency	the currency.	string	Required
ClientCSR	the client CSR.	string	None.
ClientCSRId	the client CSR identifier.	string	None.
SubscriberCSRId	the subscriber CSR identifier.	string	None.
ReferralTypeId	the referral type identifier.	string	None.
ReferralName	the name of the referral.	string	None.
Items	the items.	Collection of AddInvoiceItemRequest	None.
PublicNote		string	None.
ShippingType		ShippingType	None.
ShippingCost		decimal number	None.
ExpectedShipDate		date	None.
Fulfilled		boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "ShipFromAddressId": "",
  "ShipToContactId": "",
  "BillToContactId": "",
  "ExternalOrderNumber": "",
  "InvoiceDate": "2024-11-27T18:18",
  "Currency": "",
  "ClientCSR": "",
  "ClientCSRId": "",
  "SubscriberCSRId": "",
  "ReferralTypeId": "",
  "ReferralName": "",
  "Items": [
    {
      "ServiceFee": 1.0,
      "Discount": 2.0,
      "TaxName": "",
      "Tax": 4.0,
      "AdditionalTaxName": "",
      "AdditionalTax": 6.0,
      "TicketGroupId": "",
      "Quantity": 8,
      "LowSeat": 9,
      "HighSeat": 10,
      "Seats": [
        1
      ],
      "UnitPrice": 11.0,
      "TicketNumber": 12,
      "Commission": 13.0,
      "IsItemPredelivered": true,
      "EventName": "",
      "EventId": "",
      "Venue": "",
      "VenueId": "",
      "EventDate": "2024-11-27T18:18",
      "Section": "",
      "Row": ""
    }
  ],
  "PublicNote": "",
  "ShippingType": "None",
  "ShippingCost": 13.0,
  "ExpectedShipDate": "2024-11-27T18:18",
  "Fulfilled": true
}

Response Information

Resource Description

Invoice

Name	Description	Type	Additional information
InvoiceId	The invoice identifier.	string	None.
InvoiceNumber	The invoice number.	integer	None.
Zone	Zone	Zone	None.
CustomerId	Customer Id	string	None.
ShipToContact		string	None.
ShipTo	Ship To Contact	Contact	None.
BillTo	Bill To Contact	Contact	None.
ShipFrom	Ship From Address	SubscriberAddress	None.
InvoiceStatus	The invoice status.	InvoiceStatus	None.
ShippingStatus	The shipping status.	ShippingStatus	None.
PaymentStatus	The payment status.	PaymentStatus	None.
ExternalOrderNumber	The external order number.	string	None.
InvoiceItems	The invoice items.	Collection of InvoiceItem	None.
CustomItems		Collection of InvoiceCustomItem	None.
ShippingType	The type ofThe shipping.	ShippingType	None.
ShippingService	The shipping service.	string	None.
ShippingTrackingNumber	The shipping tracking number.	string	None.
ShippingCost	The shipping cost.	Money	None.
Tax	The tax.	Money	None.
AdditionalTax	The AdditionalTax.	Money	None.
ServiceFee	The overs.	Money	None.
Discount	The discount.	Money	None.
Commission	The commission.	Money	None.
SubTotal	The sub total.	Money	None.
GrandTotal	The grand total.	Money	None.
BalanceAmount	The balance amount.	Money	None.
Notes	The notes.	string	None.
PrivateNotes	Invoice private notes.	Collection of PrivateNote	None.
VoidReason	The void reason.	string	None.
DateVoided	The date voided	date	None.
Tags		Collection of string	None.
ReferralTypeId		string	None.
ReferralType		string	None.
ReferralName		string	None.
ClientCompany		string	None.
ClientCSRId		string	None.
SubscriberCSRId		string	None.
ClientCSR		string	None.
SubscriberCSR		string	None.
InvoiceDate		date	None.
DateShipped		date	None.

Response Formats

application/json, text/json

Sample:

{
  "InvoiceId": "",
  "InvoiceNumber": 2,
  "Zone": "Any",
  "CustomerId": "",
  "ShipToContact": "",
  "ShipTo": {
    "AddressId": "",
    "FirstName": "",
    "LastName": "",
    "Company": "",
    "Address1": "",
    "Address2": "",
    "City": "",
    "StateId": "",
    "StateOther": "",
    "StateISO": "",
    "CountryId": "",
    "Country": "",
    "CountryCode": "",
    "TimeZoneId": "",
    "Zip": "",
    "Email": "",
    "Website": "",
    "JobTitle": "",
    "ContactId": "",
    "CustomerId": "",
    "AddressSource": "Manual",
    "ContactType": "Subscriber",
    "ContactSubType": "Contact",
    "IsPayPalVerified": true,
    "AddressNote": "",
    "ReferenceId": "",
    "State": "",
    "DateUpdated": "2024-11-27T18:18",
    "Phones": [
      {
        "PhoneId": "",
        "ContactId": "",
        "PhoneType": "Home",
        "Phone": "",
        "Extension": "",
        "IsPrimary": true,
        "IsDeleted": true
      }
    ]
  },
  "BillTo": {
    "AddressId": "",
    "FirstName": "",
    "LastName": "",
    "Company": "",
    "Address1": "",
    "Address2": "",
    "City": "",
    "StateId": "",
    "StateOther": "",
    "StateISO": "",
    "CountryId": "",
    "Country": "",
    "CountryCode": "",
    "TimeZoneId": "",
    "Zip": "",
    "Email": "",
    "Website": "",
    "JobTitle": "",
    "ContactId": "",
    "CustomerId": "",
    "AddressSource": "Manual",
    "ContactType": "Subscriber",
    "ContactSubType": "Contact",
    "IsPayPalVerified": true,
    "AddressNote": "",
    "ReferenceId": "",
    "State": "",
    "DateUpdated": "2024-11-27T18:18",
    "Phones": [
      {
        "PhoneId": "",
        "ContactId": "",
        "PhoneType": "Home",
        "Phone": "",
        "Extension": "",
        "IsPrimary": true,
        "IsDeleted": true
      }
    ]
  },
  "ShipFrom": {
    "AddressId": "",
    "FirstName": "",
    "LastName": "",
    "Company": "",
    "Address1": "",
    "Address2": "",
    "City": "",
    "StateId": "",
    "StateOther": "",
    "State": "",
    "StateISO": "",
    "CountryId": "",
    "TimeZoneId": "",
    "Zip": "",
    "Email": "",
    "Website": "",
    "JobTitle": "",
    "SubscriberId": "",
    "Phone": "",
    "Cell": "",
    "Fax": "",
    "DisplayName": "",
    "AddressType": "Billing",
    "IsResidential": true,
    "Country": "",
    "Extension": "",
    "CountryCode": "",
    "TimeZone": ""
  },
  "InvoiceStatus": "Any",
  "ShippingStatus": "Any",
  "PaymentStatus": "Any",
  "ExternalOrderNumber": "",
  "InvoiceItems": [
    {
      "InvoiceItemId": "",
      "Event": "",
      "Venue": "",
      "EventDate": "2024-11-27T18:18",
      "Section": "",
      "Row": "",
      "LowSeat": 7,
      "HighSeat": 8,
      "Seats": "",
      "Quantity": 10,
      "UnitPrice": {
        "Currency": "",
        "Amount": 1.0
      },
      "AllocationStatus": "None",
      "TicketGroupId": "",
      "Location": ""
    }
  ],
  "CustomItems": [
    {
      "InvoiceCustomItemId": "",
      "Description": "",
      "Total": {
        "Currency": "",
        "Amount": 1.0
      }
    }
  ],
  "ShippingType": "None",
  "ShippingService": "",
  "ShippingTrackingNumber": "",
  "ShippingCost": {
    "Currency": "",
    "Amount": 1.0
  },
  "Tax": {
    "Currency": "",
    "Amount": 1.0
  },
  "AdditionalTax": {
    "Currency": "",
    "Amount": 1.0
  },
  "ServiceFee": {
    "Currency": "",
    "Amount": 1.0
  },
  "Discount": {
    "Currency": "",
    "Amount": 1.0
  },
  "Commission": {
    "Currency": "",
    "Amount": 1.0
  },
  "SubTotal": {
    "Currency": "",
    "Amount": 1.0
  },
  "GrandTotal": {
    "Currency": "",
    "Amount": 1.0
  },
  "BalanceAmount": {
    "Currency": "",
    "Amount": 1.0
  },
  "Notes": "",
  "PrivateNotes": [
    {
      "NoteId": "",
      "IsSystemNote": true,
      "Note": ""
    }
  ],
  "VoidReason": "",
  "DateVoided": "2024-11-27T18:18",
  "Tags": [
    ""
  ],
  "ReferralTypeId": "",
  "ReferralType": "",
  "ReferralName": "",
  "ClientCompany": "",
  "ClientCSRId": "",
  "SubscriberCSRId": "",
  "ClientCSR": "",
  "SubscriberCSR": "",
  "InvoiceDate": "2024-11-27T18:18",
  "DateShipped": "2024-11-27T18:18"
}