Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

Request

Code Block
controlstrue
themeDefault
languagejavascript
themeDefault
linenumberstrue
{
/* — search criteria (optional) — */
"companyNumber":"",          // Numeric
"companyName":"",
"invoiceNumberFrom":"",      // Numeric 
"invoiceNumberTo":"",        // Numeric
"invoiceSerialID":"",        // id value from invoiceSerials.list
"reference":"",
"sentDateFrom":"",           // <-- Date format DD/MM/AAAA
"sentDateTo":"",             // <-- Date format DD/MM/AAAA
"creationDateFrom":"",       // <-- Date format DD/MM/AAAA
"creationDateTo":"",         // <-- Date format DD/MM/AAAA
"currentStatusID":"",        // id value from customerInvoicesStates.list
"invoicePaid":"",            // Boolean
"totalAmountFrom":"",        // Numeric
"totalAmountTo":"",          // Numeric
"remarks":"",
"paymentTypeID":"",          // id value from paymentType.list
"invoiceTypeID":"",          // id value from invoiceTypes.list
"correcting":"",             // Boolean
"correctedInvoice":"",       // Boolean
"correctionReason":"",
"agentId":"",                // id value from salesAgent.list  
"projectId":""               // id value from projects.list
}

Response

Code Block
controlstrue
themeDefault
languagejavascript
themeDefault
linenumberstrue
{
    "data":     {
        "result":         [
                        {
                "version": 2,
                "correctedBy": "",
                "bankAccountNumber": "4515 4516 1010 11 1223541741",
                "numberWithTypeInfo": "[] 4515 4516 1010 11 1223541741",
                "editable": true,
                "statusColor": "#FFFF00",
                "statusDescription": "Abierta",
                "creationDate": "31/01/2011 13:47:29",
                "sentDate": "31/01/2011 00:00:00",
                "amountWithoutTax": 139.77,
                "totalAmount": 143.96,
                "number": 7,
                "correctedInvoice": "false",
                "paymentTypeName": "Cheque",
                "id": "1984",
                "documentID": 1984,
                "currentStatusID": 30,
                "paymentTypeID": 1260000001014,
                "taxIdDefault": 0,
                "companyID": 11521,
                "invoiceSerialID": 1260000000501,
                "documentTypeID": 4,
                "invoiceTypeID": 1260000000317,
                "dueTypeID": 1260000001008,
                "taxDescriptionDefault": "",
                "taxValueDefault": 0,
                "withhold": false,
                "productLines": [],
                "serviceLines": [],
                "canImport": true,
                "correcting": "false",
                "forceUpdateStock": false,
                "invoiceSerialShort": "A",
                "invoiceSerialDescription": "Serie A",
                "status": "open",
                "dueTypeName": "A 90 días",
                "totalLines": [],
                "userID": 362,
                "userName": "Luis Medina Robles"
            },
                        {
				....
            },
                        {
                "version": 0,
                "correctedBy": "",
                "editable": true,
                "statusColor": "#FFFF00",
                "statusDescription": "Abierta",
                "creationDate": "14/01/2011 13:22:47",
                "sentDate": "14/01/2011 00:00:00",
                "amountWithoutTax": 684.28,
                "totalAmount": 807.45,
                "number": 1,
                "correctedInvoice": "false",
                "paymentTypeName": "Domiciliación",
                "id": "1930",
                "documentID": 1930,
                "currentStatusID": 30,
                "paymentTypeID": 900,
                "taxIdDefault": 0,
                "companyID": 11518,
                "invoiceSerialID": 1260000000501,
                "documentTypeID": 4,
                "invoiceTypeID": 1260000000317,
                "dueTypeID": 1260000001007,
                "taxDescriptionDefault": "",
                "taxValueDefault": 0,
                "withhold": false,
                "productLines": [],
                "serviceLines": [],
                "canImport": true,
                "correcting": "false",
                "forceUpdateStock": false,
                "invoiceSerialShort": "A",
                "invoiceSerialDescription": "Serie A",
                "status": "open",
                "dueTypeName": "A 60 días",
                "totalLines": [],
                "userID": 362,
                "userName": "Luis Medina Robles"
            }
        ],
        "total": 10
    },
    "success": true
}

