Invoice API XML
Show the invoice create schema Invoice create schema
<?xml version="1.0" encoding="utf-8" ?>
<Request Object="Invoice" Method="Create" xmlns="urn:InvoiceClarity-com:InvoiceCreate" >
<Invoice>
<InvoiceNumber>11</InvoiceNumber> <!-- Optional will select the next unique number either 1234 or abs123, will be checked if unique -->
<InvoiceStatus>Draft</InvoiceStatus> <!-- Invoice status valid values Sent,Viewed,Paid,Draft,Late_Payement -->
<Date>2008-02-20</Date> <!-- Invoice date -->
<PurchaseOrder>2314fgds</PurchaseOrder> <!-- Optional purchase order -->
<Discount>18.4</Discount> <!-- Optional percentage value -->
<Send>true</Send> <!-- Optional send invoice to client default to false -->
<ClientId>91</ClientId> <!-- ClientId -->
<Notes>Notes </Notes> <!-- Optional notes in invoice -->
<Terms>Please pay in 30 days.</Terms> <!-- Optional Terms, if empty will be taken from settings -->
<Footer>Company details</Footer> <!-- Optional Footer could be company number of bank details, if empty will be taken from settings -->
<SendAsPdf>true</SendAsPdf> <!-- Optional send with pdf attachment default to false -->
<AllowPayPalOnlinePayment>true</AllowPayPalOnlinePayment> <!-- Optional allow client to pay using Paypal default to false -->
<InvoiceLines> <!-- Invoice line items -->
<InvoiceLine>
<ItemId></ItemId> <!-- Optional not filled in will create the line item -->
<Name>API And more</Name> <!-- Name of line item -->
<Description>It was even harder</Description> <!-- Description of line item -->
<UnitCost>10.5</UnitCost> <!-- line item cost -->
<Quantity>3</Quantity> <!-- line item quantity -->
<CompanyTax1>Vat ( @ 15.0 % )</CompanyTax1> <!-- Optional tax1 name -->
<CompanyTax2></CompanyTax2> <!-- Optional tax2 name -->
</InvoiceLine>
<InvoiceLine>
<ItemId>94</ItemId> <!-- Optional will load this line item from database -->
<Name>And more</Name>
<Description>It was even harder</Description>
<UnitCost>124.35</UnitCost>
<Quantity>2</Quantity>
<CompanyTax1></CompanyTax1>
<CompanyTax2>Vat ( @ 17.5 % )</CompanyTax2>
</InvoiceLine>
</InvoiceLines>
</Invoice>
</Request>
Invoice create response
<?xml version="1.0" encoding="utf-8"?>
<Response status="Ok" >
<InvoiceId>12356</InvoiceId>
<Errors>
<Error description="Error"></Error>
</Errors>
</Response>
Show the invoice update schema Invoice update schema
<?xml version="1.0" encoding="utf-8" ?>
<Request Object="Invoice" Method="Update" xmlns="urn:InvoiceClarity-com:InvoiceUpdate" >
<Invoice>
<InvoiceId>54</InvoiceId>
<InvoiceNumber></InvoiceNumber>
<InvoiceStatus>Viewed</InvoiceStatus>
<Date>2008-02-20</Date>
<PurchaseOrder>342421</PurchaseOrder>
<Discount>10.4</Discount>
<ClientId>14</ClientId>
<Notes>Notes go here</Notes>
<Terms>Please pay in 30 days.</Terms>
<Footer>Company details</Footer>
<SendAsPdf>True</SendAsPdf>
<AllowPayPalOnlinePayment>true</AllowPayPalOnlinePayment> <!-- Optional allow client to pay using Paypal default to false -->
<InvoiceLines>
<InvoiceLine>
<Name>Lots of work</Name>
<Description>It was hard</Description>
<UnitCost>543</UnitCost>
<CompanyTax1></CompanyTax1>
<CompanyTax2>Vat ( @ 15.0 % )</CompanyTax2>
</InvoiceLine>
<InvoiceLine>
<Name>And more changed</Name>
<Description>It was even harder changed</Description>
<UnitCost>14.35</UnitCost>
<CompanyTax1>Vat ( @ 17.5 % )</CompanyTax1>
<CompanyTax2></CompanyTax2>
</InvoiceLine>
</InvoiceLines>
</Invoice>
</Request>
Invoice update response
<?xml version="1.0" encoding="utf-8"?>
<Response status="Ok" >
<InvoiceId>12356</InvoiceId>
<Errors>
<Error description="Errors go here"></Error>
</Errors>
</Response>
Show the invoice delete schema Invoice delete schema
<?xml version="1.0" encoding="utf-8" ?>
<Request Object="Invoice" Method="Delete" xmlns="urn:InvoiceClarity-com:InvoiceDelete" >
<Invoice>
<InvoiceId>54</InvoiceId> <!-- InvoiceId -->
</Invoice>
</Request>
Invoice delete response
<?xml version="1.0" encoding="utf-8"?>
<Response status="Ok" >
<InvoiceId>12356</InvoiceId>
<Errors>
<Error description="Error"></Error>
</Errors>
</Response>
Show the invoice list schema Invoice list schema
<?xml version="1.0" encoding="utf-8" ?>
<Request Object="Invoice" Method="List" xmlns="urn:InvoiceClarity-com:InvoiceList" >
<Page>1</Page> <!-- Page number to display -->
<PerPage>3</PerPage> <!-- Number of invoices per page -->
<ShowArchived>true</ShowArchived> <!-- Show archived -->
<ShowDeleted>true</ShowDeleted> <!-- Invoice deleted -->
<InvoiceStatus></InvoiceStatus> <!-- Optional -->
<ClientId></ClientId> <!-- Optional -->
<DateFrom>2008-05-07</DateFrom> <!-- Optional date start -->
<DateTo>2008-05-07</DateTo> <!-- Optional date end -->
</Request>
Invoice list response
<?xml version="1.0" encoding="utf-8"?>
<Response status="Ok" >
<Invoices page="1" total="5" >
<Invoice>
<InvoiceId>54</InvoiceId>
<InvoiceNumber>3321</InvoiceNumber>
<InvoiceStatus>Viewed</InvoiceStatus>
<Date>2008-02-20</Date>
<PurchaseOrder>342421</PurchaseOrder>
<Discount>10.4</Discount>
<ClientId>14</ClientId>
<Title>Mr</Title>
<FirstName>Mike</FirstName>
<Surname>Smith</Surname>
<CompanyName>Mikes cleaners</CompanyName>
<Address1>56 main street</Address1>
<Address2>London</Address2>
<Address3>Chelsea</Address3>
<Address4>Se6 3rr</Address4>
<Address5></Address5>
<Country>USA</Country>
<Currency>USD</Currency>
<Archived>false</Archived>
<Deleted>false</Deleted>
<Terms>Please pay in 30 days.</Terms>
<Notes>Notes go here</Notes>
<Footer>Company details</Footer>
<SendAsPdf>True</SendAsPdf>
<InvoiceUrl>url here</InvoiceUrl>
<InvoiceAmount>99</InvoiceAmount>
<PaidAmount>43</PaidAmount>
<InvoiceLines>
<InvoiceLine>
<Name>Lots of work</Name>
<Description>It was hard</Description>
<UnitCost>543</UnitCost>
<Quantity>1</Quantity>
<CompanyTax1>Tax1</CompanyTax1>
<CompanyTax2></CompanyTax2>
</InvoiceLine>
<InvoiceLine>
<Name>And more changed</Name>
<Description>It was even harder changed</Description>
<UnitCost>14.35</UnitCost>
<Quantity>1</Quantity>
<CompanyTax1></CompanyTax1>
<CompanyTax2>Tax2</CompanyTax2>
</InvoiceLine>
</InvoiceLines>
</Invoice>
</Invoices>
<Errors>
<Error description="Errors go here"></Error>
</Errors>
</Response>
Show the invoice item schema Invoice item schema
<?xml version="1.0" encoding="utf-8" ?>
<Request Object="Invoice" Method="Item" xmlns="urn:InvoiceClarity-com:InvoiceItem" >
<InvoiceId>91</InvoiceId> <!-- InvoiceId -->
</Request>
Invoice item response
<?xml version="1.0" encoding="utf-8"?>
<Response status="Ok" >
<Invoice>
<InvoiceId>54</InvoiceId>
<InvoiceNumber>3321</InvoiceNumber>
<InvoiceStatus>Viewed</InvoiceStatus>
<Date>2008-02-20</Date>
<PurchaseOrder>342421</PurchaseOrder>
<Discount>10.4</Discount>
<ClientId>14</ClientId>
<Title>Mr</Title>
<FirstName>Mike</FirstName>
<Surname>Smith</Surname>
<CompanyName>Mikes cleaners</CompanyName>
<Address1>56 main street</Address1>
<Address2>London</Address2>
<Address3>Chelsea</Address3>
<Address4>Se6 3rr</Address4>
<Address5></Address5>
<Country>USA</Country>
<Currency>USD</Currency>
<Archived>false</Archived>
<Deleted>false</Deleted>
<Terms>Please pay in 30 days.</Terms>
<Notes>Notes go here</Notes>
<Footer>Company details</Footer>
<SendAsPdf>True</SendAsPdf>
<AllowPayPalOnlinePayment>True</AllowPayPalOnlinePayment>
<InvoiceUrl>True</InvoiceUrl>
<InvoiceLines>
<InvoiceLine>
<Name>Lots of work</Name>
<Description>It was hard</Description>
<UnitCost>543</UnitCost>
<Quantity>1</Quantity>
<CompanyTax1>Tax1</CompanyTax1>
<CompanyTax2></CompanyTax2>
</InvoiceLine>
<InvoiceLine>
<Name>And more changed</Name>
<Description>It was even harder changed</Description>
<UnitCost>14.35</UnitCost>
<Quantity>1</Quantity>
<CompanyTax1></CompanyTax1>
<CompanyTax2>Tax2</CompanyTax2>
</InvoiceLine>
</InvoiceLines>
</Invoice>
<Errors>
<Error description="Error"></Error>
</Errors>
</Response>