Create an invoice.

POST {{baseUrl}}/v4/invoices

Creates an invoice.

Card Present Invoice

A card-present-invoice used to process an invoice through a card reader. After the invoice is created, there is a callback to the card reader to complete the transaction. If no accountUid is given, the card reader's default account is used.

Card Not Present Invoice

A card-not-present-invoice is used to process an invoice asynchronously. After the invoice is created, a payment link is sent to the customer from the merchants Podium account. The customer can click on the link to complete the transaction. If no accountUid is given, the most recently created account is used.

Request Body

{"channelIdentifier"=>"email@email.com", "customerName"=>"Barry Grape", "lineItems"=>[{"amount"=>4186, "description"=>"Oil change."}], "locationUid"=>"00000000-0000-0000-0000-000000000000", "accountUid"=>"00000000-0000-0000-0000-000000000000", "invoiceNumber"=>"abc-12345-def", "readerUid"=>"00000000-0000-0000-0000-000000000000"}

HEADERS

RESPONSES

status: OK

{"data":{"canceledAt":"2015-01-23T23:50:07Z","canceledNote":"The wrong amount was entered.","channel":{"identifier":"email@email.com","type":"email"},"conversationUid":"00000000-0000-0000-0000-000000000000","createdAt":"2015-01-23T23:50:07Z","currencyRef":"USD","customerName":"Joe Orange","invoiceNumber":"abc-12345-def","lineItems":[{"amount":1099,"description":"Total"},{"amount":1099,"description":"Total"}],"location":{"uid":"00000000-0000-0000-0000-000000000000"},"paidAt":"2015-01-23T23:50:07Z","paymentNet":1000,"payments":[{"bankAccountLast4":"1245","bankAccountName":"The Bank","cardBrand":"visa","cardLast4":"4242","createdAt":"2015-01-23T23:50:07Z","fee":99,"interchangeFee":50,"refunds":[{"amount":100,"createdAt":"2015-01-23T23:50:07Z","notes":["The product did not function properly.","The product did not function properly."],"reason":"requested_by_customer","settledAt":"2015-01-23T23:50:07Z","status":"failed_lost_or_stolen"},{"amount":100,"createdAt":"2015-01-23T23:50:07Z","notes":["The product did not function properly.","The product did not function properly."],"reason":"duplicate","settledAt":"2015-01-23T23:50:07Z","status":"failed_charge_for_pending_refund_disputed"}],"settledAt":"2015-01-23T23:50:07Z","status":"refund_pending","uid":"00000000-0000-0000-0000-000000000000"},{"bankAccountLast4":"1245","bankAccountName":"The Bank","cardBrand":"visa","cardLast4":"4242","createdAt":"2015-01-23T23:50:07Z","fee":99,"interchangeFee":50,"refunds":[{"amount":100,"createdAt":"2015-01-23T23:50:07Z","notes":["The product did not function properly.","The product did not function properly."],"reason":"duplicate","settledAt":"2015-01-23T23:50:07Z","status":"succeeded"},{"amount":100,"createdAt":"2015-01-23T23:50:07Z","notes":["The product did not function properly.","The product did not function properly."],"reason":"requested_by_customer","settledAt":"2015-01-23T23:50:07Z","status":"failed_lost_or_stolen"}],"settledAt":"2015-01-23T23:50:07Z","status":"refund_failed","uid":"00000000-0000-0000-0000-000000000000"}],"readerUid":"00000000-0000-0000-0000-000000000000","requester":"John Apple","status":"refund_pending","uid":"00000000-0000-0000-0000-000000000000"},"metadata":{"url":"https://www.podium.com/"}}