...

Request

Code Block
controlstrue
themeDefault
languagejavascript
themeDefault
linenumberstrue
{"id": "1984"}

Response

Code Block
controlstrue
themeDefault
languagejavascript
themeDefault
linenumberstrue
{
    "data":     {
        "featureDescription": "La factura no ha sido cobrada",
        "correctedBy": "",
        "printColor": "#222FFE",
        "postalCode": "80531",
        "bankAccountNumber": "4515 4516 1010 11 1223541741",
        "numberWithTypeInfo": "[De Cliente] 4515 4516 1010 11 1223541741",
        "defaultWithhold": 15,
        "salesDiscount": 1,
        "salesDiscountAmount": 1.4406,
        "earlyPaymentDiscount": 2,
        "earlyPaymentDiscountAmount": 2.852388,
        "editable": true,
        "statusDescription": "Abierta",
        "creationDate": "31/01/2011 13:47:29",
        "sentDate": "31/01/2011 00:00:00",
        "number": 7,
        "paymentTypeName": "Cheque",
        "statesHistory": [        {
            "version": 0,
            "description": "Abierta",
            "date": "31/01/2011 13:47:29",
            "changeUser": "Luis Medina Robles"
        }],
        "id": "1984",
        "bankAccountID": 245,
        "documentID": 1984,
        "currentStatusID": 30,
        "paymentTypeID": 1260000001014,
        "taxIdDefault": 1260000001300,
        "companyID": 11521,
        "invoiceSerialID": 1260000000501,
        "documentTypeID": 4,
        "invoiceTypeID": 1260000000317,
        "dueTypeID": 1260000001008,
        "importDeliverySlips": true,
        "taxDescriptionDefault": "IVA General",
        "taxValueDefault": 18,
        "withhold": true,
        "withholdAmount": 15,
        "productLines": [        {
            "itemReference": "HERMES-B008",
            "version": 0,
            "sourceLine": "23",
            "description": "Caudal 22 l/min aprox. Inversor. Excéntricas 150 ± 16mm.",
            "id": "5143",
            "itemID": 1243,
            "taxID": 1260000001300,
            "lineID": 5143,
            "unitAmount": 72.03,
            "amount": 144.06,
            "taxDescription": "IVA General",
            "taxValue": 18,
            "units": 2
        }],
        "serviceLines": [],
        "pdfTemplate": "General",
        "canImport": true,
        "correcting": "false",
        "invoiceSerialShort": "A",
        "invoiceSerialDescription": "Serie A",
        "status": "open",
        "statusInfo":         [
                        {
                "statusDescription": "Abierta",
                "statusName": "open",
                "transitable": true
            },
                        {
                "statusDescription": "Emitida",
                "statusName": "issued",
                "transitable": true
            },
                        {
                "statusDescription": "Contabilizada",
                "statusName": "accounted",
                "transitable": false
            }
        ],
        "subtotal": 139.767012,
        "subtotalWithoutDiscounts": 144.06,
        "dueTypeName": "A 90 días",
        "generalTotal": 143.96,
        "taxesTotal": 25.1586,
        "taxesSurchargeTotal": 30.7494,
        "withholdTotal": 20.965052,
        "totalLines": [        {
            "id": "5143",
            "totalAmountDiscountsIncluded": 139.77,
            "taxDescription": "IVA General (18%)",
            "surcharge": 4,
            "selected": [],
            "taxAmount": 25.1586,
            "taxSurchargeAmount": 30.7494,
            "surchargeAmount": 5.5908
        }],
        "userID": 362,
        "userName": "Luis Medina Robles",
        "dueDates": [        {
            "receiptStatusDescription": "",
            "chargePaymentDate": "12/06/2011 00:00:00",
            "dueDate": "31/05/2011 00:00:00",
            "documentID": 1984,
            "receiptAmount": 143.96,
            "chargedPaidReceiptAmount": 0,
            "pendingReceiptAmount": 143.96,
            "companyName": "",
            "customerReceipt": false
        }]
    },
    "success": true
}

...

Request

Code Block
controlstrue
themeDefault
languagejavascript
themeDefault
linenumberstrue
{
"invoiceSerialID":"1260000000501",     // id value from invoiceSerials.list
"number": "",                          // If empty, a new one autonumeric is assigned
"sentDate":"04/04/2011",
"correcting":"false",
"companyID":"11518",                   // id value from customers.list
"paymentTypeID":"900",                 // id value from paymentType.list
"dueTypeID":"1040",                    // id value from dueDateTypes.list
"bankAccountID":"241",                 // id value from bankAccounts.list
"correctionReason":"",
"invoiceTypeID":"1260000000317",       // id value from invoiceTypes.list
"carrierID":"5",                       // id value from carriers.list
"freights":"1",
"remarks":"",
"headerRemarks":"",
"footerRemarks":"Factura en www.kubbos.com",
"withhold": "true",
"withholdAmount":"15",
"salesDiscount":"",
"earlyPaymentDiscount":"5",
"productLines":
	[
		{
		"itemID":1229,          // id value from items.list
		"units":1,
		"unitAmount":72.03,
		"discount":"",
		"taxID":1260000001300,  // id value from taxes.list
		"remarks":""
		}
	],
"serviceLines":
	[
		{
		"date":"",
		"description":"Envío urgente",
		"units":1,
		"unitAmount":"35.00",
		"discount":"",
		"taxID":"1260000001300",   // id value from taxes.list
		"remarks":""
		}
	]
}

Response

Code Block
controlstrue
themeDefault
languagejavascript
themeDefault
linenumberstrue
{
    "data":     {
        "errors": [],
        "messages":         [
                        {
                "description": "Operación realizada correctamente",
                "id": "common_operation_finished"
            }
        ],
        "warns": []
    },
    "id": "2038",
    "success": true
}

...

Request

Code Block
controlstrue
themeDefault
languagejavascript
themeDefault
linenumberstrue
{
"sentDate":"11/04/2011",
"companyID":"11518",                       // id value from customers.list
"paymentTypeID":"900",                     // id value from paymentType.list
"dueTypeID":"1040",                        // id value from dueDateTypes.list
"bankAccountID":"251",                     // id value from bankAccounts.list
"invoiceTypeID":"1260000000317",           // id value from invoiceTypes.list
"carrierID":"5",                           // id value from carriers.list
"freights":"1",
"remarks":"",
"headerRemarks":"",
"footerRemarks":"Factura en www.kubbos.com",
"withhold":"true",
"withholdAmount":"15",
"salesDiscount":"",
"earlyPaymentDiscount":"5",
"id":"2038",
"version": 0,
"productLines":
	[
		{
		"lineID":5198,
		"itemID":1229,              // id value from items.list
		"units":1,
		"unitAmount":72.03,
		"discount":8,
		"taxID":1260000001300,      // id value from taxes.list
		"remarks":""
		}
	],
"serviceLines":
	[
		{
		"lineID":5199,
		"description":"Envío Urgente",
		"units":1,
		"unitAmount":23,
		"discount":"",
		"taxID":1260000001300,      // id value from taxes.list
		"date":"",
		"remarks":""
		}
	]
}

Response

Code Block
controlstrue
themeDefault
languagejavascript
themeDefault
linenumberstrue
{
    "data":     {
        "errors": [],
        "messages":         [
                        {
                "description": "Operación realizada correctamente",
                "id": "operation_success"
            }
        ],
        "warns": []
    },
    "id": "2038",
    "success": true
}

...

Request

Code Block
controlstrue
themeDefault
languagejavascript
themeDefault
linenumberstrue
{
"id":"2038",
"version": 0
}

Response

Code Block
controlstrue
themeDefault
languagejavascript
themeDefault
linenumberstrue
{
    "data":     {
        "errors": [],
        "messages": [        {
            "description": "Operación realizada correctamente",
            "id": "operation_success"
        }],
        "warns": []
    },
    "id": "2038",
    "success": true
}